Package com.plaid.client.model
Class InstitutionsGetRequestOptions
java.lang.Object
com.plaid.client.model.InstitutionsGetRequestOptions
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2021-10-15T19:47:39.714Z[GMT]")
public class InstitutionsGetRequestOptions
extends java.lang.Object
An optional object to filter `/institutions/get` 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_PRODUCTS
static java.lang.String
SERIALIZED_NAME_ROUTING_NUMBERS
-
Constructor Summary
Constructors Constructor Description InstitutionsGetRequestOptions()
-
Method Summary
Modifier and Type Method Description InstitutionsGetRequestOptions
addProductsItem(Products productsItem)
InstitutionsGetRequestOptions
addRoutingNumbersItem(java.lang.String routingNumbersItem)
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.java.util.List<Products>
getProducts()
Filter the Institutions based on which products they support.java.util.List<java.lang.String>
getRoutingNumbers()
Specify an array of routing numbers to filter institutions.int
hashCode()
InstitutionsGetRequestOptions
includeAuthMetadata(java.lang.Boolean includeAuthMetadata)
InstitutionsGetRequestOptions
includeOptionalMetadata(java.lang.Boolean includeOptionalMetadata)
InstitutionsGetRequestOptions
includePaymentInitiationMetadata(java.lang.Boolean includePaymentInitiationMetadata)
InstitutionsGetRequestOptions
oauth(java.lang.Boolean oauth)
InstitutionsGetRequestOptions
products(java.util.List<Products> products)
InstitutionsGetRequestOptions
routingNumbers(java.util.List<java.lang.String> routingNumbers)
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
setProducts(java.util.List<Products> products)
void
setRoutingNumbers(java.util.List<java.lang.String> routingNumbers)
java.lang.String
toString()
-
Field Details
-
SERIALIZED_NAME_PRODUCTS
public static final java.lang.String SERIALIZED_NAME_PRODUCTS- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ROUTING_NUMBERS
public static final java.lang.String SERIALIZED_NAME_ROUTING_NUMBERS- See Also:
- Constant Field Values
-
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
-
-
Constructor Details
-
InstitutionsGetRequestOptions
public InstitutionsGetRequestOptions()
-
-
Method Details
-
products
-
addProductsItem
-
getProducts
Filter the Institutions based on which products they support.- Returns:
- products
-
setProducts
-
routingNumbers
public InstitutionsGetRequestOptions routingNumbers(java.util.List<java.lang.String> routingNumbers) -
addRoutingNumbersItem
-
getRoutingNumbers
@Nullable public java.util.List<java.lang.String> getRoutingNumbers()Specify an array of routing numbers to filter institutions. The response will only return institutions that match all of the routing numbers in the array.- Returns:
- routingNumbers
-
setRoutingNumbers
public void setRoutingNumbers(java.util.List<java.lang.String> routingNumbers) -
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 InstitutionsGetRequestOptions 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. Note that Plaid does not own any of the logos shared by the API, and that by accessing or using these logos, you agree that you are doing so at your own risk and will, if necessary, obtain all required permissions from the appropriate rights holders and adhere to any applicable usage guidelines. Plaid disclaims all express or implied warranties with respect to the logos.- Returns:
- includeOptionalMetadata
-
setIncludeOptionalMetadata
public void setIncludeOptionalMetadata(java.lang.Boolean includeOptionalMetadata) -
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 InstitutionsGetRequestOptions 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) -
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-