class

Plaid::InstitutionsSearchRequestOptions

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

An optional object to filter /institutions/search results.

Constructors

new(pull : JSON::PullParser)

new(*, __pull_for_json_serializable pull : JSON::PullParser)

new(*, oauth : Bool | Nil = nil, include_optional_metadata : Bool | Nil = nil, include_auth_metadata : Bool | Nil = false, include_payment_initiation_metadata : Bool | Nil = false, payment_initiation : Plaid::InstitutionsSearchPaymentInitiationOptions | Nil = nil)

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

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

hash(hasher)

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

include_auth_metadata

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

include_auth_metadata=(new_value : Bool | Nil)

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

include_auth_metadata_present=(include_auth_metadata_present : Bool)

include_auth_metadata_present?

include_optional_metadata

When true, return the institution's homepage URL, logo and primary brand color.

include_optional_metadata=(new_value : Bool | Nil)

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

include_payment_initiation_metadata

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

include_payment_initiation_metadata=(new_value : Bool | Nil)

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

include_payment_initiation_metadata_present=(include_payment_initiation_metadata_present : Bool)

include_payment_initiation_metadata_present?

list_invalid_properties

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

oauth

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.

oauth=(new_value : Bool | Nil)

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

oauth_present=(oauth_present : Bool)

oauth_present?

payment_initiation

payment_initiation=(new_value : Plaid::InstitutionsSearchPaymentInitiationOptions | Nil)

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

payment_initiation_present=(payment_initiation_present : Bool)

payment_initiation_present?

valid?

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