Class: MoneyKit::LinkCommon

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkCommon

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
192
193
194
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/moneykit/models/link_common.rb', line 135

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#available_products ⇒ Object

A list of products that could be added to this link. Products can be added to (and removed from) an existing link by creating a new <a href=#operation/create_link_session>link-session</a> and supplying the existing_link_id with a new set of products.



55
56
57
 
# File 'lib/moneykit/models/link_common.rb', line 55

def available_products
  @available_products
end

#error_code ⇒ Object

The type of error, if the link is in the error state. See <a href=/pages/errors>Errors</a> for an explanation of error codes.



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

def error_code
  @error_code
end

#institution_avatar ⇒ Object

An avatar image for the link’s institution.



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

def institution_avatar
  @institution_avatar
end

#institution_id ⇒ Object

The unique ID for the institution this link is connected to.



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

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The institution name this link is connected to.



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

def institution_name
  @institution_name
end

#last_synced_at ⇒ Object

(Deprecated) An ISO-8601 timestamp indicating the last time that the link was updated.



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

def last_synced_at
  @last_synced_at
end

#link_id ⇒ Object

The unique ID for this link.



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

def link_id
  @link_id
end

#link_tags ⇒ Object

Arbitrary strings used to describe this link.



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

def link_tags
  @link_tags
end

#products ⇒ Object

The granted products available for this link.



52
53
54
 
# File 'lib/moneykit/models/link_common.rb', line 52

def products
  @products
end

#provider ⇒ Object

The provider that most recently facilitated the creation of this link. Note that MoneyKit may switch providers if necessary to provide continuous access to the institution. Not all providers are automatically available or usable; provider selection is dynamic and depends on many factors.



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

def provider
  @provider
end

#state ⇒ Object

The current state of this link. Links that are not yet connected, or which require reconnection, will be in one of the non-connected states. Please note that recently deleted links can be fetched by this function (and will have a state of deleted); however, MoneyKit completely removes deleted links 90 days after deletion, so older deleted links will not be seen after this time.



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

def state
  @state
end

#tags ⇒ Object

DEPRECATED; use link_tags instead



46
47
48
 
# File 'lib/moneykit/models/link_common.rb', line 46

def tags
  @tags
end

#webhook ⇒ Object

The webhook url assigned to this link.



49
50
51
 
# File 'lib/moneykit/models/link_common.rb', line 49

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



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/moneykit/models/link_common.rb', line 418

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



99
100
101
 
# File 'lib/moneykit/models/link_common.rb', line 99

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



104
105
106
 
# File 'lib/moneykit/models/link_common.rb', line 104

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/moneykit/models/link_common.rb', line 80

def self.attribute_map
  {
    :'link_id' => :'link_id',
    :'institution_id' => :'institution_id',
    :'institution_name' => :'institution_name',
    :'institution_avatar' => :'institution_avatar',
    :'state' => :'state',
    :'error_code' => :'error_code',
    :'last_synced_at' => :'last_synced_at',
    :'provider' => :'provider',
    :'link_tags' => :'link_tags',
    :'tags' => :'tags',
    :'webhook' => :'webhook',
    :'products' => :'products',
    :'available_products' => :'available_products'
  }
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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/moneykit/models/link_common.rb', line 394

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



128
129
130
131
 
# File 'lib/moneykit/models/link_common.rb', line 128

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

.openapi_types ⇒ Object

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/moneykit/models/link_common.rb', line 109

def self.openapi_types
  {
    :'link_id' => :'String',
    :'institution_id' => :'String',
    :'institution_name' => :'String',
    :'institution_avatar' => :'String',
    :'state' => :'PublicLinkState',
    :'error_code' => :'PublicLinkError',
    :'last_synced_at' => :'Time',
    :'provider' => :'Provider',
    :'link_tags' => :'Array<String>',
    :'tags' => :'Array<String>',
    :'webhook' => :'String',
    :'products' => :'LinkProducts',
    :'available_products' => :'Array<Product>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/moneykit/models/link_common.rb', line 361

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      link_id == o.link_id &&
      institution_id == o.institution_id &&
      institution_name == o.institution_name &&
      institution_avatar == o.institution_avatar &&
      state == o.state &&
      error_code == o.error_code &&
      last_synced_at == o.last_synced_at &&
      provider == o.provider &&
      link_tags == o.link_tags &&
      tags == o.tags &&
      webhook == o.webhook &&
      products == o.products &&
      available_products == o.available_products
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



489
490
491
492
493
494
495
496
497
498
499
500
501
 
# File 'lib/moneykit/models/link_common.rb', line 489

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


381
382
383
 
# File 'lib/moneykit/models/link_common.rb', line 381

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



387
388
389
 
# File 'lib/moneykit/models/link_common.rb', line 387

def hash
  [link_id, institution_id, institution_name, institution_avatar, state, error_code, last_synced_at, provider, link_tags, tags, webhook, products, available_products].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



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
260
261
262
 
# File 'lib/moneykit/models/link_common.rb', line 226

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

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

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

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

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

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

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

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



465
466
467
 
# File 'lib/moneykit/models/link_common.rb', line 465

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



471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/moneykit/models/link_common.rb', line 471

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



459
460
461
 
# File 'lib/moneykit/models/link_common.rb', line 459

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



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/moneykit/models/link_common.rb', line 266

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @link_id.nil?
  return false if @institution_id.nil?
  return false if @institution_name.nil?
  return false if @institution_avatar.nil?
  return false if @state.nil?
  return false if @provider.nil?
  return false if @products.nil?
  return false if @available_products.nil?
  true
end