Class: Plaid::AccountAssets

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

Overview

Asset information about an account

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountAssets

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_idObject

Plaid’s unique identifier for the account. This value will not change unless Plaid can’t reconcile the account with the data returned by the financial institution. This may occur, for example, when the name of the account changes. If this happens a new ‘account_id` will be assigned to the account. The `account_id` can also change if the `access_token` is deleted and the same credentials that were used to generate that `access_token` are used to generate a new `access_token` on a later date. In that case, the new `account_id` will be different from the old `account_id`. If an account with a specific `account_id` disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API. Like all Plaid identifiers, the `account_id` is case sensitive.



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

def 
  @account_id
end

#balancesObject

Returns the value of attribute balances.



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

def balances
  @balances
end

#days_availableObject

The duration of transaction history available within this report for this Item, typically defined as the time since the date of the earliest transaction in that account.



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

def days_available
  @days_available
end

#historical_balancesObject

Calculated data about the historical balances on the account.



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

def historical_balances
  @historical_balances
end

#investmentsObject

Returns the value of attribute investments.



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

def investments
  @investments
end

#maskObject

The last 2-4 alphanumeric characters of an account’s official account number. Note that the mask may be non-unique between an Item’s accounts, and it may also not match the mask that the bank displays to the user.



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

def mask
  @mask
end

#nameObject

The name of the account, either assigned by the user or by the financial institution itself



28
29
30
# File 'lib/plaid/models/account_assets.rb', line 28

def name
  @name
end

#official_nameObject

The official name of the account as given by the financial institution



31
32
33
# File 'lib/plaid/models/account_assets.rb', line 31

def official_name
  @official_name
end

#ownersObject

Data returned by the financial institution about the account owner or owners.For business accounts, the name reported may be either the name of the individual or the name of the business, depending on the institution. Multiple owners on a single account will be represented in the same ‘owner` object, not in multiple owner objects within the array. In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](plaid.com/docs/api/versioning/#version-2019-05-29)



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

def owners
  @owners
end

#ownership_typeObject

Returns the value of attribute ownership_type.



54
55
56
# File 'lib/plaid/models/account_assets.rb', line 54

def ownership_type
  @ownership_type
end

#persistent_account_idObject

A unique and persistent identifier for accounts that can be used to trace multiple instances of the same account across different Items for depository accounts. This is currently an opt-in field and only supported for Chase Items.



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

def 
  @persistent_account_id
end

#subtypeObject

Returns the value of attribute subtype.



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

def subtype
  @subtype
end

#transactionsObject

Transaction history associated with the account.



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

def transactions
  @transactions
end

#typeObject

Returns the value of attribute type.



33
34
35
# File 'lib/plaid/models/account_assets.rb', line 33

def type
  @type
end

#verification_statusObject

The current verification status of an Auth Item initiated through Automated or Manual micro-deposits. Returned for Auth Items only. ‘pending_automatic_verification`: The Item is pending automatic verification `pending_manual_verification`: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit. `automatically_verified`: The Item has successfully been automatically verified `manually_verified`: The Item has successfully been manually verified `verification_expired`: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link. `verification_failed`: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link. `database_matched`: The Item has successfully been verified using Plaid’s data sources. Note: Database Match is currently a beta feature, please contact your account manager for more information.



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

def verification_status
  @verification_status
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



103
104
105
# File 'lib/plaid/models/account_assets.rb', line 103

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'lib/plaid/models/account_assets.rb', line 82

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'balances' => :'balances',
    :'mask' => :'mask',
    :'name' => :'name',
    :'official_name' => :'official_name',
    :'type' => :'type',
    :'subtype' => :'subtype',
    :'verification_status' => :'verification_status',
    :'persistent_account_id' => :'persistent_account_id',
    :'days_available' => :'days_available',
    :'transactions' => :'transactions',
    :'investments' => :'investments',
    :'owners' => :'owners',
    :'ownership_type' => :'ownership_type',
    :'historical_balances' => :'historical_balances'
  }
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



322
323
324
# File 'lib/plaid/models/account_assets.rb', line 322

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

.openapi_nullableObject

List of attributes with nullable: true



129
130
131
132
133
134
135
136
# File 'lib/plaid/models/account_assets.rb', line 129

def self.openapi_nullable
  Set.new([
    :'mask',
    :'official_name',
    :'subtype',
    :'ownership_type',
  ])
end

.openapi_typesObject

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# File 'lib/plaid/models/account_assets.rb', line 108

def self.openapi_types
  {
    :'account_id' => :'String',
    :'balances' => :'AssetReportAccountBalance',
    :'mask' => :'String',
    :'name' => :'String',
    :'official_name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype',
    :'verification_status' => :'String',
    :'persistent_account_id' => :'String',
    :'days_available' => :'Float',
    :'transactions' => :'Array<AssetReportTransaction>',
    :'investments' => :'AssetReportInvestments',
    :'owners' => :'Array<Owner>',
    :'ownership_type' => :'OwnershipType',
    :'historical_balances' => :'Array<HistoricalBalance>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/plaid/models/account_assets.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      balances == o.balances &&
      mask == o.mask &&
      name == o.name &&
      official_name == o.official_name &&
      type == o.type &&
      subtype == o.subtype &&
      verification_status == o.verification_status &&
       == o. &&
      days_available == o.days_available &&
      transactions == o.transactions &&
      investments == o.investments &&
      owners == o.owners &&
      ownership_type == o.ownership_type &&
      historical_balances == o.historical_balances
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



353
354
355
356
357
358
359
360
361
362
363
364
365
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
# File 'lib/plaid/models/account_assets.rb', line 353

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



424
425
426
427
428
429
430
431
432
433
434
435
436
# File 'lib/plaid/models/account_assets.rb', line 424

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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/plaid/models/account_assets.rb', line 329

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


309
310
311
# File 'lib/plaid/models/account_assets.rb', line 309

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



315
316
317
# File 'lib/plaid/models/account_assets.rb', line 315

def hash
  [, balances, mask, name, official_name, type, subtype, verification_status, , days_available, transactions, investments, owners, ownership_type, historical_balances].hash
end

#list_invalid_propertiesObject

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

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 @balances.nil?
    invalid_properties.push('invalid value for "balances", balances cannot be nil.')
  end

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

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

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

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

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



400
401
402
# File 'lib/plaid/models/account_assets.rb', line 400

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/plaid/models/account_assets.rb', line 406

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



394
395
396
# File 'lib/plaid/models/account_assets.rb', line 394

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



261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/plaid/models/account_assets.rb', line 261

def valid?
  return false if @account_id.nil?
  return false if @balances.nil?
  return false if @name.nil?
  return false if @type.nil?
  verification_status_validator = EnumAttributeValidator.new('String', ["automatically_verified", "pending_automatic_verification", "pending_manual_verification", "manually_verified", "verification_expired", "verification_failed", "database_matched"])
  return false unless verification_status_validator.valid?(@verification_status)
  return false if @days_available.nil?
  return false if @transactions.nil?
  return false if @owners.nil?
  return false if @historical_balances.nil?
  true
end