Class: MoneyKit::Institution

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Institution

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
155
156
157
158
159
160
161
 
# File 'lib/moneykit/models/institution.rb', line 103

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

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

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

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

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

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

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

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

Instance Attribute Details

#color ⇒ Object

The primary color of this institution, represented as hexcode.



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

def color
  @color
end

#color_dark ⇒ Object

The dark-mode primary color of this institution, represented as hexcode.



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

def color_dark
  @color_dark
end

#country ⇒ Object

Returns the value of attribute country.



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

def country
  @country
end

#domain ⇒ Object

The domain of the institution’s user-facing website.



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

def domain
  @domain
end

#institution_id ⇒ Object

MoneyKit’s unique ID for this institution.



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

def institution_id
  @institution_id
end

#institution_id_aliases ⇒ Object

Returns the value of attribute institution_id_aliases.



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

def institution_id_aliases
  @institution_id_aliases
end

#is_featured ⇒ Object

True for institutions that should be visually promoted to the end-user.



38
39
40
 
# File 'lib/moneykit/models/institution.rb', line 38

def is_featured
  @is_featured
end

#name ⇒ Object

The name of the institution.



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

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



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/moneykit/models/institution.rb', line 262

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



77
78
79
 
# File 'lib/moneykit/models/institution.rb', line 77

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/moneykit/models/institution.rb', line 63

def self.attribute_map
  {
    :'institution_id' => :'institution_id',
    :'institution_id_aliases' => :'institution_id_aliases',
    :'name' => :'name',
    :'country' => :'country',
    :'domain' => :'domain',
    :'color' => :'color',
    :'color_dark' => :'color_dark',
    :'is_featured' => :'is_featured'
  }
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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/moneykit/models/institution.rb', line 238

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



96
97
98
99
 
# File 'lib/moneykit/models/institution.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/moneykit/models/institution.rb', line 82

def self.openapi_types
  {
    :'institution_id' => :'String',
    :'institution_id_aliases' => :'Array<String>',
    :'name' => :'String',
    :'country' => :'Country',
    :'domain' => :'String',
    :'color' => :'String',
    :'color_dark' => :'String',
    :'is_featured' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/moneykit/models/institution.rb', line 210

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      institution_id == o.institution_id &&
      institution_id_aliases == o.institution_id_aliases &&
      name == o.name &&
      country == o.country &&
      domain == o.domain &&
      color == o.color &&
      color_dark == o.color_dark &&
      is_featured == o.is_featured
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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/moneykit/models/institution.rb', line 333

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


225
226
227
 
# File 'lib/moneykit/models/institution.rb', line 225

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



231
232
233
 
# File 'lib/moneykit/models/institution.rb', line 231

def hash
  [institution_id, institution_id_aliases, name, country, domain, color, color_dark, is_featured].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



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

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

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

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

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

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

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



309
310
311
 
# File 'lib/moneykit/models/institution.rb', line 309

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/moneykit/models/institution.rb', line 315

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



303
304
305
 
# File 'lib/moneykit/models/institution.rb', line 303

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



197
198
199
200
201
202
203
204
205
206
 
# File 'lib/moneykit/models/institution.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @institution_id.nil?
  return false if @institution_id_aliases.nil?
  return false if @name.nil?
  return false if @country.nil?
  return false if @color.nil?
  return false if @is_featured.nil?
  true
end