Class: SyncteraRubySdk::PostedTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/posted_transaction.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostedTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



126
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
207
208
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 126

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

The creation date of the transaction



19
20
21
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 19

def created
  @created
end

#data ⇒ Object

Returns the value of attribute data.



21
22
23
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 21

def data
  @data
end

#disputes ⇒ Object

The set of disputes related to this transaction. Since a dispute can be for a partial amount of a transaction, a single transaction can be involved in multiple disputes.



24
25
26
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 24

def disputes
  @disputes
end

#effective_date ⇒ Object

The "effective date" of a transaction. This may be earlier than posted_date in some cases (for example, a transaction that occurs on a Saturday may not be posted until the following Monday, but would have an effective date of Saturday)



27
28
29
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 27

def effective_date
  @effective_date
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 29

def id
  @id
end

#idemkey ⇒ Object

The idempotency key used when initially creating this transaction.



32
33
34
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 32

def idemkey
  @idemkey
end

#info_only ⇒ Object

Whether or not this transaction represents a purely informational operation or an actual money movement



35
36
37
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 35

def info_only
  @info_only
end

#lead_mode ⇒ Object

Whether or not this transaction was created operating in "lead ledger" mode



38
39
40
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 38

def lead_mode
  @lead_mode
end

#posted_date ⇒ Object

The date the transaction was posted. This is the date any money is considered to be added or removed from an account.



41
42
43
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 41

def posted_date
  @posted_date
end

#reference_id ⇒ Object

An external ID provided by the payment network to represent this transaction. This will always be null for internal transfers.



44
45
46
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 44

def reference_id
  @reference_id
end

#status ⇒ Object

Returns the value of attribute status.



46
47
48
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 46

def status
  @status
end

#subtype ⇒ Object

The specific transaction type. For example, for ‘ach`, this may be "outgoing_debit".



49
50
51
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 49

def subtype
  @subtype
end

#tenant ⇒ Object

The tenant associated with this transaction, in the form "<bankid>_<partnerid>"



52
53
54
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 52

def tenant
  @tenant
end

#transaction_time ⇒ Object

The time the transaction occurred.



55
56
57
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 55

def transaction_time
  @transaction_time
end

#type ⇒ Object

The general type of transaction. For example, "card" or "ach".



58
59
60
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 58

def type
  @type
end

#updated ⇒ Object

The date the transaction was last updated



61
62
63
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 61

def updated
  @updated
end

#uuid ⇒ Object

The unique identifier of the transaction.



64
65
66
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 64

def uuid
  @uuid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 67

def self.attribute_map
  {
    :'created' => :'created',
    :'data' => :'data',
    :'disputes' => :'disputes',
    :'effective_date' => :'effective_date',
    :'id' => :'id',
    :'idemkey' => :'idemkey',
    :'info_only' => :'info_only',
    :'lead_mode' => :'lead_mode',
    :'posted_date' => :'posted_date',
    :'reference_id' => :'reference_id',
    :'status' => :'status',
    :'subtype' => :'subtype',
    :'tenant' => :'tenant',
    :'transaction_time' => :'transaction_time',
    :'type' => :'type',
    :'updated' => :'updated',
    :'uuid' => :'uuid'
  }
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



337
338
339
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 337

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
122
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 118

def self.openapi_nullable
  Set.new([
    :'reference_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 95

def self.openapi_types
  {
    :'created' => :'Time',
    :'data' => :'PostedTransactionData',
    :'disputes' => :'Array<TransactionDispute>',
    :'effective_date' => :'Time',
    :'id' => :'Integer',
    :'idemkey' => :'String',
    :'info_only' => :'Boolean',
    :'lead_mode' => :'Boolean',
    :'posted_date' => :'Time',
    :'reference_id' => :'String',
    :'status' => :'String',
    :'subtype' => :'String',
    :'tenant' => :'String',
    :'transaction_time' => :'Time',
    :'type' => :'String',
    :'updated' => :'Time',
    :'uuid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created == o.created &&
      data == o.data &&
      disputes == o.disputes &&
      effective_date == o.effective_date &&
      id == o.id &&
      idemkey == o.idemkey &&
      info_only == o.info_only &&
      lead_mode == o.lead_mode &&
      posted_date == o.posted_date &&
      reference_id == o.reference_id &&
      status == o.status &&
      subtype == o.subtype &&
      tenant == o.tenant &&
      transaction_time == o.transaction_time &&
      type == o.type &&
      updated == o.updated &&
      uuid == o.uuid
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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 368

def _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 = SyncteraRubySdk.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 439

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 344

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


324
325
326
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 330

def hash
  [created, data, disputes, effective_date, id, idemkey, info_only, lead_mode, posted_date, reference_id, status, subtype, tenant, transaction_time, type, updated, uuid].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



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
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 212

def list_invalid_properties
  invalid_properties = Array.new
  if @created.nil?
    invalid_properties.push('invalid value for "created", created cannot be nil.')
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

  if @uuid.nil?
    invalid_properties.push('invalid value for "uuid", uuid cannot be nil.')
  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



415
416
417
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 415

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



421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 421

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



409
410
411
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 409

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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/synctera_ruby_sdk/models/posted_transaction.rb', line 279

def valid?
  return false if @created.nil?
  return false if @data.nil?
  return false if @effective_date.nil?
  return false if @id.nil?
  return false if @idemkey.nil?
  return false if @info_only.nil?
  return false if @lead_mode.nil?
  return false if @posted_date.nil?
  return false if @status.nil?
  return false if @subtype.nil?
  return false if @tenant.nil?
  return false if @transaction_time.nil?
  return false if @type.nil?
  return false if @updated.nil?
  return false if @uuid.nil?
  true
end