class YNAB::MonthDetail

Attributes

activity[RW]

The total amount of transactions in the month, excluding those categorized to 'Inflow: To be Budgeted'

age_of_money[RW]

The Age of Money as of the month

budgeted[RW]

The total amount budgeted in the month

categories[RW]

The budget month categories. Amounts (budgeted, activity, balance, etc.) are specific to the {month} parameter specified.

deleted[RW]

Whether or not the month has been deleted. Deleted months will only be included in delta requests.

income[RW]

The total amount of transactions categorized to 'Inflow: To be Budgeted' in the month

month[RW]
note[RW]
to_be_budgeted[RW]

The available amount for 'To be Budgeted'

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/ynab/models/month_detail.rb, line 43
def self.attribute_map
  {
    :'month' => :'month',
    :'note' => :'note',
    :'income' => :'income',
    :'budgeted' => :'budgeted',
    :'activity' => :'activity',
    :'to_be_budgeted' => :'to_be_budgeted',
    :'age_of_money' => :'age_of_money',
    :'deleted' => :'deleted',
    :'categories' => :'categories'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ynab/models/month_detail.rb, line 74
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?(:'month')
    self.month = attributes[:'month']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'categories')
    if (value = attributes[:'categories']).is_a?(Array)
      self.categories = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ynab/models/month_detail.rb, line 58
def self.swagger_types
  {
    :'month' => :'Date',
    :'note' => :'String',
    :'income' => :'Integer',
    :'budgeted' => :'Integer',
    :'activity' => :'Integer',
    :'to_be_budgeted' => :'Integer',
    :'age_of_money' => :'Integer',
    :'deleted' => :'BOOLEAN',
    :'categories' => :'Array<Category>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ynab/models/month_detail.rb, line 169
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      month == o.month &&
      note == o.note &&
      income == o.income &&
      budgeted == o.budgeted &&
      activity == o.activity &&
      to_be_budgeted == o.to_be_budgeted &&
      age_of_money == o.age_of_money &&
      deleted == o.deleted &&
      categories == o.categories
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/ynab/models/month_detail.rb, line 218
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = YNAB.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/ynab/models/month_detail.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/ynab/models/month_detail.rb, line 197
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
eql?(o) click to toggle source

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

# File lib/ynab/models/month_detail.rb, line 185
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ynab/models/month_detail.rb, line 191
def hash
  [month, note, income, budgeted, activity, to_be_budgeted, age_of_money, deleted, categories].hash
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/ynab/models/month_detail.rb, line 121
def list_invalid_properties
  invalid_properties = Array.new
  if @month.nil?
    invalid_properties.push('invalid value for "month", month cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
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/ynab/models/month_detail.rb, line 264
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/ynab/models/month_detail.rb, line 270
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/ynab/models/month_detail.rb, line 258
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/ynab/models/month_detail.rb, line 156
def valid?
  return false if @month.nil?
  return false if @income.nil?
  return false if @budgeted.nil?
  return false if @activity.nil?
  return false if @to_be_budgeted.nil?
  return false if @deleted.nil?
  return false if @categories.nil?
  true
end