com.plaid.client.model.Holding 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.565.0
*
*
* 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;
import java.time.OffsetDateTime;
/**
* A securities holding at an institution.
*/
@ApiModel(description = "A securities holding at an institution.")
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-09-17T16:42:02.150702Z[Etc/UTC]")
public class Holding {
public static final String SERIALIZED_NAME_ACCOUNT_ID = "account_id";
@SerializedName(SERIALIZED_NAME_ACCOUNT_ID)
private String accountId;
public static final String SERIALIZED_NAME_SECURITY_ID = "security_id";
@SerializedName(SERIALIZED_NAME_SECURITY_ID)
private String securityId;
public static final String SERIALIZED_NAME_INSTITUTION_PRICE = "institution_price";
@SerializedName(SERIALIZED_NAME_INSTITUTION_PRICE)
private Double institutionPrice;
public static final String SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF = "institution_price_as_of";
@SerializedName(SERIALIZED_NAME_INSTITUTION_PRICE_AS_OF)
private LocalDate institutionPriceAsOf;
public static final String SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME = "institution_price_datetime";
@SerializedName(SERIALIZED_NAME_INSTITUTION_PRICE_DATETIME)
private OffsetDateTime institutionPriceDatetime;
public static final String SERIALIZED_NAME_INSTITUTION_VALUE = "institution_value";
@SerializedName(SERIALIZED_NAME_INSTITUTION_VALUE)
private Double institutionValue;
public static final String SERIALIZED_NAME_COST_BASIS = "cost_basis";
@SerializedName(SERIALIZED_NAME_COST_BASIS)
private Double costBasis;
public static final String SERIALIZED_NAME_QUANTITY = "quantity";
@SerializedName(SERIALIZED_NAME_QUANTITY)
private Double quantity;
public static final String SERIALIZED_NAME_ISO_CURRENCY_CODE = "iso_currency_code";
@SerializedName(SERIALIZED_NAME_ISO_CURRENCY_CODE)
private String isoCurrencyCode;
public static final String SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE = "unofficial_currency_code";
@SerializedName(SERIALIZED_NAME_UNOFFICIAL_CURRENCY_CODE)
private String unofficialCurrencyCode;
public static final String SERIALIZED_NAME_VESTED_QUANTITY = "vested_quantity";
@SerializedName(SERIALIZED_NAME_VESTED_QUANTITY)
private Double vestedQuantity;
public static final String SERIALIZED_NAME_VESTED_VALUE = "vested_value";
@SerializedName(SERIALIZED_NAME_VESTED_VALUE)
private Double vestedValue;
public Holding accountId(String accountId) {
this.accountId = accountId;
return this;
}
/**
* The Plaid `account_id` associated with the holding.
* @return accountId
**/
@ApiModelProperty(required = true, value = "The Plaid `account_id` associated with the holding.")
public String getAccountId() {
return accountId;
}
public void setAccountId(String accountId) {
this.accountId = accountId;
}
public Holding securityId(String securityId) {
this.securityId = securityId;
return this;
}
/**
* The Plaid `security_id` associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The `security_id` for the same security will typically be the same across different institutions, but this is not guaranteed. The `security_id` does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
* @return securityId
**/
@ApiModelProperty(required = true, value = "The Plaid `security_id` associated with the holding. Security data is not specific to a user's account; any user who held the same security at the same financial institution at the same time would have identical security data. The `security_id` for the same security will typically be the same across different institutions, but this is not guaranteed. The `security_id` does not typically change, but may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.")
public String getSecurityId() {
return securityId;
}
public void setSecurityId(String securityId) {
this.securityId = securityId;
}
public Holding institutionPrice(Double institutionPrice) {
this.institutionPrice = institutionPrice;
return this;
}
/**
* The last price given by the institution for this security.
* @return institutionPrice
**/
@ApiModelProperty(required = true, value = "The last price given by the institution for this security.")
public Double getInstitutionPrice() {
return institutionPrice;
}
public void setInstitutionPrice(Double institutionPrice) {
this.institutionPrice = institutionPrice;
}
public Holding institutionPriceAsOf(LocalDate institutionPriceAsOf) {
this.institutionPriceAsOf = institutionPriceAsOf;
return this;
}
/**
* The date at which `institution_price` was current.
* @return institutionPriceAsOf
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The date at which `institution_price` was current.")
public LocalDate getInstitutionPriceAsOf() {
return institutionPriceAsOf;
}
public void setInstitutionPriceAsOf(LocalDate institutionPriceAsOf) {
this.institutionPriceAsOf = institutionPriceAsOf;
}
public Holding institutionPriceDatetime(OffsetDateTime institutionPriceDatetime) {
this.institutionPriceDatetime = institutionPriceDatetime;
return this;
}
/**
* Date and time at which `institution_price` was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).
* @return institutionPriceDatetime
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "Date and time at which `institution_price` was current, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00). ")
public OffsetDateTime getInstitutionPriceDatetime() {
return institutionPriceDatetime;
}
public void setInstitutionPriceDatetime(OffsetDateTime institutionPriceDatetime) {
this.institutionPriceDatetime = institutionPriceDatetime;
}
public Holding institutionValue(Double institutionValue) {
this.institutionValue = institutionValue;
return this;
}
/**
* The value of the holding, as reported by the institution.
* @return institutionValue
**/
@ApiModelProperty(required = true, value = "The value of the holding, as reported by the institution.")
public Double getInstitutionValue() {
return institutionValue;
}
public void setInstitutionValue(Double institutionValue) {
this.institutionValue = institutionValue;
}
public Holding costBasis(Double costBasis) {
this.costBasis = costBasis;
return this;
}
/**
* The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).
* @return costBasis
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The total cost basis of the holding (e.g., the total amount spent to acquire all assets currently in the holding).")
public Double getCostBasis() {
return costBasis;
}
public void setCostBasis(Double costBasis) {
this.costBasis = costBasis;
}
public Holding quantity(Double quantity) {
this.quantity = quantity;
return this;
}
/**
* The total quantity of the asset held, as reported by the financial institution. If the security is an option, `quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.
* @return quantity
**/
@ApiModelProperty(required = true, value = "The total quantity of the asset held, as reported by the financial institution. If the security is an option, `quantity` will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.")
public Double getQuantity() {
return quantity;
}
public void setQuantity(Double quantity) {
this.quantity = quantity;
}
public Holding isoCurrencyCode(String isoCurrencyCode) {
this.isoCurrencyCode = isoCurrencyCode;
return this;
}
/**
* The ISO-4217 currency code of the holding. Always `null` if `unofficial_currency_code` is non-`null`.
* @return isoCurrencyCode
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The ISO-4217 currency code of the holding. Always `null` if `unofficial_currency_code` is non-`null`.")
public String getIsoCurrencyCode() {
return isoCurrencyCode;
}
public void setIsoCurrencyCode(String isoCurrencyCode) {
this.isoCurrencyCode = isoCurrencyCode;
}
public Holding unofficialCurrencyCode(String unofficialCurrencyCode) {
this.unofficialCurrencyCode = unofficialCurrencyCode;
return this;
}
/**
* The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
* @return unofficialCurrencyCode
**/
@javax.annotation.Nullable
@ApiModelProperty(required = true, value = "The unofficial currency code associated with the holding. Always `null` if `iso_currency_code` is non-`null`. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries. See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s. ")
public String getUnofficialCurrencyCode() {
return unofficialCurrencyCode;
}
public void setUnofficialCurrencyCode(String unofficialCurrencyCode) {
this.unofficialCurrencyCode = unofficialCurrencyCode;
}
public Holding vestedQuantity(Double vestedQuantity) {
this.vestedQuantity = vestedQuantity;
return this;
}
/**
* The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with [equities](https://plaid.com/docs/api/products/investments/#investments-holdings-get-response-securities-type).
* @return vestedQuantity
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The total quantity of vested assets held, as reported by the financial institution. Vested assets are only associated with [equities](https://plaid.com/docs/api/products/investments/#investments-holdings-get-response-securities-type).")
public Double getVestedQuantity() {
return vestedQuantity;
}
public void setVestedQuantity(Double vestedQuantity) {
this.vestedQuantity = vestedQuantity;
}
public Holding vestedValue(Double vestedValue) {
this.vestedValue = vestedValue;
return this;
}
/**
* The value of the vested holdings as reported by the institution.
* @return vestedValue
**/
@javax.annotation.Nullable
@ApiModelProperty(value = "The value of the vested holdings as reported by the institution.")
public Double getVestedValue() {
return vestedValue;
}
public void setVestedValue(Double vestedValue) {
this.vestedValue = vestedValue;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Holding holding = (Holding) o;
return Objects.equals(this.accountId, holding.accountId) &&
Objects.equals(this.securityId, holding.securityId) &&
Objects.equals(this.institutionPrice, holding.institutionPrice) &&
Objects.equals(this.institutionPriceAsOf, holding.institutionPriceAsOf) &&
Objects.equals(this.institutionPriceDatetime, holding.institutionPriceDatetime) &&
Objects.equals(this.institutionValue, holding.institutionValue) &&
Objects.equals(this.costBasis, holding.costBasis) &&
Objects.equals(this.quantity, holding.quantity) &&
Objects.equals(this.isoCurrencyCode, holding.isoCurrencyCode) &&
Objects.equals(this.unofficialCurrencyCode, holding.unofficialCurrencyCode) &&
Objects.equals(this.vestedQuantity, holding.vestedQuantity) &&
Objects.equals(this.vestedValue, holding.vestedValue);
}
@Override
public int hashCode() {
return Objects.hash(accountId, securityId, institutionPrice, institutionPriceAsOf, institutionPriceDatetime, institutionValue, costBasis, quantity, isoCurrencyCode, unofficialCurrencyCode, vestedQuantity, vestedValue);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class Holding {\n");
sb.append(" accountId: ").append(toIndentedString(accountId)).append("\n");
sb.append(" securityId: ").append(toIndentedString(securityId)).append("\n");
sb.append(" institutionPrice: ").append(toIndentedString(institutionPrice)).append("\n");
sb.append(" institutionPriceAsOf: ").append(toIndentedString(institutionPriceAsOf)).append("\n");
sb.append(" institutionPriceDatetime: ").append(toIndentedString(institutionPriceDatetime)).append("\n");
sb.append(" institutionValue: ").append(toIndentedString(institutionValue)).append("\n");
sb.append(" costBasis: ").append(toIndentedString(costBasis)).append("\n");
sb.append(" quantity: ").append(toIndentedString(quantity)).append("\n");
sb.append(" isoCurrencyCode: ").append(toIndentedString(isoCurrencyCode)).append("\n");
sb.append(" unofficialCurrencyCode: ").append(toIndentedString(unofficialCurrencyCode)).append("\n");
sb.append(" vestedQuantity: ").append(toIndentedString(vestedQuantity)).append("\n");
sb.append(" vestedValue: ").append(toIndentedString(vestedValue)).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