class Wallee::BankTransaction

Attributes

adjustments[RW]

The adjustments applied on this bank transaction.

created_by[RW]

The created by indicates the user which has created the bank transaction.

created_on[RW]

The created on date indicates the date on which the entity was stored into the database.

currency_bank_account[RW]

The currency bank account which is used to handle money flow.

external_id[RW]
flow_direction[RW]
id[RW]

The ID is the primary key of the entity. The ID identifies the entity uniquely.

linked_space_id[RW]

The linked space id holds the ID of the space to which the entity belongs to.

planned_purge_date[RW]

The planned purge date indicates when the entity is permanently removed. When the date is null the entity is not planned to be removed.

posting_amount[RW]

The posting amount indicates the amount including adjustments.

reference[RW]
source[RW]
state[RW]
total_adjustment_amount_including_tax[RW]
type[RW]
value_amount[RW]
value_date[RW]

The value date describes the date the amount is effective on the account.

version[RW]

The version number indicates the version of the entity. The version is incremented whenever the entity is changed.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 78
def self.attribute_map
  {
    :'adjustments' => :'adjustments',
    :'created_by' => :'createdBy',
    :'created_on' => :'createdOn',
    :'currency_bank_account' => :'currencyBankAccount',
    :'external_id' => :'externalId',
    :'flow_direction' => :'flowDirection',
    :'id' => :'id',
    :'linked_space_id' => :'linkedSpaceId',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'posting_amount' => :'postingAmount',
    :'reference' => :'reference',
    :'source' => :'source',
    :'state' => :'state',
    :'total_adjustment_amount_including_tax' => :'totalAdjustmentAmountIncludingTax',
    :'type' => :'type',
    :'value_amount' => :'valueAmount',
    :'value_date' => :'valueDate',
    :'version' => :'version'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 127
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?(:'adjustments')
    if (value = attributes[:'adjustments']).is_a?(Array)
      self.adjustments = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 102
def self.swagger_types
  {
    :'adjustments' => :'Array<PaymentAdjustment>',
    :'created_by' => :'Integer',
    :'created_on' => :'DateTime',
    :'currency_bank_account' => :'CurrencyBankAccount',
    :'external_id' => :'String',
    :'flow_direction' => :'BankTransactionFlowDirection',
    :'id' => :'Integer',
    :'linked_space_id' => :'Integer',
    :'planned_purge_date' => :'DateTime',
    :'posting_amount' => :'Float',
    :'reference' => :'String',
    :'source' => :'Integer',
    :'state' => :'BankTransactionState',
    :'total_adjustment_amount_including_tax' => :'Float',
    :'type' => :'Integer',
    :'value_amount' => :'Float',
    :'value_date' => :'DateTime',
    :'version' => :'Integer'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 247
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      adjustments == o.adjustments &&
      created_by == o.created_by &&
      created_on == o.created_on &&
      currency_bank_account == o.currency_bank_account &&
      external_id == o.external_id &&
      flow_direction == o.flow_direction &&
      id == o.id &&
      linked_space_id == o.linked_space_id &&
      planned_purge_date == o.planned_purge_date &&
      posting_amount == o.posting_amount &&
      reference == o.reference &&
      source == o.source &&
      state == o.state &&
      total_adjustment_amount_including_tax == o.total_adjustment_amount_including_tax &&
      type == o.type &&
      value_amount == o.value_amount &&
      value_date == o.value_date &&
      version == o.version
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/wallee-ruby-sdk/models/bank_transaction.rb, line 306
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 = Wallee.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/wallee-ruby-sdk/models/bank_transaction.rb, line 372
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/wallee-ruby-sdk/models/bank_transaction.rb, line 285
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/wallee-ruby-sdk/models/bank_transaction.rb, line 272
def eql?(o)
  self == o
end
external_id=(external_id) click to toggle source

Custom attribute writer method with validation @param [Object] external_id Value to be assigned

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 233
def external_id=(external_id)
  if !external_id.nil? && external_id.to_s.length > 100
    fail ArgumentError, 'invalid value for "external_id", the character length must be smaller than or equal to 100.'
  end

  if !external_id.nil? && external_id.to_s.length < 1
    fail ArgumentError, 'invalid value for "external_id", the character length must be great than or equal to 1.'
  end

  @external_id = external_id
end
hash() click to toggle source

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

# File lib/wallee-ruby-sdk/models/bank_transaction.rb, line 278
def hash
  [adjustments, created_by, created_on, currency_bank_account, external_id, flow_direction, id, linked_space_id, planned_purge_date, posting_amount, reference, source, state, total_adjustment_amount_including_tax, type, value_amount, value_date, version].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/wallee-ruby-sdk/models/bank_transaction.rb, line 210
def list_invalid_properties
  invalid_properties = Array.new
  if !@external_id.nil? && @external_id.to_s.length > 100
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 100.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  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/wallee-ruby-sdk/models/bank_transaction.rb, line 352
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/wallee-ruby-sdk/models/bank_transaction.rb, line 358
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/wallee-ruby-sdk/models/bank_transaction.rb, line 346
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/wallee-ruby-sdk/models/bank_transaction.rb, line 225
def valid?
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  true
end