com.plaid.client.model.InstitutionsSearchRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of plaid-java Show documentation
Show all versions of plaid-java Show documentation
Bindings for the Plaid (plaid.com) API.
/*
* The Plaid API
* The Plaid REST API. Please see https://plaid.com/docs/api for more details.
*
* The version of the OpenAPI document: 2020-09-14_1.503.5
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.plaid.client.model;
import java.util.Objects;
import java.util.Arrays;
import com.google.gson.TypeAdapter;
import com.google.gson.annotations.JsonAdapter;
import com.google.gson.annotations.SerializedName;
import com.google.gson.stream.JsonReader;
import com.google.gson.stream.JsonWriter;
import com.plaid.client.model.CountryCode;
import com.plaid.client.model.InstitutionsSearchRequestOptions;
import com.plaid.client.model.Products;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
/**
* InstitutionsSearchRequest defines the request schema for `/institutions/search`
*/
@ApiModel(description = "InstitutionsSearchRequest defines the request schema for `/institutions/search`")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-03-28T21:00:55.745394Z[Etc/UTC]")
public class InstitutionsSearchRequest {
public static final String SERIALIZED_NAME_CLIENT_ID = "client_id";
@SerializedName(SERIALIZED_NAME_CLIENT_ID)
private String clientId;
public static final String SERIALIZED_NAME_SECRET = "secret";
@SerializedName(SERIALIZED_NAME_SECRET)
private String secret;
public static final String SERIALIZED_NAME_QUERY = "query";
@SerializedName(SERIALIZED_NAME_QUERY)
private String query;
public static final String SERIALIZED_NAME_PRODUCTS = "products";
@SerializedName(SERIALIZED_NAME_PRODUCTS)
private List products = null;
public static final String SERIALIZED_NAME_COUNTRY_CODES = "country_codes";
@SerializedName(SERIALIZED_NAME_COUNTRY_CODES)
private List countryCodes = new ArrayList<>();
public static final String SERIALIZED_NAME_OPTIONS = "options";
@SerializedName(SERIALIZED_NAME_OPTIONS)
private InstitutionsSearchRequestOptions options;
public InstitutionsSearchRequest clientId(String clientId) {
this.clientId = clientId;
return this;
}
/**
* 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.
* @return clientId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "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.")
public String getClientId() {
return clientId;
}
public void setClientId(String clientId) {
this.clientId = clientId;
}
public InstitutionsSearchRequest secret(String secret) {
this.secret = secret;
return this;
}
/**
* 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.
* @return secret
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "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.")
public String getSecret() {
return secret;
}
public void setSecret(String secret) {
this.secret = secret;
}
public InstitutionsSearchRequest query(String query) {
this.query = query;
return this;
}
/**
* The search query. Institutions with names matching the query are returned
* @return query
**/
@ApiModelProperty(required = true, value = "The search query. Institutions with names matching the query are returned")
public String getQuery() {
return query;
}
public void setQuery(String query) {
this.query = query;
}
public InstitutionsSearchRequest products(List products) {
this.products = products;
return this;
}
public InstitutionsSearchRequest addProductsItem(Products productsItem) {
if (this.products == null) {
this.products = new ArrayList<>();
}
this.products.add(productsItem);
return this;
}
/**
* 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.
* @return products
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "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.")
public List getProducts() {
return products;
}
public void setProducts(List products) {
this.products = products;
}
public InstitutionsSearchRequest countryCodes(List countryCodes) {
this.countryCodes = countryCodes;
return this;
}
public InstitutionsSearchRequest addCountryCodesItem(CountryCode countryCodesItem) {
this.countryCodes.add(countryCodesItem);
return this;
}
/**
* Specify which country or countries to include institutions from, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied.
* @return countryCodes
**/
@ApiModelProperty(required = true, value = "Specify which country or countries to include institutions from, using the ISO-3166-1 alpha-2 country code standard. In API versions 2019-05-29 and earlier, the `country_codes` parameter is an optional parameter within the `options` object and will default to `[US]` if it is not supplied. ")
public List getCountryCodes() {
return countryCodes;
}
public void setCountryCodes(List countryCodes) {
this.countryCodes = countryCodes;
}
public InstitutionsSearchRequest options(InstitutionsSearchRequestOptions options) {
this.options = options;
return this;
}
/**
* Get options
* @return options
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "")
public InstitutionsSearchRequestOptions getOptions() {
return options;
}
public void setOptions(InstitutionsSearchRequestOptions options) {
this.options = options;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
InstitutionsSearchRequest institutionsSearchRequest = (InstitutionsSearchRequest) o;
return Objects.equals(this.clientId, institutionsSearchRequest.clientId) &&
Objects.equals(this.secret, institutionsSearchRequest.secret) &&
Objects.equals(this.query, institutionsSearchRequest.query) &&
Objects.equals(this.products, institutionsSearchRequest.products) &&
Objects.equals(this.countryCodes, institutionsSearchRequest.countryCodes) &&
Objects.equals(this.options, institutionsSearchRequest.options);
}
@Override
public int hashCode() {
return Objects.hash(clientId, secret, query, products, countryCodes, options);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class InstitutionsSearchRequest {\n");
sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n");
sb.append(" secret: ").append(toIndentedString(secret)).append("\n");
sb.append(" query: ").append(toIndentedString(query)).append("\n");
sb.append(" products: ").append(toIndentedString(products)).append("\n");
sb.append(" countryCodes: ").append(toIndentedString(countryCodes)).append("\n");
sb.append(" options: ").append(toIndentedString(options)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy