Class: CybridApiBank::ExternalBankAccountBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExternalBankAccountBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 136

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_kind ⇒ Object

The type of account; one of plaid, plaid_processor_token, or raw_routing_details.



28
29
30
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 28

def 
  @account_kind
end

#asset ⇒ Object

The asset code.



25
26
27
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 25

def asset
  @asset
end

#balance_updated_at ⇒ Object

The timestamp that the balance information was last updated at.



61
62
63
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 61

def balance_updated_at
  @balance_updated_at
end

#balances ⇒ Object

Returns the value of attribute balances.



63
64
65
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 63

def balances
  @balances
end

#bank_guid ⇒ Object

The bank identifier.



34
35
36
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 34

def bank_guid
  @bank_guid
end

#created_at ⇒ Object

ISO8601 datetime the record was created at.



40
41
42
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 40

def created_at
  @created_at
end

#customer_guid ⇒ Object

The customer identifier.



37
38
39
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 37

def customer_guid
  @customer_guid
end

#environment ⇒ Object

The environment that the external bank account is operating in; one of sandbox or production.



31
32
33
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 31

def environment
  @environment
end

#failure_code ⇒ Object

The failure code for failed transfers.



58
59
60
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 58

def failure_code
  @failure_code
end

#guid ⇒ Object

Auto-generated unique identifier for the account.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 19

def guid
  @guid
end

#name ⇒ Object

The name of the account.



22
23
24
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 22

def name
  @name
end

#pii ⇒ Object

The account holder information.



66
67
68
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 66

def pii
  @pii
end

#plaid_account_mask ⇒ Object

The account number mask for the account.



49
50
51
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 49

def 
  @plaid_account_mask
end

#plaid_account_name ⇒ Object

The name for the account.



52
53
54
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 52

def 
  @plaid_account_name
end

#plaid_institution_id ⇒ Object

The Plaid institution ID for the account.



46
47
48
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 46

def plaid_institution_id
  @plaid_institution_id
end

#state ⇒ Object

The state of the external bank account; one of storing, completed, failed, refresh_required, unverified, deleting, or deleted.



55
56
57
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 55

def state
  @state
end

#updated_at ⇒ Object

ISO8601 datetime the record was last updated at.



43
44
45
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 43

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 69

def self.attribute_map
  {
    :'guid' => :'guid',
    :'name' => :'name',
    :'asset' => :'asset',
    :'account_kind' => :'account_kind',
    :'environment' => :'environment',
    :'bank_guid' => :'bank_guid',
    :'customer_guid' => :'customer_guid',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'plaid_institution_id' => :'plaid_institution_id',
    :'plaid_account_mask' => :'plaid_account_mask',
    :'plaid_account_name' => :'plaid_account_name',
    :'state' => :'state',
    :'failure_code' => :'failure_code',
    :'balance_updated_at' => :'balance_updated_at',
    :'balances' => :'balances',
    :'pii' => :'pii'
  }
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



464
465
466
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 464

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 120

