Class: PostfinancecheckoutRubySdk::BankTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankTransaction

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 172

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `PostfinancecheckoutRubySdk::BankTransaction` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `PostfinancecheckoutRubySdk::BankTransaction`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'version')
    self.version = attributes[:'version']
  end

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

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

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

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

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

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

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

  if attributes.key?(:'payment_date')
    self.payment_date = attributes[:'payment_date']
  end

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

Instance Attribute Details

#adjustments ⇒ Object

Adjustments are changes made to the initial transaction amount, such as fees or corrections.



29
30
31
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 29

def adjustments
  @adjustments
end

#created_by ⇒ Object

The ID of the user the bank transaction was created by.



69
70
71
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 69

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



52
53
54
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 52

def created_on
  @created_on
end

#currency_bank_account ⇒ Object

Returns the value of attribute currency_bank_account.



31
32
33
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 31

def 
  
end

#external_id ⇒ Object

A client generated nonce which identifies the entity to be created. Subsequent creation requests with the same external ID will not create new entities but return the initially created entity instead.



37
38
39
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 37

def external_id
  @external_id
end

#flow_direction ⇒ Object

Returns the value of attribute flow_direction.



66
67
68
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 66

def flow_direction
  @flow_direction
end

#id ⇒ Object

A unique identifier for the object.



72
73
74
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 72

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



61
62
63
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 61

def linked_space_id
  @linked_space_id
end

#payment_date ⇒ Object

The payment date specifies the date on which the payment was processed.



77
78
79
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 77

def payment_date
  @payment_date
end

#planned_purge_date ⇒ Object

The date and time when the object is planned to be permanently removed. If the value is empty, the object will not be removed.



34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 34

def planned_purge_date
  @planned_purge_date
end

#posting_amount ⇒ Object

The posting amount refers to the monetary value recorded for the bank transaction prior to any adjustments.



40
41
42
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 40

def posting_amount
  @posting_amount
end

#reference ⇒ Object

A unique reference to identify the bank transaction.



58
59
60
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 58

def reference
  @reference
end

#source ⇒ Object

The source indicates how the bank transaction was created.



43
44
45
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 43

def source
  @source
end

#state ⇒ Object

Returns the value of attribute state.



74
75
76
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 74

def state
  @state
end

#total_adjustment_amount_including_tax ⇒ Object

Represents the total value of all adjustments to the bank transaction, including tax.



80
81
82
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 80

def total_adjustment_amount_including_tax
  @total_adjustment_amount_including_tax
end

#type ⇒ Object

The bank transaction’s type.



49
50
51
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 49

def type
  @type
end

#value_amount ⇒ Object

The value amount represents the net monetary value of the transaction after applicable deductions.



64
65
66
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 64

def value_amount
  @value_amount
end

#value_date ⇒ Object

The value date indicates the date on which the transaction amount becomes effective.



46
47
48
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 46

def value_date
  @value_date
end

#version ⇒ Object

The version is used for optimistic locking and incremented whenever the object is updated.



55
56
57
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 55

def version
  @version
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 384

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = PostfinancecheckoutRubySdk.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



130
131
132
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 130

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



135
136
137
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 135

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 105

def self.attribute_map
  {
    :'adjustments' => :'adjustments',
    :'currency_bank_account' => :'currencyBankAccount',
    :'planned_purge_date' => :'plannedPurgeDate',
    :'external_id' => :'externalId',
    :'posting_amount' => :'postingAmount',
    :'source' => :'source',
    :'value_date' => :'valueDate',
    :'type' => :'type',
    :'created_on' => :'createdOn',
    :'version' => :'version',
    :'reference' => :'reference',
    :'linked_space_id' => :'linkedSpaceId',
    :'value_amount' => :'valueAmount',
    :'flow_direction' => :'flowDirection',
    :'created_by' => :'createdBy',
    :'id' => :'id',
    :'state' => :'state',
    :'payment_date' => :'paymentDate',
    :'total_adjustment_amount_including_tax' => :'totalAdjustmentAmountIncludingTax'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 360

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



165
166
167
168
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 165

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 140

def self.openapi_types
  {
    :'adjustments' => :'Array<PaymentAdjustment>',
    :'currency_bank_account' => :'CurrencyBankAccount',
    :'planned_purge_date' => :'Time',
    :'external_id' => :'String',
    :'posting_amount' => :'Float',
    :'source' => :'Integer',
    :'value_date' => :'Time',
    :'type' => :'Integer',
    :'created_on' => :'Time',
    :'version' => :'Integer',
    :'reference' => :'String',
    :'linked_space_id' => :'Integer',
    :'value_amount' => :'Float',
    :'flow_direction' => :'BankTransactionFlowDirection',
    :'created_by' => :'Integer',
    :'id' => :'Integer',
    :'state' => :'BankTransactionState',
    :'payment_date' => :'Time',
    :'total_adjustment_amount_including_tax' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 321

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      adjustments == o.adjustments &&
       == o. &&
      planned_purge_date == o.planned_purge_date &&
      external_id == o.external_id &&
      posting_amount == o.posting_amount &&
      source == o.source &&
      value_date == o.value_date &&
      type == o.type &&
      created_on == o.created_on &&
      version == o.version &&
      reference == o.reference &&
      linked_space_id == o.linked_space_id &&
      value_amount == o.value_amount &&
      flow_direction == o.flow_direction &&
      created_by == o.created_by &&
      id == o.id &&
      state == o.state &&
      payment_date == o.payment_date &&
      total_adjustment_amount_including_tax == o.total_adjustment_amount_including_tax
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 455

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


347
348
349
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 347

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



353
354
355
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 353

def hash
  [adjustments, , planned_purge_date, external_id, posting_amount, source, value_date, type, created_on, version, reference, linked_space_id, value_amount, flow_direction, created_by, id, state, payment_date, total_adjustment_amount_including_tax].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 267

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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

  pattern = Regexp.new(/[ \x20-\x7e]*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



431
432
433
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 431

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 437

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



425
426
427
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 425

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



288
289
290
291
292
293
294
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 288

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@external_id.nil? && @external_id.to_s.length > 100
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@external_id.nil? && @external_id !~ Regexp.new(/[ \x20-\x7e]*/)
  true
end