class BudgeaClient::Account

Attributes

balance[RW]

Balance of the account

bic[RW]

Account BIC/SWIFT

bookmarked[RW]

This account has been bookmarked by user

coming[RW]

Amount of coming operations not yet debited

company_name[RW]

Name of the company holding the employee savings of the account

currency[RW]

Account currency

deleted[RW]

This account is not found on the website anymore

disabled[RW]

This account has been deleted by user and will not be synchronized anymore

display[RW]

Display this account in accounts list

error[RW]

If the last update has failed, the error code

iban[RW]

Account IBAN

id[RW]

ID of the account

id_connection[RW]

ID of the related connection

id_parent[RW]

Id of the parent account

id_source[RW]

ID of the related connection source

id_type[RW]

ID of the account type

id_user[RW]

ID of the related user

last_update[RW]

Last successful update of the account

name[RW]

Name of the account

number[RW]

Account number

original_name[RW]

Original name of the account on the bank

ownership[RW]

Relationship between the credentials owner and the account

recipients[RW]
transactions[RW]
transfers[RW]
usage[RW]

Account usage

webid[RW]

Account webid

Public Class Methods

attribute_map() click to toggle source

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

# File lib/budgea_client/models/account.rb, line 96
def self.attribute_map
  {
    :'id' => :'id',
    :'id_connection' => :'id_connection',
    :'id_user' => :'id_user',
    :'id_source' => :'id_source',
    :'id_parent' => :'id_parent',
    :'number' => :'number',
    :'webid' => :'webid',
    :'original_name' => :'original_name',
    :'balance' => :'balance',
    :'coming' => :'coming',
    :'display' => :'display',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted',
    :'disabled' => :'disabled',
    :'iban' => :'iban',
    :'bic' => :'bic',
    :'currency' => :'currency',
    :'id_type' => :'id_type',
    :'bookmarked' => :'bookmarked',
    :'name' => :'name',
    :'recipients' => :'recipients',
    :'transactions' => :'transactions',
    :'transfers' => :'transfers',
    :'error' => :'error',
    :'usage' => :'usage',
    :'ownership' => :'ownership',
    :'company_name' => :'company_name'
  }
end
new(attributes = {}) click to toggle source

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'coming')
    self.coming = attributes[:'coming']
  else
    self.coming = 0.0
  end

  if attributes.has_key?(:'display')
    self.display = attributes[:'display']
  else
    self.display = true
  end

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'recipients')
    if (value = attributes[:'recipients']).is_a?(Array)
      self.recipients = value
    end
  end

  if attributes.has_key?(:'transactions')
    if (value = attributes[:'transactions']).is_a?(Array)
      self.transactions = value
    end
  end

  if attributes.has_key?(:'transfers')
    if (value = attributes[:'transfers']).is_a?(Array)
      self.transfers = value
    end
  end

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

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

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

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

Attribute type mapping.

# File lib/budgea_client/models/account.rb, line 129
def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_connection' => :'Integer',
    :'id_user' => :'Integer',
    :'id_source' => :'Integer',
    :'id_parent' => :'Integer',
    :'number' => :'String',
    :'webid' => :'String',
    :'original_name' => :'String',
    :'balance' => :'Float',
    :'coming' => :'Float',
    :'display' => :'BOOLEAN',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime',
    :'disabled' => :'DateTime',
    :'iban' => :'String',
    :'bic' => :'String',
    :'currency' => :'Currency',
    :'id_type' => :'Integer',
    :'bookmarked' => :'Integer',
    :'name' => :'String',
    :'recipients' => :'Array<Recipient>',
    :'transactions' => :'Array<Transaction>',
    :'transfers' => :'Array<Transfer>',
    :'error' => :'String',
    :'usage' => :'String',
    :'ownership' => :'String',
    :'company_name' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/budgea_client/models/account.rb, line 328
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_connection == o.id_connection &&
      id_user == o.id_user &&
      id_source == o.id_source &&
      id_parent == o.id_parent &&
      number == o.number &&
      webid == o.webid &&
      original_name == o.original_name &&
      balance == o.balance &&
      coming == o.coming &&
      display == o.display &&
      last_update == o.last_update &&
      deleted == o.deleted &&
      disabled == o.disabled &&
      iban == o.iban &&
      bic == o.bic &&
      currency == o.currency &&
      id_type == o.id_type &&
      bookmarked == o.bookmarked &&
      name == o.name &&
      recipients == o.recipients &&
      transactions == o.transactions &&
      transfers == o.transfers &&
      error == o.error &&
      usage == o.usage &&
      ownership == o.ownership &&
      company_name == o.company_name
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/budgea_client/models/account.rb, line 396
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 = BudgeaClient.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/budgea_client/models/account.rb, line 462
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/budgea_client/models/account.rb, line 375
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/budgea_client/models/account.rb, line 362
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/budgea_client/models/account.rb, line 368
def hash
  [id, id_connection, id_user, id_source, id_parent, number, webid, original_name, balance, coming, display, last_update, deleted, disabled, iban, bic, currency, id_type, bookmarked, name, recipients, transactions, transfers, error, usage, ownership, company_name].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/budgea_client/models/account.rb, line 290
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

  if @bookmarked.nil?
    invalid_properties.push('invalid value for "bookmarked", bookmarked 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/budgea_client/models/account.rb, line 442
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/budgea_client/models/account.rb, line 448
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/budgea_client/models/account.rb, line 436
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/budgea_client/models/account.rb, line 317
def valid?
  return false if @id.nil?
  return false if @original_name.nil?
  return false if @balance.nil?
  return false if @display.nil?
  return false if @bookmarked.nil?
  true
end