Class: Plaid::Transfer

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/transfer.rb

Overview

Represents a transfer within the Transfers API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/plaid/models/transfer.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The account ID that should be credited/debited for this transfer.



25
26
27
 
# File 'lib/plaid/models/transfer.rb', line 25

def 
  @account_id
end

#ach_class ⇒ Object

Returns the value of attribute ach_class.



22
23
24
 
# File 'lib/plaid/models/transfer.rb', line 22

def ach_class
  @ach_class
end

#amount ⇒ Object

The amount of the transfer (decimal string with two digits of precision e.g. "10.00").



32
33
34
 
# File 'lib/plaid/models/transfer.rb', line 32

def amount
  @amount
end

#cancellable ⇒ Object

When ‘true`, you can still cancel this transfer.



47
48
49
 
# File 'lib/plaid/models/transfer.rb', line 47

def cancellable
  @cancellable
end

#created ⇒ Object

The datetime when this transfer was created. This will be of the form ‘2006-01-02T15:04:05Z`



38
39
40
 
# File 'lib/plaid/models/transfer.rb', line 38

def created
  @created
end

#description ⇒ Object

The description of the transfer.



35
36
37
 
# File 'lib/plaid/models/transfer.rb', line 35

def description
  @description
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



49
50
51
 
# File 'lib/plaid/models/transfer.rb', line 49

def failure_reason
  @failure_reason
end

#guarantee_decision ⇒ Object

Returns the value of attribute guarantee_decision.



57
58
59
 
# File 'lib/plaid/models/transfer.rb', line 57

def guarantee_decision
  @guarantee_decision
end

#guarantee_decision_rationale ⇒ Object

Returns the value of attribute guarantee_decision_rationale.



59
60
61
 
# File 'lib/plaid/models/transfer.rb', line 59

def guarantee_decision_rationale
  @guarantee_decision_rationale
end

#id ⇒ Object

Plaid’s unique identifier for a transfer.



20
21
22
 
# File 'lib/plaid/models/transfer.rb', line 20

def id
  @id
end

#iso_currency_code ⇒ Object

The currency of the transfer amount, e.g. "USD"



62
63
64
 
# File 'lib/plaid/models/transfer.rb', line 62

def iso_currency_code
  @iso_currency_code
end

#metadata ⇒ Object

The Metadata object is a mapping of client-provided string fields to any string value. The following limitations apply: - The JSON values must be Strings (no nested JSON objects allowed) - Only ASCII characters may be used - Maximum of 50 key/value pairs - Maximum key length of 40 characters - Maximum value length of 500 characters



52
53
54
 
# File 'lib/plaid/models/transfer.rb', line 52

def metadata
  @metadata
end

#network ⇒ Object

Returns the value of attribute network.



44
45
46
 
# File 'lib/plaid/models/transfer.rb', line 44

def network
  @network
end

#origination_account_id ⇒ Object

Plaid’s unique identifier for the origination account that was used for this transfer.



55
56
57
 
# File 'lib/plaid/models/transfer.rb', line 55

def 
  @origination_account_id
end

#originator_client_id ⇒ Object

The Plaid client ID that is the originator of this transfer. Only present if created on behalf of another client as a third-party sender (TPS).



71
72
73
 
# File 'lib/plaid/models/transfer.rb', line 71

def originator_client_id
  @originator_client_id
end

#refunds ⇒ Object

A list of refunds associated with this transfer.



74
75
76
 
# File 'lib/plaid/models/transfer.rb', line 74

def refunds
  @refunds
end

#standard_return_window ⇒ Object

The date 3 business days from settlement date indicating the following ACH returns can no longer happen: R01, R02, R03, R29. This will be of the form YYYY-MM-DD.



65
66
67
 
# File 'lib/plaid/models/transfer.rb', line 65

def standard_return_window
  @standard_return_window
end

#status ⇒ Object

Returns the value of attribute status.



40
41
42
 
# File 'lib/plaid/models/transfer.rb', line 40

def status
  @status
end

#sweep_status ⇒ Object

Returns the value of attribute sweep_status.



42
43
44
 
# File 'lib/plaid/models/transfer.rb', line 42

def sweep_status
  @sweep_status
end

#type ⇒ Object

Returns the value of attribute type.



27
28
29
 
# File 'lib/plaid/models/transfer.rb', line 27

def type
  @type
end

#unauthorized_return_window ⇒ Object

The date 61 business days from settlement date indicating the following ACH returns can no longer happen: R05, R07, R10, R11, R51, R33, R37, R38, R51, R52, R53. This will be of the form YYYY-MM-DD.



68
69
70
 
# File 'lib/plaid/models/transfer.rb', line 68

def unauthorized_return_window
  @unauthorized_return_window
end

#user ⇒ Object

Returns the value of attribute user.



29
30
31
 
# File 'lib/plaid/models/transfer.rb', line 29

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



