class Plaid::InstitutionsSearchRequest

Overview

InstitutionsSearchRequest defines the request schema for /institutions/search

Included Modules

Defined in:

plaid/models/institutions_search_request.cr

Constant Summary

MIN_ITEMS_FOR_PRODUCTS = 1
MIN_LENGTH_FOR_QUERY = 1

Constructors

Instance Method Summary

Instance methods inherited from module OpenApi::Json

after_initialize after_initialize, eql?(o : self) eql?, to_hash : Hash(String, JSON::Any) to_hash, to_json_any : JSON::Any to_json_any

Class methods inherited from module OpenApi::Json

build_from_hash(hash : Hash) build_from_hash, build_from_json_any(json_any : JSON::Any) build_from_json_any

Instance methods inherited from module OpenApi::Validatable

list_invalid_properties : Array(String) list_invalid_properties, list_invalid_properties_for(key : String) : Array(String) list_invalid_properties_for, valid? : Bool valid?, validate : Nil validate

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.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


[View source]

Instance Method Detail

def ==(other : self) #

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


def client_id : String | Nil #

[View source]
def client_id=(new_value : String | Nil) #

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


[View source]
def country_codes : Array(CountryCode) | Nil #

[View source]
def country_codes=(new_value : Array(CountryCode) | Nil) #

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


[View source]
def hash(hasher) #

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


def list_invalid_properties : Array(String) #

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


[View source]
def options : Plaid::InstitutionsSearchRequestOptions | Nil #

[View source]
def options=(new_value : Plaid::InstitutionsSearchRequestOptions | Nil) #

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


[View source]
def products : Array(Products) | Nil #

[View source]
def products=(new_value : Array(Products) | Nil) #

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


[View source]
def products_present=(products_present : Bool) #

[View source]
def products_present? : Bool #

[View source]
def query : String | Nil #

[View source]
def query=(new_value : String | Nil) #

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


[View source]
def secret : String | Nil #

[View source]
def secret=(new_value : String | Nil) #

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


[View source]
def valid? : Bool #

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


[View source]