Class: Plaid::CraVoaReportAccount

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

Overview

VOA Report 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 = {}) ⇒ CraVoaReportAccount

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 125

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

  if attributes.key?(:'transactions_insights')
    self.transactions_insights = attributes[:'transactions_insights']
  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
end

Instance Attribute Details

#account_id ⇒ Object

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. 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/cra_voa_report_account.rb', line 20

def 
  @account_id
end

#balances ⇒ Object

Returns the value of attribute balances.



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

def balances
  @balances
end

#consumer_disputes ⇒ Object

The information about previously submitted valid dispute statements by the consumer



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

def consumer_disputes
  @consumer_disputes
end

#days_available ⇒ Object

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.



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

def days_available
  @days_available
end

#mask ⇒ Object

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.



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

def mask
  @mask
end

#name ⇒ Object

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



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

def name
  @name
end

#official_name ⇒ Object

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



34
35
36
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 34

def official_name
  @official_name
end

#owners ⇒ Object

Data returned by the financial institution about the account owner or owners.



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

def owners
  @owners
end

#ownership_type ⇒ Object

Returns the value of attribute ownership_type.



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

def ownership_type
  @ownership_type
end

#subtype ⇒ Object

Returns the value of attribute subtype.



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

def subtype
  @subtype
end

#transactions_insights ⇒ Object

Returns the value of attribute transactions_insights.



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

def transactions_insights
  @transactions_insights
end

#type ⇒ Object

Returns the value of attribute type.



36
37
38
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 36

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



91
92
93
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 91

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 73

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



278
279
280
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 278

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 96

def self.openapi_types
  {
    :'account_id' => :'String',
    :'balances' => :'CraVoaReportAccountBalances',
    :'consumer_disputes' => :'Array<ConsumerDispute>',
    :'mask' => :'String',
    :'name' => :'String',
    :'official_name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype',
    :'days_available' => :'Float',
    :'transactions_insights' => :'CraVoaReportTransactionsInsights',
    :'owners' => :'Array<Owner>',
    :'ownership_type' => :'OwnershipType'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 246

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



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 309

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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 380

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



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

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


265
266
267
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 271

def hash
  [, balances, consumer_disputes, mask, name, official_name, type, subtype, days_available, transactions_insights, owners, 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



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

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

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



356
357
358
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 356

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



362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 362

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



350
351
352
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 350

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



232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/plaid/models/cra_voa_report_account.rb', line 232

def valid?
  return false if @account_id.nil?
  return false if @balances.nil?
  return false if @consumer_disputes.nil?
  return false if @name.nil?
  return false if @type.nil?
  return false if @days_available.nil?
  return false if @transactions_insights.nil?
  return false if @owners.nil?
  true
end