105
106
107
 
# File 'lib/plaid/models/transfer.rb', line 105

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/plaid/models/transfer.rb', line 77

def self.attribute_map
  {
    :'id' => :'id',
    :'ach_class' => :'ach_class',
    :'account_id' => :'account_id',
    :'type' => :'type',
    :'user' => :'user',
    :'amount' => :'amount',
    :'description' => :'description',
    :'created' => :'created',
    :'status' => :'status',
    :'sweep_status' => :'sweep_status',
    :'network' => :'network',
    :'cancellable' => :'cancellable',
    :'failure_reason' => :'failure_reason',
    :'metadata' => :'metadata',
    :'origination_account_id' => :'origination_account_id',
    :'guarantee_decision' => :'guarantee_decision',
    :'guarantee_decision_rationale' => :'guarantee_decision_rationale',
    :'iso_currency_code' => :'iso_currency_code',
    :'standard_return_window' => :'standard_return_window',
    :'unauthorized_return_window' => :'unauthorized_return_window',
    :'originator_client_id' => :'originator_client_id',
    :'refunds' => :'refunds'
  }
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



385
386
387
 
# File 'lib/plaid/models/transfer.rb', line 385

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/plaid/models/transfer.rb', line 138

def self.openapi_nullable
  Set.new([
    :'sweep_status',
    :'failure_reason',
    :'metadata',
    :'guarantee_decision',
    :'guarantee_decision_rationale',
    :'standard_return_window',
    :'unauthorized_return_window',
    :'originator_client_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/plaid/models/transfer.rb', line 110

def self.openapi_types
  {
    :'id' => :'String',
    :'ach_class' => :'ACHClass',
    :'account_id' => :'String',
    :'type' => :'TransferType',
    :'user' => :'TransferUserInResponse',
    :'amount' => :'String',
    :'description' => :'String',
    :'created' => :'Time',
    :'status' => :'TransferStatus',
    :'sweep_status' => :'TransferSweepStatus',
    :'network' => :'TransferNetwork',
    :'cancellable' => :'Boolean',
    :'failure_reason' => :'TransferFailure',
    :'metadata' => :'Hash<String, String>',
    :'origination_account_id' => :'String',
    :'guarantee_decision' => :'TransferAuthorizationGuaranteeDecision',
    :'guarantee_decision_rationale' => :'TransferAuthorizationGuaranteeDecisionRationale',
    :'iso_currency_code' => :'String',
    :'standard_return_window' => :'Date',
    :'unauthorized_return_window' => :'Date',
    :'originator_client_id' => :'String',
    :'refunds' => :'Array<TransferRefund>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/plaid/models/transfer.rb', line 343

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      ach_class == o.ach_class &&
       == o. &&
      type == o.type &&
      user == o.user &&
      amount == o.amount &&
      description == o.description &&
      created == o.created &&
      status == o.status &&
      sweep_status == o.sweep_status &&
      network == o.network &&
      cancellable == o.cancellable &&
      failure_reason == o.failure_reason &&
      metadata == o.metadata &&
       == o. &&
      guarantee_decision == o.guarantee_decision &&
      guarantee_decision_rationale == o.guarantee_decision_rationale &&
      iso_currency_code == o.iso_currency_code &&
      standard_return_window == o.standard_return_window &&
      unauthorized_return_window == o.unauthorized_return_window &&
      originator_client_id == o.originator_client_id &&
      refunds == o.refunds
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



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/plaid/models/transfer.rb', line 415

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 = Plaid.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



486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/plaid/models/transfer.rb', line 486

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



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/plaid/models/transfer.rb', line 392

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


372
373
374
 
# File 'lib/plaid/models/transfer.rb', line 372

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



378
379
380
 
# File 'lib/plaid/models/transfer.rb', line 378

def hash
  [id, ach_class, , type, user, amount, description, created, status, sweep_status, network, cancellable, failure_reason, metadata, , guarantee_decision, guarantee_decision_rationale, iso_currency_code, standard_return_window, unauthorized_return_window, originator_client_id, refunds].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



261
262
263
264
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
313
 
# File 'lib/plaid/models/transfer.rb', line 261

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

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

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

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

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

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

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

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

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


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

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

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



462
463
464
 
# File 'lib/plaid/models/transfer.rb', line 462

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



468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/plaid/models/transfer.rb', line 468

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



456
457
458
 
# File 'lib/plaid/models/transfer.rb', line 456

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



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

def valid?
  return false if @id.nil?
  return false if @type.nil?
  return false if @user.nil?
  return false if @amount.nil?
  return false if @description.nil?
  return false if @created.nil?
  return false if @status.nil?
  return false if @network.nil?
  return false if @cancellable.nil?
  return false if @metadata.length > 50
  return false if @origination_account_id.nil?
  return false if @iso_currency_code.nil?
  return false if @refunds.nil?
  true
end