Class: SyncteraRubySdk::DepositGet

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DepositGet

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 169

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SyncteraRubySdk::DepositGet` 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::DepositGet`. 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?(:'account_id')
    self. = attributes[:'account_id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the account



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

def 
  @account_id
end

#back_image_id ⇒ Object

ID of the uploaded image of the back of the check



22
23
24
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 22

def back_image_id
  @back_image_id
end

#business_id ⇒ Object

Unique ID for the business. Exactly one of ‘business_id` or `person_id` must be set.



25
26
27
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 25

def business_id
  @business_id
end

#check_amount ⇒ Object

Amount on check in ISO 4217 minor currency units



28
29
30
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 28

def check_amount
  @check_amount
end

#creation_time ⇒ Object

Returns the value of attribute creation_time.



42
43
44
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 42

def creation_time
  @creation_time
end

#date_captured ⇒ Object

Date the deposit was captured, in RFC 3339 format



45
46
47
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 45

def date_captured
  @date_captured
end

#date_processed ⇒ Object

Date the deposit was processed, in RFC 3339 format



48
49
50
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 48

def date_processed
  @date_processed
end

#deposit_amount ⇒ Object

Amount deposited in ISO 4217 minor currency units



51
52
53
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 51

def deposit_amount
  @deposit_amount
end

#deposit_currency ⇒ Object

ISO 4217 currency code for the deposit amount



31
32
33
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 31

def deposit_currency
  @deposit_currency
end

#front_image_id ⇒ Object

ID of the uploaded image of the front of the check



34
35
36
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 34

def front_image_id
  @front_image_id
end

#id ⇒ Object

Remote Check Deposit ID



54
55
56
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 54

def id
  @id
end

#last_updated_time ⇒ Object

Returns the value of attribute last_updated_time.



56
57
58
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 56

def last_updated_time
  @last_updated_time
end

#metadata ⇒ Object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.



37
38
39
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 37

def metadata
  @metadata
end

#ocr_account_number ⇒ Object

Account number of the issuer of the check, included if OCR is successful



59
60
61
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 59

def 
  @ocr_account_number
end

#ocr_check_number ⇒ Object

The unique check number for this check in the checkbook, included if OCR is successful and there is a check number on the check



62
63
64
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 62

def ocr_check_number
  @ocr_check_number
end

#ocr_routing_number ⇒ Object

Routing number of the issuing bank, included if OCR is successful



65
66
67
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 65

def ocr_routing_number
  @ocr_routing_number
end

#person_id ⇒ Object

Unique ID for the person. Exactly one of ‘person_id` or `business_id` must be set.



40
41
42
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 40

def person_id
  @person_id
end

#status ⇒ Object

The status of the deposit



68
69
70
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 68

def status
  @status
end

#transaction_id ⇒ Object

The ID of the transaction associated with this deposit



71
72
73
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 71

def transaction_id
  @transaction_id
end

#vendor_info ⇒ Object

Returns the value of attribute vendor_info.



73
74
75
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 73

def vendor_info
  @vendor_info
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



124
125
126
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 124

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 98

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'back_image_id' => :'back_image_id',
    :'business_id' => :'business_id',
    :'check_amount' => :'check_amount',
    :'deposit_currency' => :'deposit_currency',
    :'front_image_id' => :'front_image_id',
    :'metadata' => :'metadata',
    :'person_id' => :'person_id',
    :'creation_time' => :'creation_time',
    :'date_captured' => :'date_captured',
    :'date_processed' => :'date_processed',
    :'deposit_amount' => :'deposit_amount',
    :'id' => :'id',
    :'last_updated_time' => :'last_updated_time',
    :'ocr_account_number' => :'ocr_account_number',
    :'ocr_check_number' => :'ocr_check_number',
    :'ocr_routing_number' => :'ocr_routing_number',
    :'status' => :'status',
    :'transaction_id' => :'transaction_id',
    :'vendor_info' => :'vendor_info'
  }
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



399
400
401
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 399

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



161
162
163
164
165
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 161

def self.openapi_all_of
  [
  :'Deposit'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



155
156
157
158
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 155

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

.openapi_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 129

def self.openapi_types
  {
    :'account_id' => :'String',
    :'back_image_id' => :'String',
    :'business_id' => :'String',
    :'check_amount' => :'Integer',
    :'deposit_currency' => :'String',
    :'front_image_id' => :'String',
    :'metadata' => :'Object',
    :'person_id' => :'String',
    :'creation_time' => :'Time',
    :'date_captured' => :'Time',
    :'date_processed' => :'Time',
    :'deposit_amount' => :'Integer',
    :'id' => :'String',
    :'last_updated_time' => :'Time',
    :'ocr_account_number' => :'String',
    :'ocr_check_number' => :'String',
    :'ocr_routing_number' => :'String',
    :'status' => :'String',
    :'transaction_id' => :'String',
    :'vendor_info' => :'VendorInfo'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 359

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      back_image_id == o.back_image_id &&
      business_id == o.business_id &&
      check_amount == o.check_amount &&
      deposit_currency == o.deposit_currency &&
      front_image_id == o.front_image_id &&
      metadata == o.metadata &&
      person_id == o.person_id &&
      creation_time == o.creation_time &&
      date_captured == o.date_captured &&
      date_processed == o.date_processed &&
      deposit_amount == o.deposit_amount &&
      id == o.id &&
      last_updated_time == o.last_updated_time &&
       == o. &&
      ocr_check_number == o.ocr_check_number &&
      ocr_routing_number == o.ocr_routing_number &&
      status == o.status &&
      transaction_id == o.transaction_id &&
      vendor_info == o.vendor_info
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



430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 430

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



501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 501

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



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 406

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


386
387
388
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 386

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



392
393
394
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 392

def hash
  [, back_image_id, business_id, check_amount, deposit_currency, front_image_id, metadata, person_id, creation_time, date_captured, date_processed, deposit_amount, id, last_updated_time, , ocr_check_number, ocr_routing_number, status, transaction_id, vendor_info].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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 265

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

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

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

  if @check_amount < 1
    invalid_properties.push('invalid value for "check_amount", must be greater than or equal to 1.')
  end

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

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

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

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

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

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

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



477
478
479
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 477

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



483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 483

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



471
472
473
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 471

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/synctera_ruby_sdk/models/deposit_get.rb', line 316

def valid?
  return false if @account_id.nil?
  return false if @back_image_id.nil?
  return false if @check_amount.nil?
  return false if @check_amount < 1
  return false if @deposit_currency.nil?
  return false if @front_image_id.nil?
  return false if @date_captured.nil?
  return false if @date_processed.nil?
  return false if @deposit_amount.nil?
  return false if @id.nil?
  return false if @status.nil?
  status_validator = EnumAttributeValidator.new('String', ["SUBMITTED", "PENDING", "FAILED", "REJECTED"])
  return false unless status_validator.valid?(@status)
  true
end