class BudgeaClient::Transaction

Attributes

active[RW]

If false, PFM services will ignore this transaction

application_date[RW]

Date considered by PFM services. It is used to change the month of a transaction, for example.

bdate[RW]

Date used by the bank for the transaction

card[RW]

Card number associated to the transaction

coming[RW]

If true, this transaction hasn't been yet debited

comment[RW]

User comment

commission[RW]

Commission taken on the transaction

commission_currency[RW]

Commission currency

counterparty[RW]

Counterparty

country[RW]

Original country

date[RW]

Debit date

date_scraped[RW]

Date when the transaction has been seen

deleted[RW]

If set, this transaction has been removed from the bank

gross_value[RW]

Gross value of the transaction

id[RW]

ID of the transaction

id_account[RW]

ID of the related account

id_category[RW]

ID of the related category

id_cluster[RW]

If the transaction is part of a cluster

last_update[RW]

Last update of the transaction

nature[RW]

Type of transaction

original_currency[RW]

Original currency

original_gross_value[RW]

Gross value in the original currency

original_value[RW]

Value in the original currency

original_wording[RW]

Full label of the transaction

rdate[RW]

Realization of the transaction

simplified_wording[RW]

Simplified label of the transaction

state[RW]

Internal state of the transaction

stemmed_wording[RW]

Do not use it

value[RW]

Value of the transaction

vdate[RW]

Value date of the transaction

webid[RW]

Webid of the transaction

wording[RW]

Label set by the user

Public Class Methods

attribute_map() click to toggle source

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

# File lib/budgea_client/models/transaction.rb, line 114
def self.attribute_map
  {
    :'id' => :'id',
    :'id_account' => :'id_account',
    :'webid' => :'webid',
    :'application_date' => :'application_date',
    :'date' => :'date',
    :'value' => :'value',
    :'gross_value' => :'gross_value',
    :'nature' => :'nature',
    :'original_wording' => :'original_wording',
    :'simplified_wording' => :'simplified_wording',
    :'stemmed_wording' => :'stemmed_wording',
    :'wording' => :'wording',
    :'id_category' => :'id_category',
    :'state' => :'state',
    :'date_scraped' => :'date_scraped',
    :'rdate' => :'rdate',
    :'vdate' => :'vdate',
    :'bdate' => :'bdate',
    :'coming' => :'coming',
    :'active' => :'active',
    :'id_cluster' => :'id_cluster',
    :'comment' => :'comment',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted',
    :'original_value' => :'original_value',
    :'original_gross_value' => :'original_gross_value',
    :'original_currency' => :'original_currency',
    :'commission' => :'commission',
    :'commission_currency' => :'commission_currency',
    :'country' => :'country',
    :'counterparty' => :'counterparty',
    :'card' => :'card'
  }
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/transaction.rb, line 191
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_account')
    self.id_account = attributes[:'id_account']
  end

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

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

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

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

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

  if attributes.has_key?(:'nature')
    self.nature = attributes[:'nature']
  else
    self.nature = 'inconnu'
  end

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

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

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

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

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

  if attributes.has_key?(:'state')
    self.state = attributes[:'state']
  else
    self.state = 'new'
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'comment')
    self.comment = attributes[:'comment']
  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?(:'original_value')
    self.original_value = attributes[:'original_value']
  end

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/budgea_client/models/transaction.rb, line 152
def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_account' => :'Integer',
    :'webid' => :'String',
    :'application_date' => :'Date',
    :'date' => :'Date',
    :'value' => :'Float',
    :'gross_value' => :'Float',
    :'nature' => :'String',
    :'original_wording' => :'String',
    :'simplified_wording' => :'String',
    :'stemmed_wording' => :'String',
    :'wording' => :'String',
    :'id_category' => :'Integer',
    :'state' => :'String',
    :'date_scraped' => :'DateTime',
    :'rdate' => :'Date',
    :'vdate' => :'Date',
    :'bdate' => :'Date',
    :'coming' => :'BOOLEAN',
    :'active' => :'BOOLEAN',
    :'id_cluster' => :'Integer',
    :'comment' => :'String',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime',
    :'original_value' => :'Float',
    :'original_gross_value' => :'Float',
    :'original_currency' => :'Object',
    :'commission' => :'Float',
    :'commission_currency' => :'Object',
    :'country' => :'String',
    :'counterparty' => :'String',
    :'card' => :'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/transaction.rb, line 407
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_account == o.id_account &&
      webid == o.webid &&
      application_date == o.application_date &&
      date == o.date &&
      value == o.value &&
      gross_value == o.gross_value &&
      nature == o.nature &&
      original_wording == o.original_wording &&
      simplified_wording == o.simplified_wording &&
      stemmed_wording == o.stemmed_wording &&
      wording == o.wording &&
      id_category == o.id_category &&
      state == o.state &&
      date_scraped == o.date_scraped &&
      rdate == o.rdate &&
      vdate == o.vdate &&
      bdate == o.bdate &&
      coming == o.coming &&
      active == o.active &&
      id_cluster == o.id_cluster &&
      comment == o.comment &&
      last_update == o.last_update &&
      deleted == o.deleted &&
      original_value == o.original_value &&
      original_gross_value == o.original_gross_value &&
      original_currency == o.original_currency &&
      commission == o.commission &&
      commission_currency == o.commission_currency &&
      country == o.country &&
      counterparty == o.counterparty &&
      card == o.card
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/transaction.rb, line 480
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/transaction.rb, line 546
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/transaction.rb, line 459
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/transaction.rb, line 446
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/transaction.rb, line 452
def hash
  [id, id_account, webid, application_date, date, value, gross_value, nature, original_wording, simplified_wording, stemmed_wording, wording, id_category, state, date_scraped, rdate, vdate, bdate, coming, active, id_cluster, comment, last_update, deleted, original_value, original_gross_value, original_currency, commission, commission_currency, country, counterparty, card].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/transaction.rb, line 334
def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

  if @active.nil?
    invalid_properties.push('invalid value for "active", active 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/transaction.rb, line 526
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/transaction.rb, line 532
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/transaction.rb, line 520
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/transaction.rb, line 389
def valid?
  return false if @id.nil?
  return false if @id_account.nil?
  return false if @date.nil?
  return false if @nature.nil?
  return false if @original_wording.nil?
  return false if @simplified_wording.nil?
  return false if @stemmed_wording.nil?
  return false if @state.nil?
  return false if @date_scraped.nil?
  return false if @rdate.nil?
  return false if @coming.nil?
  return false if @active.nil?
  true
end