Class: PostFinanceCheckout::BankTransaction

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

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



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
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
 
# File 'lib/postfinancecheckout-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. = 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

Instance Attribute Details

#adjustments ⇒ Object

The adjustments applied on this bank transaction.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 24

def adjustments
  @adjustments
end

#created_by ⇒ Object

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



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

def created_by
  @created_by
end

#created_on ⇒ Object

The date and time when the object was created.



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

def created_on
  @created_on
end

#currency_bank_account ⇒ Object

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



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

def 
  @currency_bank_account
end

#external_id ⇒ Object

Returns the value of attribute external_id.



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

def external_id
  @external_id
end

#flow_direction ⇒ Object

Returns the value of attribute flow_direction.



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

def flow_direction
  @flow_direction
end

#id ⇒ Object

A unique identifier for the object.



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

def id
  @id
end

#linked_space_id ⇒ Object

The ID of the space this object belongs to.



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

def linked_space_id
  @linked_space_id
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.



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

def planned_purge_date
  @planned_purge_date
end

#posting_amount ⇒ Object

The posting amount indicates the amount including adjustments.



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

def posting_amount
  @posting_amount
end

#reference ⇒ Object

Returns the value of attribute reference.



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

def reference
  @reference
end

#source ⇒ Object

Returns the value of attribute source.



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

def source
  @source
end

#state ⇒ Object

The object’s current state.



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

def state
  @state
end

#total_adjustment_amount_including_tax ⇒ Object

Returns the value of attribute total_adjustment_amount_including_tax.



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

def total_adjustment_amount_including_tax
  @total_adjustment_amount_including_tax
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#value_amount ⇒ Object

Returns the value of attribute value_amount.



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

def value_amount
  @value_amount
end

#value_date ⇒ Object

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



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

def value_date
  @value_date
end

#version ⇒ Object

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



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

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/postfinancecheckout-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

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/postfinancecheckout-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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/postfinancecheckout-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 &&
       == o. &&
      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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/postfinancecheckout-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 = PostFinanceCheckout.const_get(type).new
    temp_model.build_from_hash(value)
  end
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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/postfinancecheckout-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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/postfinancecheckout-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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



278
279
280
 
# File 'lib/postfinancecheckout-ruby-sdk/models/bank_transaction.rb', line 278

def hash
  [adjustments, created_by, created_on, , 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 ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/postfinancecheckout-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 ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



358
359
360
361
362
363
364
365
366
 
# File 'lib/postfinancecheckout-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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



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

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



225
226
227
228
229
 
# File 'lib/postfinancecheckout-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