Package com.plaid.client.model

Class InstitutionsSearchRequestOptions

java.lang.Object

com.plaid.client.model.InstitutionsSearchRequestOptions

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

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
InstitutionsSearchRequestOptions()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZED_NAME_OAUTH

public static final java.lang.String SERIALIZED_NAME_OAUTH

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_OPTIONAL_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_AUTH_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_AUTH_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

public static final java.lang.String SERIALIZED_NAME_INCLUDE_PAYMENT_INITIATION_METADATA

See Also:

Constant Field Values

SERIALIZED_NAME_PAYMENT_INITIATION

public static final java.lang.String SERIALIZED_NAME_PAYMENT_INITIATION

See Also:

Constant Field Values

Constructor Details

InstitutionsSearchRequestOptions

public InstitutionsSearchRequestOptions()

Method Details

oauth

public InstitutionsSearchRequestOptions oauth(java.lang.Boolean oauth)

getOauth

@Nullable public java.lang.Boolean getOauth()

Limit results to institutions with or without OAuth login flows. This is primarily relevant to institutions with European country codes

Returns:

oauth

setOauth

public void setOauth(java.lang.Boolean oauth)

includeOptionalMetadata

public InstitutionsSearchRequestOptions includeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)

getIncludeOptionalMetadata

@Nullable public java.lang.Boolean getIncludeOptionalMetadata()

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

Returns:

includeOptionalMetadata

setIncludeOptionalMetadata

public void setIncludeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)

includeAuthMetadata

public InstitutionsSearchRequestOptions includeAuthMetadata(java.lang.Boolean includeAuthMetadata)

getIncludeAuthMetadata

@Nullable public java.lang.Boolean getIncludeAuthMetadata()

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

Returns:

includeAuthMetadata

setIncludeAuthMetadata

public void setIncludeAuthMetadata(java.lang.Boolean includeAuthMetadata)

includePaymentInitiationMetadata

public InstitutionsSearchRequestOptions includePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)

getIncludePaymentInitiationMetadata

@Nullable public java.lang.Boolean getIncludePaymentInitiationMetadata()

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

Returns:

includePaymentInitiationMetadata

setIncludePaymentInitiationMetadata

public void setIncludePaymentInitiationMetadata(java.lang.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(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