Class: Plaid::CraVoaReportAccountBalances

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

Overview

VOA Report information about an account’s balances.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CraVoaReportAccountBalances

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 90

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

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

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

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

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

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

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

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

Instance Attribute Details

#availableObject

The amount of funds available to be withdrawn from the account, as determined by the financial institution. For ‘credit`-type accounts, the `available` balance typically equals the `limit` less the `current` balance, less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance typically equals the `current` balance less any pending outflows plus any pending inflows. For `depository`-type accounts, the `available` balance does not include the overdraft limit. For `investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the `available` balance is the total cash available to withdraw as presented by the institution. Note that not all institutions calculate the `available` balance. In the event that `available` balance is unavailable, Plaid will return an `available` balance value of `null`. Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by `/accounts/balance/get`. If `current` is `null` this field is guaranteed not to be `null`.



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

def available
  @available
end

#average_balance_30_daysObject

The average balance in the account over the last 30 days. Calculated using the derived historical balances.



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

def average_balance_30_days
  @average_balance_30_days
end

#average_balance_60_daysObject

The average balance in the account over the last 60 days. Calculated using the derived historical balances.



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

def average_balance_60_days
  @average_balance_60_days
end

#currentObject

The total amount of funds in or owed by the account. For ‘credit`-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder. For `loan`-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (`ins_116944`). For Sallie Mae student loans, the account’s balance includes both principal and any outstanding interest. For ‘investment`-type accounts (or `brokerage`-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution. Note that balance information may be cached unless the value was returned by `/accounts/balance/get`; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the `available` balance as provided by `/accounts/balance/get`. When returned by `/accounts/balance/get`, this field may be `null`. When this happens, `available` is guaranteed not to be `null`.



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

def current
  @current
end

#historical_balancesObject

Calculated data about the historical balances on the account.



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

def historical_balances
  @historical_balances
end

#iso_currency_codeObject

The ISO-4217 currency code of the balance. Always null if ‘unofficial_currency_code` is non-null.



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

def iso_currency_code
  @iso_currency_code
end

#nsf_overdraft_transactions_countObject

The number of NSF and overdraft fee transactions in the time range for the report in the given account.



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

def nsf_overdraft_transactions_count
  @nsf_overdraft_transactions_count
end

#unofficial_currency_codeObject

The unofficial currency code associated with the balance. Always null if ‘iso_currency_code` is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `unofficial_currency_code`s.



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

def unofficial_currency_code
  @unofficial_currency_code
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



58
59
60
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 44

def self.attribute_map
  {
    :'available' => :'available',
    :'current' => :'current',
    :'iso_currency_code' => :'iso_currency_code',
    :'unofficial_currency_code' => :'unofficial_currency_code',
    :'historical_balances' => :'historical_balances',
    :'average_balance_30_days' => :'average_balance_30_days',
    :'average_balance_60_days' => :'average_balance_60_days',
    :'nsf_overdraft_transactions_count' => :'nsf_overdraft_transactions_count'
  }
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



191
192
193
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 191

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

.openapi_nullableObject

List of attributes with nullable: true



77
78
79
80
81
82
83
84
85
86
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 77

def self.openapi_nullable
  Set.new([
    :'available',
    :'current',
    :'iso_currency_code',
    :'unofficial_currency_code',
    :'average_balance_30_days',
    :'average_balance_60_days',
  ])
end

.openapi_typesObject

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 63

def self.openapi_types
  {
    :'available' => :'Float',
    :'current' => :'Float',
    :'iso_currency_code' => :'String',
    :'unofficial_currency_code' => :'String',
    :'historical_balances' => :'Array<CraVoaReportAccountHistoricalBalance>',
    :'average_balance_30_days' => :'Float',
    :'average_balance_60_days' => :'Float',
    :'nsf_overdraft_transactions_count' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 163

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      available == o.available &&
      current == o.current &&
      iso_currency_code == o.iso_currency_code &&
      unofficial_currency_code == o.unofficial_currency_code &&
      historical_balances == o.historical_balances &&
      average_balance_30_days == o.average_balance_30_days &&
      average_balance_60_days == o.average_balance_60_days &&
      nsf_overdraft_transactions_count == o.nsf_overdraft_transactions_count
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



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

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



293
294
295
296
297
298
299
300
301
302
303
304
305
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 293

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 198

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


178
179
180
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 178

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



184
185
186
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 184

def hash
  [available, current, iso_currency_code, unofficial_currency_code, historical_balances, average_balance_30_days, average_balance_60_days, nsf_overdraft_transactions_count].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 140

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

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



269
270
271
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 269

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



275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 275

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



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

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



155
156
157
158
159
# File 'lib/plaid/models/cra_voa_report_account_balances.rb', line 155

def valid?
  return false if @historical_balances.nil?
  return false if @nsf_overdraft_transactions_count.nil?
  true
end