class Plaid::InstitutionsSearchRequest
InstitutionsSearchRequest
defines the request schema for ‘/institutions/search`
Attributes
Your Plaid
API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
Specify which country or countries to include institutions from, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the ‘country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied.
Filter the Institutions based on whether they support all products listed in ‘products`. Provide `null` to get institutions regardless of supported products. Note that when `auth` is specified as a product, if you are enabled for Instant Match or Automated Micro-deposits, institutions that support those products will be returned even if `auth` is not present in their product array.
The search query. Institutions with names matching the query are returned
Your Plaid
API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/institutions_search_request.rb, line 49 def self.acceptable_attributes attribute_map.values end
Attribute mapping from ruby-style variable name to JSON key.
# File lib/plaid/models/institutions_search_request.rb, line 37 def self.attribute_map { :'client_id' => :'client_id', :'secret' => :'secret', :'query' => :'query', :'products' => :'products', :'country_codes' => :'country_codes', :'options' => :'options' } end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/institutions_search_request.rb, line 205 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/plaid/models/institutions_search_request.rb, line 74 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InstitutionsSearchRequest` 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::InstitutionsSearchRequest`. 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?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'query') self.query = attributes[:'query'] 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?(:'options') self.options = attributes[:'options'] end end
List of attributes with nullable: true
# File lib/plaid/models/institutions_search_request.rb, line 66 def self.openapi_nullable Set.new([ :'products', ]) end
Attribute type mapping.
# File lib/plaid/models/institutions_search_request.rb, line 54 def self.openapi_types { :'client_id' => :'String', :'secret' => :'String', :'query' => :'String', :'products' => :'Array<Products>', :'country_codes' => :'Array<CountryCode>', :'options' => :'InstitutionsSearchRequestOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/institutions_search_request.rb, line 179 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && secret == o.secret && query == o.query && products == o.products && country_codes == o.country_codes && options == o.options end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/plaid/models/institutions_search_request.rb, line 236 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/plaid/models/institutions_search_request.rb, line 307 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/plaid/models/institutions_search_request.rb, line 212 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
@see the ‘==` method @param [Object] Object to be compared
# File lib/plaid/models/institutions_search_request.rb, line 192 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/institutions_search_request.rb, line 198 def hash [client_id, secret, query, products, country_codes, options].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/plaid/models/institutions_search_request.rb, line 118 def list_invalid_properties invalid_properties = Array.new if @query.nil? invalid_properties.push('invalid value for "query", query cannot be nil.') end if @query.to_s.length < 1 invalid_properties.push('invalid value for "query", the character length must be great than or equal to 1.') end 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 if @country_codes.nil? invalid_properties.push('invalid value for "country_codes", country_codes cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] products Value to be assigned
# File lib/plaid/models/institutions_search_request.rb, line 168 def products=(products) if !products.nil? && products.length < 1 fail ArgumentError, 'invalid value for "products", number of items must be greater than or equal to 1.' end @products = products end
Custom attribute writer method with validation @param [Object] query Value to be assigned
# File lib/plaid/models/institutions_search_request.rb, line 153 def query=(query) if query.nil? fail ArgumentError, 'query cannot be nil' end if query.to_s.length < 1 fail ArgumentError, 'invalid value for "query", the character length must be great than or equal to 1.' end @query = query end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/plaid/models/institutions_search_request.rb, line 289 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/plaid/models/institutions_search_request.rb, line 277 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/plaid/models/institutions_search_request.rb, line 143 def valid? return false if @query.nil? return false if @query.to_s.length < 1 return false if !@products.nil? && @products.length < 1 return false if @country_codes.nil? true end