Class: MoneyKit::Link

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

Overview

Details of the new link.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Link

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

def initialize(attributes = {})
  unless attributes.is_a?(Hash)
    raise ArgumentError, 'The input argument (attributes) must be a hash in `MoneyKit::Link` 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::Link`. 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.link_id = attributes[:link_id] if attributes.key?(:link_id)

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

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

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

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

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

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

  return unless attributes.key?(:products)

  self.products = attributes[:products]
end

Instance Attribute Details

#error_code ⇒ Object

Returns the value of attribute error_code.



26
27
28
 
# File 'lib/moneykit/models/link.rb', line 26

def error_code
  @error_code
end

#institution_id ⇒ Object

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



21
22
23
 
# File 'lib/moneykit/models/link.rb', line 21

def institution_id
  @institution_id
end

#institution_name ⇒ Object

The institution name this link is connected to.



24
25
26
 
# File 'lib/moneykit/models/link.rb', line 24

def institution_name
  @institution_name
end

#last_synced_at ⇒ Object

An ISO-8601 timestamp indicating the last time that the account was updated.



29
30
31
 
# File 'lib/moneykit/models/link.rb', line 29

def last_synced_at
  @last_synced_at
end

#link_id ⇒ Object

The unique ID for this link.



18
19
20
 
# File 'lib/moneykit/models/link.rb', line 18

def link_id
  @link_id
end

#products ⇒ Object

Returns the value of attribute products.



26
27
28
 
# File 'lib/moneykit/models/link.rb', line 26

def products
  @products
end

#state ⇒ Object

Returns the value of attribute state.



26
27
28
 
# File 'lib/moneykit/models/link.rb', line 26

def state
  @state
end

#tags ⇒ Object

Arbitrary strings used to describe this link.



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

def tags
  @tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



70
71
72
 
# File 'lib/moneykit/models/link.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/moneykit/models/link.rb', line 56

def self.attribute_map
  {
    'link_id': :link_id,
    'institution_id': :institution_id,
    'institution_name': :institution_name,
    'state': :state,
    'error_code': :error_code,
    'last_synced_at': :last_synced_at,
    'tags': :tags,
    'products': :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



206
207
208
 
# File 'lib/moneykit/models/link.rb', line 206

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



98
99
100
101
102
 
# File 'lib/moneykit/models/link.rb', line 98

def self.openapi_all_of
  [
    :LinkCommon
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



89
90
91
92
93
94
95
 
# File 'lib/moneykit/models/link.rb', line 89

def self.openapi_nullable
  Set.new(%i[
            error_code
            last_synced_at
            tags
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/moneykit/models/link.rb', line 75

def self.openapi_types
  {
    'link_id': :String,
    'institution_id': :String,
    'institution_name': :String,
    'state': :LinkState,
    'error_code': :LinkError,
    'last_synced_at': :Time,
    'tags': :'Array<String>',
    'products': :Products
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/moneykit/models/link.rb', line 177

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

  self.class == other.class &&
    link_id == other.link_id &&
    institution_id == other.institution_id &&
    institution_name == other.institution_name &&
    state == other.state &&
    error_code == other.error_code &&
    last_synced_at == other.last_synced_at &&
    tags == other.tags &&
    products == other.products
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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/moneykit/models/link.rb', line 240

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/moneykit/models/link.rb', line 311

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/moneykit/models/link.rb', line 213

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

  attributes = attributes.transform_keys(&:to_sym)
  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


193
194
195
 
# File 'lib/moneykit/models/link.rb', line 193

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



199
200
201
 
# File 'lib/moneykit/models/link.rb', line 199

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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/moneykit/models/link.rb', line 144

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "link_id", link_id cannot be nil.') if @link_id.nil?

  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

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

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

  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



287
288
289
 
# File 'lib/moneykit/models/link.rb', line 287

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



293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/moneykit/models/link.rb', line 293

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



281
282
283
 
# File 'lib/moneykit/models/link.rb', line 281

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



165
166
167
168
169
170
171
172
173
 
# File 'lib/moneykit/models/link.rb', line 165

def valid?
  return false if @link_id.nil?
  return false if @institution_id.nil?
  return false if @institution_name.nil?
  return false if @state.nil?
  return false if @products.nil?

  true
end