Package com.plaid.client.model

Class InstitutionsSearchRequest

java.lang.Object

com.plaid.client.model.InstitutionsSearchRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2021-10-15T19:47:39.714Z[GMT]")
public class InstitutionsSearchRequest
extends java.lang.Object

InstitutionsSearchRequest defines the request schema for `/institutions/search`

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	SERIALIZED_NAME_CLIENT_ID
static java.lang.String	SERIALIZED_NAME_COUNTRY_CODES
static java.lang.String	SERIALIZED_NAME_OPTIONS
static java.lang.String	SERIALIZED_NAME_PRODUCTS
static java.lang.String	SERIALIZED_NAME_QUERY
static java.lang.String	SERIALIZED_NAME_SECRET

Constructor Summary

Constructors

Constructor	Description
InstitutionsSearchRequest()

Method Summary

Modifier and Type	Method	Description
InstitutionsSearchRequest	addCountryCodesItem(CountryCode countryCodesItem)
InstitutionsSearchRequest	addProductsItem(Products productsItem)
InstitutionsSearchRequest	clientId(java.lang.String clientId)
InstitutionsSearchRequest	countryCodes(java.util.List<CountryCode> countryCodes)
boolean	equals(java.lang.Object o)
java.lang.String	getClientId()	Your Plaid API `client_id`.
java.util.List<CountryCode>	getCountryCodes()	Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.
InstitutionsSearchRequestOptions	getOptions()	Get options
java.util.List<Products>	getProducts()	Filter the Institutions based on whether they support all products listed in `products`.
java.lang.String	getQuery()	The search query.
java.lang.String	getSecret()	Your Plaid API `secret`.
int	hashCode()
InstitutionsSearchRequest	options(InstitutionsSearchRequestOptions options)
InstitutionsSearchRequest	products(java.util.List<Products> products)
InstitutionsSearchRequest	query(java.lang.String query)
InstitutionsSearchRequest	secret(java.lang.String secret)
void	setClientId(java.lang.String clientId)
void	setCountryCodes(java.util.List<CountryCode> countryCodes)
void	setOptions(InstitutionsSearchRequestOptions options)
void	setProducts(java.util.List<Products> products)
void	setQuery(java.lang.String query)
void	setSecret(java.lang.String secret)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SERIALIZED_NAME_CLIENT_ID

public static final java.lang.String SERIALIZED_NAME_CLIENT_ID

See Also:

Constant Field Values

SERIALIZED_NAME_SECRET

public static final java.lang.String SERIALIZED_NAME_SECRET

See Also:

Constant Field Values

SERIALIZED_NAME_QUERY

public static final java.lang.String SERIALIZED_NAME_QUERY

See Also:

Constant Field Values

SERIALIZED_NAME_PRODUCTS

public static final java.lang.String SERIALIZED_NAME_PRODUCTS

See Also:

Constant Field Values

SERIALIZED_NAME_COUNTRY_CODES

public static final java.lang.String SERIALIZED_NAME_COUNTRY_CODES

See Also:

Constant Field Values

SERIALIZED_NAME_OPTIONS

public static final java.lang.String SERIALIZED_NAME_OPTIONS

See Also:

Constant Field Values

Constructor Details

InstitutionsSearchRequest

public InstitutionsSearchRequest()

Method Details

clientId

public InstitutionsSearchRequest clientId(java.lang.String clientId)

getClientId

@Nullable public java.lang.String getClientId()

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.

Returns:

clientId

setClientId

public void setClientId(java.lang.String clientId)

secret

public InstitutionsSearchRequest secret(java.lang.String secret)

getSecret

@Nullable public java.lang.String getSecret()

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.

Returns:

secret

setSecret

public void setSecret(java.lang.String secret)

query

public InstitutionsSearchRequest query(java.lang.String query)

getQuery

public java.lang.String getQuery()

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

Returns:

query

setQuery

public void setQuery(java.lang.String query)

products

public InstitutionsSearchRequest products(java.util.List<Products> products)

addProductsItem

public InstitutionsSearchRequest addProductsItem(Products productsItem)

getProducts

public java.util.List<Products> getProducts()

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.

Returns:

products

setProducts

public void setProducts(java.util.List<Products> products)

countryCodes

public InstitutionsSearchRequest countryCodes(java.util.List<CountryCode> countryCodes)

addCountryCodesItem

public InstitutionsSearchRequest addCountryCodesItem(CountryCode countryCodesItem)

getCountryCodes

public java.util.List<CountryCode> getCountryCodes()

Specify an array of Plaid-supported country codes this institution supports, using the ISO-3166-1 alpha-2 country code standard.

Returns:

countryCodes

setCountryCodes

public void setCountryCodes(java.util.List<CountryCode> countryCodes)

options

public InstitutionsSearchRequest options(InstitutionsSearchRequestOptions options)

getOptions

@Nullable public InstitutionsSearchRequestOptions getOptions()

Get options

Returns:

options

setOptions

public void setOptions(InstitutionsSearchRequestOptions options)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object