com.plaid.client.model.DepositSwitchGetResponse 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.534.3
*
*
* 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 io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.time.LocalDate;
/**
* DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`
*/
@ApiModel(description = "DepositSwitchGetResponse defines the response schema for `/deposit_switch/get`")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-07-05T19:36:13.426392Z[Etc/UTC]")
public class DepositSwitchGetResponse {
public static final String SERIALIZED_NAME_DEPOSIT_SWITCH_ID = "deposit_switch_id";
@SerializedName(SERIALIZED_NAME_DEPOSIT_SWITCH_ID)
private String depositSwitchId;
public static final String SERIALIZED_NAME_TARGET_ACCOUNT_ID = "target_account_id";
@SerializedName(SERIALIZED_NAME_TARGET_ACCOUNT_ID)
private String targetAccountId;
public static final String SERIALIZED_NAME_TARGET_ITEM_ID = "target_item_id";
@SerializedName(SERIALIZED_NAME_TARGET_ITEM_ID)
private String targetItemId;
/**
* The state, or status, of the deposit switch. - `initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - `processing` – The deposit switch request has been submitted and is being processed. - `completed` – The user's employer has fulfilled the deposit switch request. - `error` – There was an error processing the deposit switch request.
*/
@JsonAdapter(StateEnum.Adapter.class)
public enum StateEnum {
INITIALIZED("initialized"),
PROCESSING("processing"),
COMPLETED("completed"),
ERROR("error");
private String value;
StateEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static StateEnum fromValue(String value) {
for (StateEnum b : StateEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
throw new IllegalArgumentException("Unexpected value '" + value + "'");
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final StateEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public StateEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return StateEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_STATE = "state";
@SerializedName(SERIALIZED_NAME_STATE)
private StateEnum state;
/**
* The method used to make the deposit switch. - `instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch. - `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'
*/
@JsonAdapter(SwitchMethodEnum.Adapter.class)
public enum SwitchMethodEnum {
INSTANT("instant"),
MAIL("mail"),
PDF("pdf"),
NULL("null");
private String value;
SwitchMethodEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static SwitchMethodEnum fromValue(String value) {
for (SwitchMethodEnum b : SwitchMethodEnum.values()) {
if (b.value.equals(value)) {
return b;
}
}
return null;
}
public static class Adapter extends TypeAdapter {
@Override
public void write(final JsonWriter jsonWriter, final SwitchMethodEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public SwitchMethodEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return SwitchMethodEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_SWITCH_METHOD = "switch_method";
@SerializedName(SERIALIZED_NAME_SWITCH_METHOD)
private SwitchMethodEnum switchMethod;
public static final String SERIALIZED_NAME_ACCOUNT_HAS_MULTIPLE_ALLOCATIONS = "account_has_multiple_allocations";
@SerializedName(SERIALIZED_NAME_ACCOUNT_HAS_MULTIPLE_ALLOCATIONS)
private Boolean accountHasMultipleAllocations;
public static final String SERIALIZED_NAME_IS_ALLOCATED_REMAINDER = "is_allocated_remainder";
@SerializedName(SERIALIZED_NAME_IS_ALLOCATED_REMAINDER)
private Boolean isAllocatedRemainder;
public static final String SERIALIZED_NAME_PERCENT_ALLOCATED = "percent_allocated";
@SerializedName(SERIALIZED_NAME_PERCENT_ALLOCATED)
private Double percentAllocated;
public static final String SERIALIZED_NAME_AMOUNT_ALLOCATED = "amount_allocated";
@SerializedName(SERIALIZED_NAME_AMOUNT_ALLOCATED)
private Double amountAllocated;
public static final String SERIALIZED_NAME_EMPLOYER_NAME = "employer_name";
@SerializedName(SERIALIZED_NAME_EMPLOYER_NAME)
private String employerName;
public static final String SERIALIZED_NAME_EMPLOYER_ID = "employer_id";
@SerializedName(SERIALIZED_NAME_EMPLOYER_ID)
private String employerId;
public static final String SERIALIZED_NAME_INSTITUTION_NAME = "institution_name";
@SerializedName(SERIALIZED_NAME_INSTITUTION_NAME)
private String institutionName;
public static final String SERIALIZED_NAME_INSTITUTION_ID = "institution_id";
@SerializedName(SERIALIZED_NAME_INSTITUTION_ID)
private String institutionId;
public static final String SERIALIZED_NAME_DATE_CREATED = "date_created";
@SerializedName(SERIALIZED_NAME_DATE_CREATED)
private LocalDate dateCreated;
public static final String SERIALIZED_NAME_DATE_COMPLETED = "date_completed";
@SerializedName(SERIALIZED_NAME_DATE_COMPLETED)
private LocalDate dateCompleted;
public static final String SERIALIZED_NAME_REQUEST_ID = "request_id";
@SerializedName(SERIALIZED_NAME_REQUEST_ID)
private String requestId;
public DepositSwitchGetResponse depositSwitchId(String depositSwitchId) {
this.depositSwitchId = depositSwitchId;
return this;
}
/**
* The ID of the deposit switch.
* @return depositSwitchId
**/
@ApiModelProperty(required = true, value = "The ID of the deposit switch.")
public String getDepositSwitchId() {
return depositSwitchId;
}
public void setDepositSwitchId(String depositSwitchId) {
this.depositSwitchId = depositSwitchId;
}
public DepositSwitchGetResponse targetAccountId(String targetAccountId) {
this.targetAccountId = targetAccountId;
return this;
}
/**
* The ID of the bank account the direct deposit was switched to.
* @return targetAccountId
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The ID of the bank account the direct deposit was switched to.")
public String getTargetAccountId() {
return targetAccountId;
}
public void setTargetAccountId(String targetAccountId) {
this.targetAccountId = targetAccountId;
}
public DepositSwitchGetResponse targetItemId(String targetItemId) {
this.targetItemId = targetItemId;
return this;
}
/**
* The ID of the Item the direct deposit was switched to.
* @return targetItemId
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The ID of the Item the direct deposit was switched to.")
public String getTargetItemId() {
return targetItemId;
}
public void setTargetItemId(String targetItemId) {
this.targetItemId = targetItemId;
}
public DepositSwitchGetResponse state(StateEnum state) {
this.state = state;
return this;
}
/**
* The state, or status, of the deposit switch. - `initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - `processing` – The deposit switch request has been submitted and is being processed. - `completed` – The user's employer has fulfilled the deposit switch request. - `error` – There was an error processing the deposit switch request.
* @return state
**/
@ApiModelProperty(required = true, value = " The state, or status, of the deposit switch. - `initialized` – The deposit switch has been initialized with the user entering the information required to submit the deposit switch request. - `processing` – The deposit switch request has been submitted and is being processed. - `completed` – The user's employer has fulfilled the deposit switch request. - `error` – There was an error processing the deposit switch request.")
public StateEnum getState() {
return state;
}
public void setState(StateEnum state) {
this.state = state;
}
public DepositSwitchGetResponse switchMethod(SwitchMethodEnum switchMethod) {
this.switchMethod = switchMethod;
return this;
}
/**
* The method used to make the deposit switch. - `instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch. - `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'
* @return switchMethod
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The method used to make the deposit switch. - `instant` – User instantly switched their direct deposit to a new or existing bank account by connecting their payroll or employer account. - `mail` – User requested that Plaid contact their employer by mail to make the direct deposit switch. - `pdf` – User generated a PDF or email to be sent to their employer with the information necessary to make the deposit switch.'")
public SwitchMethodEnum getSwitchMethod() {
return switchMethod;
}
public void setSwitchMethod(SwitchMethodEnum switchMethod) {
this.switchMethod = switchMethod;
}
public DepositSwitchGetResponse accountHasMultipleAllocations(Boolean accountHasMultipleAllocations) {
this.accountHasMultipleAllocations = accountHasMultipleAllocations;
return this;
}
/**
* When `true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed.
* @return accountHasMultipleAllocations
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "When `true`, user’s direct deposit goes to multiple banks. When false, user’s direct deposit only goes to the target account. Always `null` if the deposit switch has not been completed.")
public Boolean getAccountHasMultipleAllocations() {
return accountHasMultipleAllocations;
}
public void setAccountHasMultipleAllocations(Boolean accountHasMultipleAllocations) {
this.accountHasMultipleAllocations = accountHasMultipleAllocations;
}
public DepositSwitchGetResponse isAllocatedRemainder(Boolean isAllocatedRemainder) {
this.isAllocatedRemainder = isAllocatedRemainder;
return this;
}
/**
* When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed.
* @return isAllocatedRemainder
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "When `true`, the target account is allocated the remainder of direct deposit after all other allocations have been deducted. When `false`, user’s direct deposit is allocated as a percent or amount. Always `null` if the deposit switch has not been completed.")
public Boolean getIsAllocatedRemainder() {
return isAllocatedRemainder;
}
public void setIsAllocatedRemainder(Boolean isAllocatedRemainder) {
this.isAllocatedRemainder = isAllocatedRemainder;
}
public DepositSwitchGetResponse percentAllocated(Double percentAllocated) {
this.percentAllocated = percentAllocated;
return this;
}
/**
* The percentage of direct deposit allocated to the target account. Always `null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true.
* @return percentAllocated
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The percentage of direct deposit allocated to the target account. Always `null` if the target account is not allocated a percentage or if the deposit switch has not been completed or if `is_allocated_remainder` is true.")
public Double getPercentAllocated() {
return percentAllocated;
}
public void setPercentAllocated(Double percentAllocated) {
this.percentAllocated = percentAllocated;
}
public DepositSwitchGetResponse amountAllocated(Double amountAllocated) {
this.amountAllocated = amountAllocated;
return this;
}
/**
* The dollar amount of direct deposit allocated to the target account. Always `null` if the target account is not allocated an amount or if the deposit switch has not been completed.
* @return amountAllocated
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The dollar amount of direct deposit allocated to the target account. Always `null` if the target account is not allocated an amount or if the deposit switch has not been completed.")
public Double getAmountAllocated() {
return amountAllocated;
}
public void setAmountAllocated(Double amountAllocated) {
this.amountAllocated = amountAllocated;
}
public DepositSwitchGetResponse employerName(String employerName) {
this.employerName = employerName;
return this;
}
/**
* The name of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
* @return employerName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The name of the employer selected by the user. If the user did not select an employer, the value returned is `null`.")
public String getEmployerName() {
return employerName;
}
public void setEmployerName(String employerName) {
this.employerName = employerName;
}
public DepositSwitchGetResponse employerId(String employerId) {
this.employerId = employerId;
return this;
}
/**
* The ID of the employer selected by the user. If the user did not select an employer, the value returned is `null`.
* @return employerId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The ID of the employer selected by the user. If the user did not select an employer, the value returned is `null`.")
public String getEmployerId() {
return employerId;
}
public void setEmployerId(String employerId) {
this.employerId = employerId;
}
public DepositSwitchGetResponse institutionName(String institutionName) {
this.institutionName = institutionName;
return this;
}
/**
* The name of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
* @return institutionName
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The name of the institution selected by the user. If the user did not select an institution, the value returned is `null`.")
public String getInstitutionName() {
return institutionName;
}
public void setInstitutionName(String institutionName) {
this.institutionName = institutionName;
}
public DepositSwitchGetResponse institutionId(String institutionId) {
this.institutionId = institutionId;
return this;
}
/**
* The ID of the institution selected by the user. If the user did not select an institution, the value returned is `null`.
* @return institutionId
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The ID of the institution selected by the user. If the user did not select an institution, the value returned is `null`.")
public String getInstitutionId() {
return institutionId;
}
public void setInstitutionId(String institutionId) {
this.institutionId = institutionId;
}
public DepositSwitchGetResponse dateCreated(LocalDate dateCreated) {
this.dateCreated = dateCreated;
return this;
}
/**
* [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was created.
* @return dateCreated
**/
@ApiModelProperty(required = true, value = "[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was created. ")
public LocalDate getDateCreated() {
return dateCreated;
}
public void setDateCreated(LocalDate dateCreated) {
this.dateCreated = dateCreated;
}
public DepositSwitchGetResponse dateCompleted(LocalDate dateCompleted) {
this.dateCompleted = dateCompleted;
return this;
}
/**
* [ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always `null` if the deposit switch has not been completed.
* @return dateCompleted
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "[ISO 8601](https://wikipedia.org/wiki/ISO_8601) date the deposit switch was completed. Always `null` if the deposit switch has not been completed. ")
public LocalDate getDateCompleted() {
return dateCompleted;
}
public void setDateCompleted(LocalDate dateCompleted) {
this.dateCompleted = dateCompleted;
}
public DepositSwitchGetResponse requestId(String requestId) {
this.requestId = requestId;
return this;
}
/**
* A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
* @return requestId
**/
@ApiModelProperty(required = true, value = "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.")
public String getRequestId() {
return requestId;
}
public void setRequestId(String requestId) {
this.requestId = requestId;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
DepositSwitchGetResponse depositSwitchGetResponse = (DepositSwitchGetResponse) o;
return Objects.equals(this.depositSwitchId, depositSwitchGetResponse.depositSwitchId) &&
Objects.equals(this.targetAccountId, depositSwitchGetResponse.targetAccountId) &&
Objects.equals(this.targetItemId, depositSwitchGetResponse.targetItemId) &&
Objects.equals(this.state, depositSwitchGetResponse.state) &&
Objects.equals(this.switchMethod, depositSwitchGetResponse.switchMethod) &&
Objects.equals(this.accountHasMultipleAllocations, depositSwitchGetResponse.accountHasMultipleAllocations) &&
Objects.equals(this.isAllocatedRemainder, depositSwitchGetResponse.isAllocatedRemainder) &&
Objects.equals(this.percentAllocated, depositSwitchGetResponse.percentAllocated) &&
Objects.equals(this.amountAllocated, depositSwitchGetResponse.amountAllocated) &&
Objects.equals(this.employerName, depositSwitchGetResponse.employerName) &&
Objects.equals(this.employerId, depositSwitchGetResponse.employerId) &&
Objects.equals(this.institutionName, depositSwitchGetResponse.institutionName) &&
Objects.equals(this.institutionId, depositSwitchGetResponse.institutionId) &&
Objects.equals(this.dateCreated, depositSwitchGetResponse.dateCreated) &&
Objects.equals(this.dateCompleted, depositSwitchGetResponse.dateCompleted) &&
Objects.equals(this.requestId, depositSwitchGetResponse.requestId);
}
@Override
public int hashCode() {
return Objects.hash(depositSwitchId, targetAccountId, targetItemId, state, switchMethod, accountHasMultipleAllocations, isAllocatedRemainder, percentAllocated, amountAllocated, employerName, employerId, institutionName, institutionId, dateCreated, dateCompleted, requestId);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class DepositSwitchGetResponse {\n");
sb.append(" depositSwitchId: ").append(toIndentedString(depositSwitchId)).append("\n");
sb.append(" targetAccountId: ").append(toIndentedString(targetAccountId)).append("\n");
sb.append(" targetItemId: ").append(toIndentedString(targetItemId)).append("\n");
sb.append(" state: ").append(toIndentedString(state)).append("\n");
sb.append(" switchMethod: ").append(toIndentedString(switchMethod)).append("\n");
sb.append(" accountHasMultipleAllocations: ").append(toIndentedString(accountHasMultipleAllocations)).append("\n");
sb.append(" isAllocatedRemainder: ").append(toIndentedString(isAllocatedRemainder)).append("\n");
sb.append(" percentAllocated: ").append(toIndentedString(percentAllocated)).append("\n");
sb.append(" amountAllocated: ").append(toIndentedString(amountAllocated)).append("\n");
sb.append(" employerName: ").append(toIndentedString(employerName)).append("\n");
sb.append(" employerId: ").append(toIndentedString(employerId)).append("\n");
sb.append(" institutionName: ").append(toIndentedString(institutionName)).append("\n");
sb.append(" institutionId: ").append(toIndentedString(institutionId)).append("\n");
sb.append(" dateCreated: ").append(toIndentedString(dateCreated)).append("\n");
sb.append(" dateCompleted: ").append(toIndentedString(dateCompleted)).append("\n");
sb.append(" requestId: ").append(toIndentedString(requestId)).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