Class: Plaid::InstitutionsGetRequestOptions

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

Overview

An optional object to filter ‘/institutions/get` results.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstitutionsGetRequestOptions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 77

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

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

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

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

  if attributes.key?(:'include_auth_metadata')
    self.include_auth_metadata = attributes[:'include_auth_metadata']
  else
    self.include_auth_metadata = false
  end

  if attributes.key?(:'include_payment_initiation_metadata')
    self.include_payment_initiation_metadata = attributes[:'include_payment_initiation_metadata']
  else
    self.include_payment_initiation_metadata = false
  end
end

Instance Attribute Details

#include_auth_metadata ⇒ Object

When ‘true`, returns metadata related to the Auth product indicating which auth methods are supported.



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

def include_auth_metadata
  @include_auth_metadata
end

#include_optional_metadata ⇒ Object

When ‘true`, return the institution’s homepage URL, logo and primary brand color. Not all institutions’ logos are available. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.



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

def include_optional_metadata
  @include_optional_metadata
end

#include_payment_initiation_metadata ⇒ Object

When ‘true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.



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

def include_payment_initiation_metadata
  @include_payment_initiation_metadata
end

#oauth ⇒ Object

Limit results to institutions with or without OAuth login flows. Note that institutions will have ‘oauth` set to `true` if some Items associated with that institution are required to use OAuth flows; institutions in a state of migration to OAuth will have the `oauth` attribute set to `true`.



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

def oauth
  @oauth
end

#products ⇒ Object

Filter the Institutions based on which products they support. Will only return institutions that support all listed products. When filtering based on ‘auth`, an institution must support Instant Auth to match the criterion.



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

def products
  @products
end

#routing_numbers ⇒ Object

Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array. Routing number records used for this matching are generally comprehensive; however, failure to match a given routing number to an institution does not necessarily mean that the institution is unsupported by Plaid. Invalid routing numbers (numbers that are not 9 digits in length or do not have a valid checksum) will be filtered from the array before the response is processed.



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

def routing_numbers
  @routing_numbers
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 38

def self.attribute_map
  {
    :'products' => :'products',
    :'routing_numbers' => :'routing_numbers',
    :'oauth' => :'oauth',
    :'include_optional_metadata' => :'include_optional_metadata',
    :'include_auth_metadata' => :'include_auth_metadata',
    :'include_payment_initiation_metadata' => :'include_payment_initiation_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



181
182
183
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 181

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
71
72
73
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 67

def self.openapi_nullable
  Set.new([
    :'products',
    :'routing_numbers',
    :'oauth',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 55

def self.openapi_types
  {
    :'products' => :'Array<Products>',
    :'routing_numbers' => :'Array<String>',
    :'oauth' => :'Boolean',
    :'include_optional_metadata' => :'Boolean',
    :'include_auth_metadata' => :'Boolean',
    :'include_payment_initiation_metadata' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



155
156
157
158
159
160
161
162
163
164
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 155

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      products == o.products &&
      routing_numbers == o.routing_numbers &&
      oauth == o.oauth &&
      include_optional_metadata == o.include_optional_metadata &&
      include_auth_metadata == o.include_auth_metadata &&
      include_payment_initiation_metadata == o.include_payment_initiation_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



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
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 212

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



283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 283

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 188

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


168
169
170
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 174

def hash
  [products, routing_numbers, oauth, include_optional_metadata, include_auth_metadata, include_payment_initiation_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



125
126
127
128
129
130
131
132
133
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 125

def list_invalid_properties
  invalid_properties = Array.new

  if !@products.nil? && @products.length < 1
    invalid_properties.push('invalid value for "products", number of items must be greater than or equal to 1.')
  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



259
260
261
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 259

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



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

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



253
254
255
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 253

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



137
138
139
140
 
# File 'lib/plaid/models/institutions_get_request_options.rb', line 137

def valid?
  return false if !@products.nil? && @products.length < 1
  true
end