com.plaid.client.model

Class InstitutionsSearchRequestOptions

java.lang.Object

com.plaid.client.model.InstitutionsSearchRequestOptions

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-10-17T22:44:09.100608Z[Etc/UTC]")
public class InstitutionsSearchRequestOptions
extends Object

An optional object to filter `/institutions/search` results.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERIALIZED_NAME_INCLUDE_AUTH_METADATA
static String	SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA
static String	SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA
static String	SERIALIZED_NAME_OAUTH
static String	SERIALIZED_NAME_PAYMENT_INITIATION

Constructor Summary

Constructors

Constructor and Description
InstitutionsSearchRequestOptions()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getIncludeAuthMetadata() When `true`, returns metadata related to the Auth product indicating which auth methods are supported.
Boolean	getIncludeOptionalMetadata() When true, return the institution's homepage URL, logo and primary brand color.
Boolean	getIncludePaymentInitiationMetadata() When `true`, returns metadata related to the Payment Initiation product indicating which payment configurations are supported.
Boolean	getOauth() Limit results to institutions with or without OAuth login flows.
InstitutionsSearchPaymentInitiationOptions	getPaymentInitiation() Get paymentInitiation
int	hashCode()
InstitutionsSearchRequestOptions	includeAuthMetadata(Boolean includeAuthMetadata)
InstitutionsSearchRequestOptions	includeOptionalMetadata(Boolean includeOptionalMetadata)
InstitutionsSearchRequestOptions	includePaymentInitiationMetadata(Boolean includePaymentInitiationMetadata)
InstitutionsSearchRequestOptions	oauth(Boolean oauth)
InstitutionsSearchRequestOptions	paymentInitiation(InstitutionsSearchPaymentInitiationOptions paymentInitiation)
void	setIncludeAuthMetadata(Boolean includeAuthMetadata)
void	setIncludeOptionalMetadata(Boolean includeOptionalMetadata)
void	setIncludePaymentInitiationMetadata(Boolean includePaymentInitiationMetadata)
void	setOauth(Boolean oauth)
void	setPaymentInitiation(InstitutionsSearchPaymentInitiationOptions paymentInitiation)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZED_NAME_OAUTH

public static final String SERIALIZED_NAME_OAUTH

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

public static final String SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_AUTH_METADATA

public static final String SERIALIZED_NAME_INCLUDE_AUTH_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

public static final String SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_INITIATION

public static final String SERIALIZED_NAME_PAYMENT_INITIATION

See Also:

Constant Field Values

Constructor Detail

InstitutionsSearchRequestOptions

public InstitutionsSearchRequestOptions()

Method Detail

oauth

public InstitutionsSearchRequestOptions oauth(Boolean oauth)

getOauth

@Nullable
public Boolean getOauth()

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`.

Returns:

oauth

setOauth

public void setOauth(Boolean oauth)

includeOptionalMetadata

public InstitutionsSearchRequestOptions includeOptionalMetadata(Boolean includeOptionalMetadata)

getIncludeOptionalMetadata

@Nullable
public Boolean getIncludeOptionalMetadata()

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

Returns:

includeOptionalMetadata

setIncludeOptionalMetadata

public void setIncludeOptionalMetadata(Boolean includeOptionalMetadata)

includeAuthMetadata

public InstitutionsSearchRequestOptions includeAuthMetadata(Boolean includeAuthMetadata)

getIncludeAuthMetadata

@Nullable
public Boolean getIncludeAuthMetadata()

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

Returns:

includeAuthMetadata

setIncludeAuthMetadata

public void setIncludeAuthMetadata(Boolean includeAuthMetadata)

includePaymentInitiationMetadata

public InstitutionsSearchRequestOptions includePaymentInitiationMetadata(Boolean includePaymentInitiationMetadata)

getIncludePaymentInitiationMetadata

@Nullable
public Boolean getIncludePaymentInitiationMetadata()

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

Returns:

includePaymentInitiationMetadata

setIncludePaymentInitiationMetadata

public void setIncludePaymentInitiationMetadata(Boolean includePaymentInitiationMetadata)

paymentInitiation

public InstitutionsSearchRequestOptions paymentInitiation(InstitutionsSearchPaymentInitiationOptions paymentInitiation)

getPaymentInitiation

@Nullable
public InstitutionsSearchPaymentInitiationOptions getPaymentInitiation()

Get paymentInitiation

Returns:

paymentInitiation

setPaymentInitiation

public void setPaymentInitiation(InstitutionsSearchPaymentInitiationOptions paymentInitiation)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object