class YNAB::Account

Attributes

balance[RW]

The current balance of the account in milliunits format

cleared_balance[RW]

The current cleared balance of the account in milliunits format

closed[RW]

Whether this account is closed or not

deleted[RW]

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

direct_import_in_error[RW]

If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.

direct_import_linked[RW]

Whether or not the account is linked to a financial institution for automatic transaction import.

id[RW]
name[RW]
note[RW]
on_budget[RW]

Whether this account is on budget or not

transfer_payee_id[RW]

The payee id which should be used when transferring to this account

type[RW]

The type of account. Note: payPal, merchantAccount, investmentAccount, and mortgage types have been deprecated and will be removed in the future.

uncleared_balance[RW]

The current uncleared balance of the account in milliunits format

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ynab/models/account.rb, line 76
def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'on_budget' => :'on_budget',
    :'closed' => :'closed',
    :'note' => :'note',
    :'balance' => :'balance',
    :'cleared_balance' => :'cleared_balance',
    :'uncleared_balance' => :'uncleared_balance',
    :'transfer_payee_id' => :'transfer_payee_id',
    :'direct_import_linked' => :'direct_import_linked',
    :'direct_import_in_error' => :'direct_import_in_error',
    :'deleted' => :'deleted'
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ynab/models/account.rb, line 95
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'type' => :'String',
    :'on_budget' => :'BOOLEAN',
    :'closed' => :'BOOLEAN',
    :'note' => :'String',
    :'balance' => :'Integer',
    :'cleared_balance' => :'Integer',
    :'uncleared_balance' => :'Integer',
    :'transfer_payee_id' => :'String',
    :'direct_import_linked' => :'BOOLEAN',
    :'direct_import_in_error' => :'BOOLEAN',
    :'deleted' => :'BOOLEAN'
  }
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/account.rb, line 247
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      on_budget == o.on_budget &&
      closed == o.closed &&
      note == o.note &&
      balance == o.balance &&
      cleared_balance == o.cleared_balance &&
      uncleared_balance == o.uncleared_balance &&
      transfer_payee_id == o.transfer_payee_id &&
      direct_import_linked == o.direct_import_linked &&
      direct_import_in_error == o.direct_import_in_error &&
      deleted == o.deleted
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/account.rb, line 300
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/account.rb, line 366
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/account.rb, line 279
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/account.rb, line 267
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/account.rb, line 273
def hash
  [id, name, type, on_budget, closed, note, balance, cleared_balance, uncleared_balance, transfer_payee_id, direct_import_linked, direct_import_in_error, deleted].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/account.rb, line 176
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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

  if @deleted.nil?
    invalid_properties.push('invalid value for "deleted", deleted 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/account.rb, line 346
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/account.rb, line 352
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/account.rb, line 340
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

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

# File lib/ynab/models/account.rb, line 241
def type=(type)
  @type = type
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/account.rb, line 223
def valid?
  return false if @id.nil?
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ['checking', 'savings', 'cash', 'creditCard', 'lineOfCredit', 'otherAsset', 'otherLiability', 'payPal', 'merchantAccount', 'investmentAccount', 'mortgage'])
  return false unless type_validator.valid?(@type)
  return false if @on_budget.nil?
  return false if @closed.nil?
  return false if @balance.nil?
  return false if @cleared_balance.nil?
  return false if @uncleared_balance.nil?
  return false if @transfer_payee_id.nil?
  return false if @deleted.nil?
  true
end