Class: MoneyKit::AccountIdentity

Inherits:
Object
  • Object
show all
Defined in:
lib/moneykit/models/account_identity.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountIdentity

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/moneykit/models/account_identity.rb', line 93

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MoneyKit::AccountIdentity` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `MoneyKit::AccountIdentity`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'account_id')
    self. = attributes[:'account_id']
  else
    self. = nil
  end

  if attributes.key?(:'account_type')
    self. = attributes[:'account_type']
  else
    self. = nil
  end

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

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

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

  if attributes.key?(:'balances')
    self.balances = attributes[:'balances']
  else
    self.balances = nil
  end

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

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

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

Instance Attribute Details

#account_id ⇒ Object

MoneyKit’s unique ID for the account. <p>The account_id is distinct from the institution’s account number. For accounts that may change account numbers from time to time, such as credit cards, MoneyKit attempts to keep the account_id constant. However, if MoneyKit can’t reconcile the new account data with the old data, the account_id may change.



19
20
21
 
# File 'lib/moneykit/models/account_identity.rb', line 19

def 
  @account_id
end

#account_mask ⇒ Object

The last four characters (usually digits) of the account number. Note that this mask may be non-unique between accounts.



31
32
33
 
# File 'lib/moneykit/models/account_identity.rb', line 31

def 
  @account_mask
end

#account_type ⇒ Object

See <a href=/pages/account_types>Account Types</a> for an explanation of account types. Account types are dot-prefixed with one of depository, investment, liability, or other; or the value is unknown. <p>**Balances for liability accounts are reversed:** negative balances (the amount owed) are reported as positive values. For all other types of accounts, a negative balance indicates the amount owed.



22
23
24
 
# File 'lib/moneykit/models/account_identity.rb', line 22

def 
  @account_type
end

#balances ⇒ Object

The balance of funds for this account. Note that balances are typically cached and may lag behind actual values at the institution. To update balances, please use the <a href=#operation/refresh_products>/products</a> endpoint. <p>Some accounts, particularly investment accounts, may show balances that are temporarily inconsistent around the time of a trade or transfer. These discrepancies occur because of a delay between the time a trade or transfer is initiated and the time the institution reflects its effect on the account balance, and will disappear over time, typically within 1-2 business days.



34
35
36
 
# File 'lib/moneykit/models/account_identity.rb', line 34

def balances
  @balances
end

#closed ⇒ Object

True if this account is closed.



40
41
42
 
# File 'lib/moneykit/models/account_identity.rb', line 40

def closed
  @closed
end

#name ⇒ Object

The account name, according to the institution.



25
26
27
 
# File 'lib/moneykit/models/account_identity.rb', line 25

def name
  @name
end

#nickname ⇒ Object

The account nickname, if available.



28
29
30
 
# File 'lib/moneykit/models/account_identity.rb', line 28

def nickname
  @nickname
end

#original_id ⇒ Object

The original ID of this account, if supplied (by you) during an import.



37
38
39
 
# File 'lib/moneykit/models/account_identity.rb', line 37

def original_id
  @original_id
end

#owners ⇒ Object

A list of owners associated with the account.



43
44
45
 
# File 'lib/moneykit/models/account_identity.rb', line 43

def owners
  @owners
end

Class Method Details

._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/moneykit/models/account_identity.rb', line 301

def self._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.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



61
62
63
 
# File 'lib/moneykit/models/account_identity.rb', line 61

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/moneykit/models/account_identity.rb', line 66

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/moneykit/models/account_identity.rb', line 46

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'account_type' => :'account_type',
    :'name' => :'name',
    :'nickname' => :'nickname',
    :'account_mask' => :'account_mask',
    :'balances' => :'balances',
    :'original_id' => :'original_id',
    :'closed' => :'closed',
    :'owners' => :'owners'
  }
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/moneykit/models/account_identity.rb', line 277

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/moneykit/models/account_identity.rb', line 86

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/moneykit/models/account_identity.rb', line 71

def self.openapi_types
  {
    :'account_id' => :'String',
    :'account_type' => :'String',
    :'name' => :'String',
    :'nickname' => :'String',
    :'account_mask' => :'String',
    :'balances' => :'AccountBalances',
    :'original_id' => :'String',
    :'closed' => :'Boolean',
    :'owners' => :'Array<Owner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/moneykit/models/account_identity.rb', line 248

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
       == o. &&
      name == o.name &&
      nickname == o.nickname &&
       == o. &&
      balances == o.balances &&
      original_id == o.original_id &&
      closed == o.closed &&
      owners == o.owners
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/moneykit/models/account_identity.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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/moneykit/models/account_identity.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



270
271
272
 
# File 'lib/moneykit/models/account_identity.rb', line 270

def hash
  [, , name, nickname, , balances, original_id, closed, owners].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



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
 
# File 'lib/moneykit/models/account_identity.rb', line 158

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @account_id.nil?
    invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
  end

  if @account_type.nil?
    invalid_properties.push('invalid value for "account_type", account_type cannot be nil.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @balances.nil?
    invalid_properties.push('invalid value for "balances", balances 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/moneykit/models/account_identity.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/moneykit/models/account_identity.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/moneykit/models/account_identity.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



186
187
188
189
190
191
192
193
194
 
# File 'lib/moneykit/models/account_identity.rb', line 186

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @account_id.nil?
  return false if @account_type.nil?
  return false if @name.nil?
  return false if @balances.nil?
  return false if @owners.nil?
  true
end