Class: MoneyKit::PlaidCompatible::AccountBalance

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb

Overview

A set of fields describing the balance for an account. Balance information may be cached unless the balance object was returned by ‘/accounts/balance/get`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountBalance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 67

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError,
          'The input argument (attributes) must be a hash in `MoneyKit::PlaidCompatible::AccountBalance` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    unless self.class.attribute_map.key?(k.to_sym)
      raise ArgumentError,
            "`#{k}` is not a valid attribute in `MoneyKit::PlaidCompatible::AccountBalance`. 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
  end

  self.available = attributes[:available] if attributes.key?(:available)

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

  self.limit = attributes[:limit] if attributes.key?(:limit)

  return unless attributes.key?(:iso_currency_code)

  self.iso_currency_code = attributes[:iso_currency_code]
end

Instance Attribute Details

#available ⇒ Object

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`.



19
20
21
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 19

def available
  @available
end

#current ⇒ Object

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`.



22
23
24
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 22

def current
  @current
end

#iso_currency_code ⇒ Object

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



28
29
30
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 28

def iso_currency_code
  @iso_currency_code
end

#limit ⇒ Object

For ‘credit`-type accounts, this represents the credit limit. For `depository`-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe. In North America, this field is typically only available for `credit`-type accounts.



25
26
27
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 25

def limit
  @limit
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 31

def self.attribute_map
  {
    'available': :available,
    'current': :current,
    'limit': :limit,
    'iso_currency_code': :iso_currency_code
  }
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



133
134
135
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 133

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



56
57
58
59
60
61
62
63
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 56

def self.openapi_nullable
  Set.new(%i[
            available
            current
            limit
            iso_currency_code
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 46

def self.openapi_types
  {
    'available': :Float,
    'current': :Float,
    'limit': :Float,
    'iso_currency_code': :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



108
109
110
111
112
113
114
115
116
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 108

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    available == other.available &&
    current == other.current &&
    limit == other.limit &&
    iso_currency_code == other.iso_currency_code
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



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
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 166

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 = MoneyKit::PlaidCompatible.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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 237

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 140

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      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)
        send("#{key}=", attributes[self.class.attribute_map[key]].map do |v|
                          _deserialize(::Regexp.last_match(1), v)
                        end)
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


120
121
122
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 120

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



126
127
128
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 126

def hash
  [available, current, limit, iso_currency_code].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



96
97
98
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 96

def list_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



213
214
215
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 213

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



219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 219

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



207
208
209
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 207

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



102
103
104
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_balance.rb', line 102

def valid?
  true
end