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



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

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
  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::LinkCommon`. 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?(:'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?(:'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

Returns the value of attribute available_products.



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

def available_products
  @available_products
end

#error_code ⇒ Object

Returns the value of attribute error_code.



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

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.



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

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

#products ⇒ Object

Returns the value of attribute products.



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

def products
  @products
end

#provider ⇒ Object

Returns the value of attribute provider.



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

def provider
  @provider
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#tags ⇒ Object

Returns the value of attribute tags.



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

def tags
  @tags
end

#webhook ⇒ Object

The webhook url assigned to this link.



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

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



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
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/moneykit/models/link_common.rb', line 314

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_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/moneykit/models/link_common.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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',
    :'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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/moneykit/models/link_common.rb', line 290

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



112
113
114
115
 
# File 'lib/moneykit/models/link_common.rb', line 112

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/moneykit/models/link_common.rb', line 94

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',
    :'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



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/moneykit/models/link_common.rb', line 258

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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/moneykit/models/link_common.rb', line 385

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


277
278
279
 
# File 'lib/moneykit/models/link_common.rb', line 277

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



283
284
285
 
# File 'lib/moneykit/models/link_common.rb', line 283

def hash
  [link_id, institution_id, institution_name, institution_avatar, state, error_code, last_synced_at, provider, 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



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/moneykit/models/link_common.rb', line 203

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



361
362
363
 
# File 'lib/moneykit/models/link_common.rb', line 361

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



367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/moneykit/models/link_common.rb', line 367

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



355
356
357
 
# File 'lib/moneykit/models/link_common.rb', line 355

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



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/moneykit/models/link_common.rb', line 243

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