class

Plaid::EmployersSearchRequest

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

EmployersSearchRequest defines the request schema for /employers/search.

Constructors

new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, query : String | Nil = nil, products : Array(String) | Nil = nil, client_id : String | Nil = nil, secret : String | 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
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
products

The Plaid products the returned employers should support. Currently, this field must be set to \"deposit_switch\".

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

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

Source
query

The employer name to be searched for.

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