Class: MoneyKit::PlaidCompatible::AccountBase

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

Overview

A single account at a financial institution.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountBase

Initializes the object



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 73

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

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

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

  if attributes.key?(:'subtype')
    self.subtype = attributes[:'subtype']
  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. The account_id can also change if the access_token is deleted and the same credentials that were used to generate that access_token are used to generate a new access_token on a later date. In that case, the new account_id will be different from the old account_id. 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_compatible/money_kit_plaid_compatible/models/account_base.rb', line 20

def 
  @account_id
end

#balances ⇒ Object

Returns the value of attribute balances.



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

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



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

def mask
  @mask
end

#name ⇒ Object

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



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

def name
  @name
end

#subtype ⇒ Object

Returns the value of attribute subtype.



32
33
34
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 32

def subtype
  @subtype
end

#type ⇒ Object

Returns the value of attribute type.



30
31
32
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 30

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 47

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 35

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'balances' => :'balances',
    :'mask' => :'mask',
    :'name' => :'name',
    :'type' => :'type',
    :'subtype' => :'subtype'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



172
173
174
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 172

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



64
65
66
67
68
69
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 64

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 52

def self.openapi_types
  {
    :'account_id' => :'String',
    :'balances' => :'AccountBalance',
    :'mask' => :'String',
    :'name' => :'String',
    :'type' => :'AccountType',
    :'subtype' => :'AccountSubtype'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 146

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      balances == o.balances &&
      mask == o.mask &&
      name == o.name &&
      type == o.type &&
      subtype == o.subtype
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 202

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 273

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 179

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)
      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

See Also:

  • `==` method


159
160
161
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 159

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



165
166
167
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 165

def hash
  [, balances, mask, name, type, subtype].hash
end

#list_invalid_properties ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 113

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 @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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



249
250
251
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 249

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 255

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



243
244
245
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 243

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



136
137
138
139
140
141
142
 
# File 'lib/plaid_compatible/money_kit_plaid_compatible/models/account_base.rb', line 136

def valid?
  return false if @account_id.nil?
  return false if @balances.nil?
  return false if @name.nil?
  return false if @type.nil?
  true
end