def self.openapi_nullable
  Set.new([
    :'bank_guid',
    :'customer_guid',
    :'plaid_institution_id',
    :'plaid_account_mask',
    :'plaid_account_name',
    :'failure_code',
    :'balance_updated_at',
    :'balances',
    :'pii'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 97

def self.openapi_types
  {
    :'guid' => :'String',
    :'name' => :'String',
    :'asset' => :'String',
    :'account_kind' => :'String',
    :'environment' => :'String',
    :'bank_guid' => :'String',
    :'customer_guid' => :'String',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'plaid_institution_id' => :'String',
    :'plaid_account_mask' => :'String',
    :'plaid_account_name' => :'String',
    :'state' => :'String',
    :'failure_code' => :'String',
    :'balance_updated_at' => :'Time',
    :'balances' => :'ExternalBankAccountBalancesBankModel',
    :'pii' => :'Array<ExternalBankAccountPiiInnerBankModel>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 427

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      guid == o.guid &&
      name == o.name &&
      asset == o.asset &&
       == o. &&
      environment == o.environment &&
      bank_guid == o.bank_guid &&
      customer_guid == o.customer_guid &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      plaid_institution_id == o.plaid_institution_id &&
       == o. &&
       == o. &&
      state == o.state &&
      failure_code == o.failure_code &&
      balance_updated_at == o.balance_updated_at &&
      balances == o.balances &&
      pii == o.pii
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



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 495

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



566
567
568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 566

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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 471

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


451
452
453
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 451

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



457
458
459
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 457

def hash
  [guid, name, asset, , environment, bank_guid, customer_guid, created_at, updated_at, plaid_institution_id, , , state, failure_code, balance_updated_at, balances, pii].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



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 222

def list_invalid_properties
  invalid_properties = Array.new
  if !@guid.nil? && @guid.to_s.length > 32
    invalid_properties.push('invalid value for "guid", the character length must be smaller than or equal to 32.')
  end

  if !@guid.nil? && @guid.to_s.length < 32
    invalid_properties.push('invalid value for "guid", the character length must be great than or equal to 32.')
  end

  if !@name.nil? && @name.to_s.length > 128
    invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 128.')
  end

  if !@name.nil? && @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if !@asset.nil? && @asset.to_s.length > 8
    invalid_properties.push('invalid value for "asset", the character length must be smaller than or equal to 8.')
  end

  if !@asset.nil? && @asset.to_s.length < 1
    invalid_properties.push('invalid value for "asset", the character length must be great than or equal to 1.')
  end

  if !@bank_guid.nil? && @bank_guid.to_s.length > 32
    invalid_properties.push('invalid value for "bank_guid", the character length must be smaller than or equal to 32.')
  end

  if !@bank_guid.nil? && @bank_guid.to_s.length < 32
    invalid_properties.push('invalid value for "bank_guid", the character length must be great than or equal to 32.')
  end

  if !@customer_guid.nil? && @customer_guid.to_s.length > 32
    invalid_properties.push('invalid value for "customer_guid", the character length must be smaller than or equal to 32.')
  end

  if !@customer_guid.nil? && @customer_guid.to_s.length < 32
    invalid_properties.push('invalid value for "customer_guid", the character length must be great than or equal to 32.')
  end

  if !@plaid_institution_id.nil? && @plaid_institution_id.to_s.length > 128
    invalid_properties.push('invalid value for "plaid_institution_id", the character length must be smaller than or equal to 128.')
  end

  if !@plaid_institution_id.nil? && @plaid_institution_id.to_s.length < 1
    invalid_properties.push('invalid value for "plaid_institution_id", the character length must be great than or equal to 1.')
  end

  if !@plaid_account_mask.nil? && @plaid_account_mask.to_s.length > 128
    invalid_properties.push('invalid value for "plaid_account_mask", the character length must be smaller than or equal to 128.')
  end

  if !@plaid_account_mask.nil? && @plaid_account_mask.to_s.length < 1
    invalid_properties.push('invalid value for "plaid_account_mask", the character length must be great than or equal to 1.')
  end

  if !@plaid_account_name.nil? && @plaid_account_name.to_s.length > 128
    invalid_properties.push('invalid value for "plaid_account_name", the character length must be smaller than or equal to 128.')
  end

  if !@plaid_account_name.nil? && @plaid_account_name.to_s.length < 1
    invalid_properties.push('invalid value for "plaid_account_name", the character length must be great 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



542
543
544
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 542

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



548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 548

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



536
537
538
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 536

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb', line 293

def valid?
  return false if !@guid.nil? && @guid.to_s.length > 32
  return false if !@guid.nil? && @guid.to_s.length < 32
  return false if !@name.nil? && @name.to_s.length > 128
  return false if !@name.nil? && @name.to_s.length < 1
  return false if !@asset.nil? && @asset.to_s.length > 8
  return false if !@asset.nil? && @asset.to_s.length < 1
  return false if !@bank_guid.nil? && @bank_guid.to_s.length > 32
  return false if !@bank_guid.nil? && @bank_guid.to_s.length < 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length > 32
  return false if !@customer_guid.nil? && @customer_guid.to_s.length < 32
  return false if !@plaid_institution_id.nil? && @plaid_institution_id.to_s.length > 128
  return false if !@plaid_institution_id.nil? && @plaid_institution_id.to_s.length < 1
  return false if !@plaid_account_mask.nil? && @plaid_account_mask.to_s.length > 128
  return false if !@plaid_account_mask.nil? && @plaid_account_mask.to_s.length < 1
  return false if !@plaid_account_name.nil? && @plaid_account_name.to_s.length > 128
  return false if !@plaid_account_name.nil? && @plaid_account_name.to_s.length < 1
  true
end