class Plaid::InstitutionsSearchRequestOptions
An optional object to filter ‘/institutions/search` results.
Attributes
When ‘true`, returns metadata related to the Auth product indicating which auth methods are supported.
When true, return the institution’s homepage URL, logo and primary brand color.
When ‘true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
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`.
Public Class Methods
Returns all the JSON keys this model knows about
# File lib/plaid/models/institutions_search_request_options.rb, line 45 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_options.rb, line 34 def self.attribute_map { :'oauth' => :'oauth', :'include_optional_metadata' => :'include_optional_metadata', :'include_auth_metadata' => :'include_auth_metadata', :'include_payment_initiation_metadata' => :'include_payment_initiation_metadata', :'payment_initiation' => :'payment_initiation' } 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_options.rb, line 150 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_options.rb, line 72 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::InstitutionsSearchRequestOptions` 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::InstitutionsSearchRequestOptions`. 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?(:'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 if attributes.key?(:'payment_initiation') self.payment_initiation = attributes[:'payment_initiation'] end end
List of attributes with nullable: true
# File lib/plaid/models/institutions_search_request_options.rb, line 61 def self.openapi_nullable Set.new([ :'oauth', :'include_auth_metadata', :'include_payment_initiation_metadata', :'payment_initiation' ]) end
Attribute type mapping.
# File lib/plaid/models/institutions_search_request_options.rb, line 50 def self.openapi_types { :'oauth' => :'Boolean', :'include_optional_metadata' => :'Boolean', :'include_auth_metadata' => :'Boolean', :'include_payment_initiation_metadata' => :'Boolean', :'payment_initiation' => :'InstitutionsSearchPaymentInitiationOptions' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/plaid/models/institutions_search_request_options.rb, line 125 def ==(o) return true if self.equal?(o) self.class == o.class && 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 && payment_initiation == o.payment_initiation 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_options.rb, line 181 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_options.rb, line 252 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_options.rb, line 157 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_options.rb, line 137 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/plaid/models/institutions_search_request_options.rb, line 143 def hash [oauth, include_optional_metadata, include_auth_metadata, include_payment_initiation_metadata, payment_initiation].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_options.rb, line 112 def list_invalid_properties invalid_properties = Array.new invalid_properties 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_options.rb, line 234 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_options.rb, line 222 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_options.rb, line 119 def valid? true end