Class: SyncteraRubySdk::Deposit

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

Overview

Deposit using remote deposit capture

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Deposit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
262
263
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 171

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



20
21
22
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 20

def 
  @account_id
end

#back_image_id ⇒ Object

ID of the uploaded image of the back of the check



23
24
25
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 23

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.



26
27
28
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 26

def business_id
  @business_id
end

#check_amount ⇒ Object

Amount on check in ISO 4217 minor currency units



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

def check_amount
  @check_amount
end

#creation_time ⇒ Object

Returns the value of attribute creation_time.



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 43

def creation_time
  @creation_time
end

#date_captured ⇒ Object

Date the deposit was captured, in RFC 3339 format



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

def date_captured
  @date_captured
end

#date_processed ⇒ Object

Date the deposit was processed, in RFC 3339 format



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

def date_processed
  @date_processed
end

#deposit_amount ⇒ Object

Amount deposited in ISO 4217 minor currency units



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

def deposit_amount
  @deposit_amount
end

#deposit_currency ⇒ Object

ISO 4217 currency code for the deposit amount



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

def deposit_currency
  @deposit_currency
end

#front_image_id ⇒ Object

ID of the uploaded image of the front of the check



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

def front_image_id
  @front_image_id
end

#id ⇒ Object

Remote Check Deposit ID



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

def id
  @id
end

#last_updated_time ⇒ Object

Returns the value of attribute last_updated_time.



57
58
59
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 57

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.



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

def metadata
  @metadata
end

#ocr_account_number ⇒ Object

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



60
61
62
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 60

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



63
64
65
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 63

def ocr_check_number
  @ocr_check_number
end

#ocr_routing_number ⇒ Object

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



66
67
68
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 66

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.



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

def person_id
  @person_id
end

#status ⇒ Object

The status of the deposit



69
70
71
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 69

def status
  @status
end

#transaction_id ⇒ Object

The ID of the transaction associated with this deposit



72
73
74
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 72

def transaction_id
  @transaction_id
end

#vendor_info ⇒ Object

Returns the value of attribute vendor_info.



74
75
76
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 74

def vendor_info
  @vendor_info
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



125
126
127
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 125

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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



347
348
349
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 347

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



162
163
164
165
166
167
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 162

def self.openapi_all_of
  [
  :'DepositAllOf',
  :'DepositRequest'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



156
157
158
159
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 156

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 307

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



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
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 378

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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 449

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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 354

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


334
335
336
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 334

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



340
341
342
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 340

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



267
268
269
270
271
272
273
274
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 267

def list_invalid_properties
  invalid_properties = Array.new
  if !@check_amount.nil? && @check_amount < 1
    invalid_properties.push('invalid value for "check_amount", must be greater 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



425
426
427
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 425

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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 431

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



419
420
421
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 419

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



278
279
280
281
282
283
 
# File 'lib/synctera_ruby_sdk/models/deposit.rb', line 278

def valid?
  return false if !@check_amount.nil? && @check_amount < 1
  status_validator = EnumAttributeValidator.new('String', ["SUBMITTED", "PENDING", "FAILED", "REJECTED"])
  return false unless status_validator.valid?(@status)
  true
end