Class: Plaid::Institution

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

Overview

Details relating to a specific financial institution

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



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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/plaid/models/institution.rb', line 112

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#auth_metadata ⇒ Object

Returns the value of attribute auth_metadata.



53
54
55
 
# File 'lib/plaid/models/institution.rb', line 53

def auth_metadata
  @auth_metadata
end

#country_codes ⇒ Object

A list of the country codes supported by the institution.



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

def country_codes
  @country_codes
end

#dtc_numbers ⇒ Object

A partial list of DTC numbers associated with the institution.



44
45
46
 
# File 'lib/plaid/models/institution.rb', line 44

def dtc_numbers
  @dtc_numbers
end

#institution_id ⇒ Object

Unique identifier for the institution. Note that the same institution may have multiple records, each with different institution IDs; for example, if the institution has migrated to OAuth, there may be separate ‘institution_id`s for the OAuth and non-OAuth versions of the institution. Institutions that operate in different countries or with multiple login portals may also have separate `institution_id`s for each country or portal.



20
21
22
 
# File 'lib/plaid/models/institution.rb', line 20

def institution_id
  @institution_id
end

#logo ⇒ Object

Base64 encoded representation of the institution’s logo, returned as a base64 encoded 152x152 PNG. Not all institutions’ logos are available.



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

def 
  @logo
end

#name ⇒ Object

The official name of the institution.



23
24
25
 
# File 'lib/plaid/models/institution.rb', line 23

def name
  @name
end

#oauth ⇒ Object

Indicates that the institution has an OAuth login flow. This will be ‘true` if OAuth is supported for any Items associated with the institution, even if the institution also supports non-OAuth connections.



47
48
49
 
# File 'lib/plaid/models/institution.rb', line 47

def oauth
  @oauth
end

#payment_initiation_metadata ⇒ Object

Returns the value of attribute payment_initiation_metadata.



51
52
53
 
# File 'lib/plaid/models/institution.rb', line 51

def payment_initiation_metadata
  @payment_initiation_metadata
end

#primary_color ⇒ Object

Hexadecimal representation of the primary color used by the institution



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

def primary_color
  @primary_color
end

#products ⇒ Object

A list of the Plaid products supported by the institution. Note that only institutions that support Instant Auth will return ‘auth` in the product array; institutions that do not list `auth` may still support other Auth methods such as Instant Match or Automated Micro-deposit Verification. To identify institutions that support those methods, use the `auth_metadata` object. For more details, see [Full Auth coverage](plaid.com/docs/auth/coverage/). The `income_verification` product here indicates support for Bank Income.



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

def products
  @products
end

#routing_numbers ⇒ Object

A list of routing numbers known to be associated with the institution. This list is provided for the purpose of looking up institutions by routing number. It is generally comprehensive but is not guaranteed to be a complete list of routing numbers for an institution.



41
42
43
 
# File 'lib/plaid/models/institution.rb', line 41

def routing_numbers
  @routing_numbers
end

#status ⇒ Object

Returns the value of attribute status.



49
50
51
 
# File 'lib/plaid/models/institution.rb', line 49

def status
  @status
end

#url ⇒ Object

The URL for the institution’s website



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/plaid/models/institution.rb', line 75

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
68
69
70
71
72
 
# File 'lib/plaid/models/institution.rb', line 56

def self.attribute_map
  {
    :'institution_id' => :'institution_id',
    :'name' => :'name',
    :'products' => :'products',
    :'country_codes' => :'country_codes',
    :'url' => :'url',
    :'primary_color' => :'primary_color',
    :'logo' => :'logo',
    :'routing_numbers' => :'routing_numbers',
    :'dtc_numbers' => :'dtc_numbers',
    :'oauth' => :'oauth',
    :'status' => :'status',
    :'payment_initiation_metadata' => :'payment_initiation_metadata',
    :'auth_metadata' => :'auth_metadata'
  }
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



264
265
266
 
# File 'lib/plaid/models/institution.rb', line 264

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/plaid/models/institution.rb', line 99

def self.openapi_nullable
  Set.new([
    :'url',
    :'primary_color',
    :'logo',
    :'status',
    :'payment_initiation_metadata',
    :'auth_metadata'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'institution_id' => :'String',
    :'name' => :'String',
    :'products' => :'Array<Products>',
    :'country_codes' => :'Array<CountryCode>',
    :'url' => :'String',
    :'primary_color' => :'String',
    :'logo' => :'String',
    :'routing_numbers' => :'Array<String>',
    :'dtc_numbers' => :'Array<String>',
    :'oauth' => :'Boolean',
    :'status' => :'InstitutionStatus',
    :'payment_initiation_metadata' => :'PaymentInitiationMetadata',
    :'auth_metadata' => :'AuthMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/plaid/models/institution.rb', line 231

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      institution_id == o.institution_id &&
      name == o.name &&
      products == o.products &&
      country_codes == o.country_codes &&
      url == o.url &&
      primary_color == o.primary_color &&
       == o. &&
      routing_numbers == o.routing_numbers &&
      dtc_numbers == o.dtc_numbers &&
      oauth == o.oauth &&
      status == o.status &&
      payment_initiation_metadata == o.payment_initiation_metadata &&
      auth_metadata == o.auth_metadata
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



295
296
297
298
299
300
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
 
# File 'lib/plaid/models/institution.rb', line 295

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/plaid/models/institution.rb', line 366

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/plaid/models/institution.rb', line 271

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)
      self.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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/plaid/models/institution.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/plaid/models/institution.rb', line 257

def hash
  [institution_id, name, products, country_codes, url, primary_color, , routing_numbers, dtc_numbers, oauth, status, payment_initiation_metadata, auth_metadata].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @institution_id.nil?
    invalid_properties.push('invalid value for "institution_id", institution_id cannot be nil.')
  end

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

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

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

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

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



342
343
344
 
# File 'lib/plaid/models/institution.rb', line 342

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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/plaid/models/institution.rb', line 348

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



336
337
338
 
# File 'lib/plaid/models/institution.rb', line 336

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/plaid/models/institution.rb', line 219

def valid?
  return false if @institution_id.nil?
  return false if @name.nil?
  return false if @products.nil?
  return false if @country_codes.nil?
  return false if @routing_numbers.nil?
  return false if @oauth.nil?
  true
end