class

Plaid::InstitutionsSearchRequest

Inherits OpenApi::Json < OpenApi::Validatable < JSON::Serializable::Unmapped < JSON::Serializable < Reference < Object

InstitutionsSearchRequest defines the request schema for /institutions/search

Constants

MIN_ITEMS_FOR_PRODUCTS = 1
MIN_LENGTH_FOR_QUERY = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, query : String | Nil = nil, country_codes : Array(CountryCode) | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, products : Array(Products) | Nil = nil, options : Plaid::InstitutionsSearchRequestOptions | Nil = nil)

Initializes the object @param [Hash] attributes Model attributes in the form of hash

Source

Instance methods

==(other : self)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

client_id

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.

Source
client_id=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] client_id Object to be assigned

Source
country_codes

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.

Source
country_codes=(new_value : Array(CountryCode) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] country_codes Object to be assigned

Source
hash(hasher)

Generates #hash and #== methods from all fields #== @return [Bool] #hash calculates hash code according to all attributes. #hash @return [UInt64] Hash code

list_invalid_properties

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

Source
options
Source
options=(new_value : Plaid::InstitutionsSearchRequestOptions | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] options Object to be assigned

Source
products

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.

Source
products=(new_value : Array(Products) | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] products Object to be assigned

Source
products_present=(products_present : Bool)
Source
products_present?
Source
query

The search query. Institutions with names matching the query are returned

Source
query=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] query Object to be assigned

Source
secret

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.

Source
secret=(new_value : String | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] secret Object to be assigned

Source
valid?

Check to see if the all the properties in the model are valid @return true if the model is valid

Source