Class: Plaid::AssetDetail

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

Overview

Details about an asset.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AssetDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash



118
119
120
121
122
123
124
125
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
 
# File 'lib/plaid/models/asset_detail.rb', line 118

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#asset_account_identifier ⇒ Object

A unique alphanumeric string identifying an asset.



23
24
25
 
# File 'lib/plaid/models/asset_detail.rb', line 23

def 
  @asset_account_identifier
end

#asset_as_of_date ⇒ Object

Account Report As of Date / Create Date. Format YYYY-MM-DD



26
27
28
 
# File 'lib/plaid/models/asset_detail.rb', line 26

def asset_as_of_date
  @asset_as_of_date
end

#asset_available_balance_amount ⇒ Object

Asset Account Available Balance.



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

def asset_available_balance_amount
  @asset_available_balance_amount
end

#asset_current_balance_amount ⇒ Object

A vendor created unique Identifier



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

def asset_current_balance_amount
  @asset_current_balance_amount
end

#asset_days_requested_count ⇒ Object

The Number of days requested made to the Financial Institution. Example When looking for 3 months of data from the FI, pass in 90 days.



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

def asset_days_requested_count
  @asset_days_requested_count
end

#asset_description ⇒ Object

A text description that further defines the Asset. This could be used to describe the shares associated with the stocks, bonds or mutual funds, retirement funds or business owned that the borrower has disclosed (named) as an asset.



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

def asset_description
  @asset_description
end

#asset_ownership_type ⇒ Object

Ownership type of the asset account.



46
47
48
 
# File 'lib/plaid/models/asset_detail.rb', line 46

def asset_ownership_type
  @asset_ownership_type
end

#asset_type ⇒ Object

Returns the value of attribute asset_type.



37
38
39
 
# File 'lib/plaid/models/asset_detail.rb', line 37

def asset_type
  @asset_type
end

#asset_type_additional_description ⇒ Object

Additional Asset Decription some examples are Investment Tax-Deferred , Loan, 401K, 403B, Checking, Money Market, Credit Card,ROTH,529,Biller,ROLLOVER,CD,Savings,Investment Taxable, IRA, Mortgage, Line Of Credit.



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

def asset_type_additional_description
  @asset_type_additional_description
end

#asset_unique_identifier ⇒ Object

A vendor created unique Identifier.



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

def asset_unique_identifier
  @asset_unique_identifier
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/plaid/models/asset_detail.rb', line 71

def self.attribute_map
  {
    :'asset_unique_identifier' => :'AssetUniqueIdentifier',
    :'asset_account_identifier' => :'AssetAccountIdentifier',
    :'asset_as_of_date' => :'AssetAsOfDate',
    :'asset_description' => :'AssetDescription',
    :'asset_available_balance_amount' => :'AssetAvailableBalanceAmount',
    :'asset_current_balance_amount' => :'AssetCurrentBalanceAmount',
    :'asset_type' => :'AssetType',
    :'asset_type_additional_description' => :'AssetTypeAdditionalDescription',
    :'asset_days_requested_count' => :'AssetDaysRequestedCount',
    :'asset_ownership_type' => :'AssetOwnershipType'
  }
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



252
253
254
 
# File 'lib/plaid/models/asset_detail.rb', line 252

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
112
113
114
 
# File 'lib/plaid/models/asset_detail.rb', line 108

def self.openapi_nullable
  Set.new([
    :'asset_description',
    :'asset_type_additional_description',
    :'asset_ownership_type'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/plaid/models/asset_detail.rb', line 92

def self.openapi_types
  {
    :'asset_unique_identifier' => :'String',
    :'asset_account_identifier' => :'String',
    :'asset_as_of_date' => :'String',
    :'asset_description' => :'String',
    :'asset_available_balance_amount' => :'Float',
    :'asset_current_balance_amount' => :'Float',
    :'asset_type' => :'AssetType',
    :'asset_type_additional_description' => :'String',
    :'asset_days_requested_count' => :'Integer',
    :'asset_ownership_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/plaid/models/asset_detail.rb', line 222

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      asset_unique_identifier == o.asset_unique_identifier &&
       == o. &&
      asset_as_of_date == o.asset_as_of_date &&
      asset_description == o.asset_description &&
      asset_available_balance_amount == o.asset_available_balance_amount &&
      asset_current_balance_amount == o.asset_current_balance_amount &&
      asset_type == o.asset_type &&
      asset_type_additional_description == o.asset_type_additional_description &&
      asset_days_requested_count == o.asset_days_requested_count &&
      asset_ownership_type == o.asset_ownership_type
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



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
314
315
316
317
318
319
320
 
# File 'lib/plaid/models/asset_detail.rb', line 283

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



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/plaid/models/asset_detail.rb', line 354

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/plaid/models/asset_detail.rb', line 259

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


239
240
241
 
# File 'lib/plaid/models/asset_detail.rb', line 239

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



245
246
247
 
# File 'lib/plaid/models/asset_detail.rb', line 245

def hash
  [asset_unique_identifier, , asset_as_of_date, asset_description, asset_available_balance_amount, asset_current_balance_amount, asset_type, asset_type_additional_description, asset_days_requested_count, asset_ownership_type].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



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

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

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

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

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

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

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

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



330
331
332
 
# File 'lib/plaid/models/asset_detail.rb', line 330

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



336
337
338
339
340
341
342
343
344
345
346
347
348
 
# File 'lib/plaid/models/asset_detail.rb', line 336

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



324
325
326
 
# File 'lib/plaid/models/asset_detail.rb', line 324

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



209
210
211
212
213
214
215
216
217
218
 
# File 'lib/plaid/models/asset_detail.rb', line 209

def valid?
  return false if @asset_unique_identifier.nil?
  return false if @asset_account_identifier.nil?
  return false if @asset_as_of_date.nil?
  return false if @asset_available_balance_amount.nil?
  return false if @asset_current_balance_amount.nil?
  return false if @asset_type.nil?
  return false if @asset_days_requested_count.nil?
  true
end