class

Plaid::InstitutionsGetRequest

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

InstitutionsGetRequest defines the request schema for /institutions/get

Constants

MAX_FOR_COUNT = Int32.new("500")
MIN_FOR_COUNT = Int32.new("1")
MIN_FOR_OFFSET = Int32.new("0")
MIN_ITEMS_FOR_COUNTRY_CODES = 1

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, count : Int32 | Nil = nil, offset : Int32 | Nil = nil, country_codes : Array(CountryCode) | Nil = nil, client_id : String | Nil = nil, secret : String | Nil = nil, options : Plaid::InstitutionsGetRequestOptions | 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
count

The total number of Institutions to return.

Source
count=(new_value : Int32 | Nil)

Custom attribute writer method checking allowed values (enum). @param [Object] count 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
offset

The number of Institutions to skip.

Source
offset=(new_value : Int32 | Nil)

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

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

Custom attribute writer method checking allowed values (enum). @param [Object] options 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