Class: Plaid::BaseReportAccount

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

Overview

Base 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 = {}) ⇒ BaseReportAccount

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
190
191
 
# File 'lib/plaid/models/base_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::BaseReportAccount` 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::BaseReportAccount`. 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?(:'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?(:'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?(:'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

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

Instance Attribute Details

#account_insights ⇒ Object

Returns the value of attribute account_insights.



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

def 
  @account_insights
end

#balances ⇒ Object

Returns the value of attribute balances.



19
20
21
 
# File 'lib/plaid/models/base_report_account.rb', line 19

def balances
  @balances
end

#days_available ⇒ Object

The duration of transaction history available for this Item, typically defined as the time since the date of the earliest transaction in that account. Only returned by Base Report endpoints.



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

def days_available
  @days_available
end

#historical_balances ⇒ Object

Calculated data about the historical balances on the account. Only returned by Base Report endpoints and currently not supported by ‘brokerage` or `investment` accounts.



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

def historical_balances
  @historical_balances
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.



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

def mask
  @mask
end

#name ⇒ Object

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



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

def name
  @name
end

#official_name ⇒ Object

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



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

def official_name
  @official_name
end

#owners ⇒ Object

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.



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

def owners
  @owners
end

#ownership_type ⇒ Object

Returns the value of attribute ownership_type.



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

def ownership_type
  @ownership_type
end

#subtype ⇒ Object

Returns the value of attribute subtype.



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

def subtype
  @subtype
end

#transactions ⇒ Object

Transaction history associated with the account. Only returned by Base Report endpoints. Transaction history returned by endpoints such as ‘/transactions/get` or `/investments/transactions/get` will be returned in the top-level `transactions` field instead.



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

def transactions
  @transactions
end

#type ⇒ Object

Returns the value of attribute type.



30
31
32
 
# File 'lib/plaid/models/base_report_account.rb', line 30

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/base_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/base_report_account.rb', line 73

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



270
271
272
 
# File 'lib/plaid/models/base_report_account.rb', line 270

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/base_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/base_report_account.rb', line 96

def self.openapi_types
  {
    :'balances' => :'BaseReportAccountBalances',
    :'mask' => :'String',
    :'name' => :'String',
    :'official_name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype',
    :'days_available' => :'Float',
    :'transactions' => :'Array<BaseReportTransaction>',
    :'owners' => :'Array<Owner>',
    :'ownership_type' => :'OwnershipType',
    :'historical_balances' => :'Array<HistoricalBalance>',
    :'account_insights' => :'BaseReportAccountInsights'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/plaid/models/base_report_account.rb', line 238

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



301
302
303
304
305
306
307
308
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
 
# File 'lib/plaid/models/base_report_account.rb', line 301

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



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/plaid/models/base_report_account.rb', line 372

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/plaid/models/base_report_account.rb', line 277

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


257
258
259
 
# File 'lib/plaid/models/base_report_account.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/plaid/models/base_report_account.rb', line 263

def hash
  [balances, mask, name, official_name, type, subtype, days_available, transactions, owners, ownership_type, historical_balances, ].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



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

def list_invalid_properties
  invalid_properties = Array.new
  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

  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



348
349
350
 
# File 'lib/plaid/models/base_report_account.rb', line 348

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



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

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



342
343
344
 
# File 'lib/plaid/models/base_report_account.rb', line 342

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



226
227
228
229
230
231
232
233
234
 
# File 'lib/plaid/models/base_report_account.rb', line 226

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