Class: Plaid::BankTransfer

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

Overview

Represents a bank transfer within the Bank Transfers API.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BankTransfer

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/plaid/models/bank_transfer.rb', line 126

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

Instance Attribute Details

#account_id ⇒ Object

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



25
26
27
 
# File 'lib/plaid/models/bank_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/bank_transfer.rb', line 22

def ach_class
  @ach_class
end

#amount ⇒ Object

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



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

def amount
  @amount
end

#cancellable ⇒ Object

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



48
49
50
 
# File 'lib/plaid/models/bank_transfer.rb', line 48

def cancellable
  @cancellable
end

#created ⇒ Object

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



41
42
43
 
# File 'lib/plaid/models/bank_transfer.rb', line 41

def created
  @created
end

#custom_tag ⇒ Object

A string containing the custom tag provided by the client in the create request. Will be null if not provided.



53
54
55
 
# File 'lib/plaid/models/bank_transfer.rb', line 53

def custom_tag
  @custom_tag
end

#description ⇒ Object

The description of the transfer.



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

def description
  @description
end

#direction ⇒ Object

Returns the value of attribute direction.



61
62
63
 
# File 'lib/plaid/models/bank_transfer.rb', line 61

def direction
  @direction
end

#failure_reason ⇒ Object

Returns the value of attribute failure_reason.



50
51
52
 
# File 'lib/plaid/models/bank_transfer.rb', line 50

def failure_reason
  @failure_reason
end

#id ⇒ Object

Plaid’s unique identifier for a bank transfer.



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

def id
  @id
end

#iso_currency_code ⇒ Object

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



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

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



56
57
58
 
# File 'lib/plaid/models/bank_transfer.rb', line 56

def metadata
  @metadata
end

#network ⇒ Object

Returns the value of attribute network.



45
46
47
 
# File 'lib/plaid/models/bank_transfer.rb', line 45

def network
  @network
end

#origination_account_id ⇒ Object

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



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

def 
  
end

#status ⇒ Object

Returns the value of attribute status.



43
44
45
 
# File 'lib/plaid/models/bank_transfer.rb', line 43

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#user ⇒ Object

Returns the value of attribute user.



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

def user
  @user
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/plaid/models/bank_transfer.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/plaid/models/bank_transfer.rb', line 64

def self.attribute_map
  {
    :'id' => :'id',
    :'ach_class' => :'ach_class',
    :'account_id' => :'account_id',
    :'type' => :'type',
    :'user' => :'user',
    :'amount' => :'amount',
    :'iso_currency_code' => :'iso_currency_code',
    :'description' => :'description',
    :'created' => :'created',
    :'status' => :'status',
    :'network' => :'network',
    :'cancellable' => :'cancellable',
    :'failure_reason' => :'failure_reason',
    :'custom_tag' => :'custom_tag',
    :'metadata' => :'metadata',
    :'origination_account_id' => :'origination_account_id',
    :'direction' => :'direction'
  }
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



336
337
338
 
# File 'lib/plaid/models/bank_transfer.rb', line 336

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
120
121
122
 
# File 'lib/plaid/models/bank_transfer.rb', line 115

def self.openapi_nullable
  Set.new([
    :'failure_reason',
    :'custom_tag',
    :'metadata',
    :'direction'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/plaid/models/bank_transfer.rb', line 92

def self.openapi_types
  {
    :'id' => :'String',
    :'ach_class' => :'ACHClass',
    :'account_id' => :'String',
    :'type' => :'BankTransferType',
    :'user' => :'BankTransferUser',
    :'amount' => :'String',
    :'iso_currency_code' => :'String',
    :'description' => :'String',
    :'created' => :'Time',
    :'status' => :'BankTransferStatus',
    :'network' => :'BankTransferNetwork',
    :'cancellable' => :'Boolean',
    :'failure_reason' => :'BankTransferFailure',
    :'custom_tag' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'origination_account_id' => :'String',
    :'direction' => :'BankTransferDirection'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

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 &&
      iso_currency_code == o.iso_currency_code &&
      description == o.description &&
      created == o.created &&
      status == o.status &&
      network == o.network &&
      cancellable == o.cancellable &&
      failure_reason == o.failure_reason &&
      custom_tag == o.custom_tag &&
      metadata == o.metadata &&
       == o. &&
      direction == o.direction
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



366
367
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
 
# File 'lib/plaid/models/bank_transfer.rb', line 366

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



437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/plaid/models/bank_transfer.rb', line 437

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



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/plaid/models/bank_transfer.rb', line 343

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


323
324
325
 
# File 'lib/plaid/models/bank_transfer.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/plaid/models/bank_transfer.rb', line 329

def hash
  [id, ach_class, , type, user, amount, iso_currency_code, description, created, status, network, cancellable, failure_reason, custom_tag, metadata, , direction].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
 
# File 'lib/plaid/models/bank_transfer.rb', line 212

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

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

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



413
414
415
 
# File 'lib/plaid/models/bank_transfer.rb', line 413

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



419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/plaid/models/bank_transfer.rb', line 419

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



407
408
409
 
# File 'lib/plaid/models/bank_transfer.rb', line 407

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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/plaid/models/bank_transfer.rb', line 272

def valid?
  return false if @id.nil?
  return false if @ach_class.nil?
  return false if @account_id.nil?
  return false if @type.nil?
  return false if @user.nil?
  return false if @amount.nil?
  return false if @iso_currency_code.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 .nil?
  true
end