com.konfigthis.client.model.OptionsSymbol Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of snaptrade-java-sdk Show documentation
Show all versions of snaptrade-java-sdk Show documentation
Connect brokerage accounts to your app for live positions and trading
This library was generated by https://konfigthis.com
/*
* SnapTrade
* Connect brokerage accounts to your app for live positions and trading
*
* The version of the OpenAPI document: 1.0.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by Konfig (https://konfigthis.com).
* Do not edit the class manually.
*/
package com.konfigthis.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.konfigthis.client.model.UnderlyingSymbol;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.IOException;
import java.time.LocalDate;
import java.util.UUID;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import com.google.gson.JsonArray;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import com.google.gson.TypeAdapterFactory;
import com.google.gson.reflect.TypeToken;
import org.apache.commons.lang3.StringUtils;
import java.lang.reflect.Type;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import com.konfigthis.client.JSON;
/**
* Uniquely describes an option security + exchange combination across all brokerages.
*/
@ApiModel(description = "Uniquely describes an option security + exchange combination across all brokerages.")@javax.annotation.Generated(value = "Generated by https://konfigthis.com")
public class OptionsSymbol {
public static final String SERIALIZED_NAME_ID = "id";
@SerializedName(SERIALIZED_NAME_ID)
private UUID id;
public static final String SERIALIZED_NAME_TICKER = "ticker";
@SerializedName(SERIALIZED_NAME_TICKER)
private String ticker;
/**
* The type of option. Either \"CALL\" or \"PUT\".
*/
@JsonAdapter(OptionTypeEnum.Adapter.class)
public enum OptionTypeEnum {
CALL("CALL"),
PUT("PUT");
private String value;
OptionTypeEnum(String value) {
this.value = value;
}
public String getValue() {
return value;
}
@Override
public String toString() {
return String.valueOf(value);
}
public static OptionTypeEnum fromValue(String value) {
for (OptionTypeEnum b : OptionTypeEnum.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 OptionTypeEnum enumeration) throws IOException {
jsonWriter.value(enumeration.getValue());
}
@Override
public OptionTypeEnum read(final JsonReader jsonReader) throws IOException {
String value = jsonReader.nextString();
return OptionTypeEnum.fromValue(value);
}
}
}
public static final String SERIALIZED_NAME_OPTION_TYPE = "option_type";
@SerializedName(SERIALIZED_NAME_OPTION_TYPE)
private OptionTypeEnum optionType;
public static final String SERIALIZED_NAME_STRIKE_PRICE = "strike_price";
@SerializedName(SERIALIZED_NAME_STRIKE_PRICE)
private Double strikePrice;
public static final String SERIALIZED_NAME_EXPIRATION_DATE = "expiration_date";
@SerializedName(SERIALIZED_NAME_EXPIRATION_DATE)
private LocalDate expirationDate;
public static final String SERIALIZED_NAME_IS_MINI_OPTION = "is_mini_option";
@SerializedName(SERIALIZED_NAME_IS_MINI_OPTION)
private Boolean isMiniOption;
public static final String SERIALIZED_NAME_UNDERLYING_SYMBOL = "underlying_symbol";
@SerializedName(SERIALIZED_NAME_UNDERLYING_SYMBOL)
private UnderlyingSymbol underlyingSymbol;
public OptionsSymbol() {
}
public OptionsSymbol id(UUID id) {
this.id = id;
return this;
}
/**
* Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.
* @return id
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "2bcd7cc3-e922-4976-bce1-9858296801c3", required = true, value = "Unique identifier for the option symbol within SnapTrade. This is the ID used to reference the symbol in SnapTrade API calls.")
public UUID getId() {
return id;
}
public void setId(UUID id) {
this.id = id;
}
public OptionsSymbol ticker(String ticker) {
this.ticker = ticker;
return this;
}
/**
* The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.
* @return ticker
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "SPY 220819P00200000", required = true, value = "The [OCC symbol](https://en.wikipedia.org/wiki/Option_symbol) for the option.")
public String getTicker() {
return ticker;
}
public void setTicker(String ticker) {
this.ticker = ticker;
}
public OptionsSymbol optionType(OptionTypeEnum optionType) {
this.optionType = optionType;
return this;
}
/**
* The type of option. Either \"CALL\" or \"PUT\".
* @return optionType
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "CALL", required = true, value = "The type of option. Either \"CALL\" or \"PUT\".")
public OptionTypeEnum getOptionType() {
return optionType;
}
public void setOptionType(OptionTypeEnum optionType) {
this.optionType = optionType;
}
public OptionsSymbol strikePrice(Double strikePrice) {
this.strikePrice = strikePrice;
return this;
}
public OptionsSymbol strikePrice(Integer strikePrice) {
this.strikePrice = strikePrice.doubleValue();
return this;
}
/**
* The option strike price.
* @return strikePrice
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "200", required = true, value = "The option strike price.")
public Double getStrikePrice() {
return strikePrice;
}
public void setStrikePrice(Double strikePrice) {
this.strikePrice = strikePrice;
}
public OptionsSymbol expirationDate(LocalDate expirationDate) {
this.expirationDate = expirationDate;
return this;
}
/**
* The option expiration date.
* @return expirationDate
**/
@javax.annotation.Nonnull
@ApiModelProperty(example = "Fri Dec 18 00:00:00 UTC 2026", required = true, value = "The option expiration date.")
public LocalDate getExpirationDate() {
return expirationDate;
}
public void setExpirationDate(LocalDate expirationDate) {
this.expirationDate = expirationDate;
}
public OptionsSymbol isMiniOption(Boolean isMiniOption) {
this.isMiniOption = isMiniOption;
return this;
}
/**
* Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.
* @return isMiniOption
**/
@javax.annotation.Nullable
@ApiModelProperty(example = "false", value = "Whether the option is a mini option. Mini options have 10 underlying shares per contract instead of the standard 100.")
public Boolean getIsMiniOption() {
return isMiniOption;
}
public void setIsMiniOption(Boolean isMiniOption) {
this.isMiniOption = isMiniOption;
}
public OptionsSymbol underlyingSymbol(UnderlyingSymbol underlyingSymbol) {
this.underlyingSymbol = underlyingSymbol;
return this;
}
/**
* Get underlyingSymbol
* @return underlyingSymbol
**/
@javax.annotation.Nonnull
@ApiModelProperty(required = true, value = "")
public UnderlyingSymbol getUnderlyingSymbol() {
return underlyingSymbol;
}
public void setUnderlyingSymbol(UnderlyingSymbol underlyingSymbol) {
this.underlyingSymbol = underlyingSymbol;
}
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
private Map additionalProperties;
/**
* Set the additional (undeclared) property with the specified name and value.
* If the property does not already exist, create it otherwise replace it.
*
* @param key name of the property
* @param value value of the property
* @return the OptionsSymbol instance itself
*/
public OptionsSymbol putAdditionalProperty(String key, Object value) {
if (this.additionalProperties == null) {
this.additionalProperties = new HashMap();
}
this.additionalProperties.put(key, value);
return this;
}
/**
* Return the additional (undeclared) property.
*
* @return a map of objects
*/
public Map getAdditionalProperties() {
return additionalProperties;
}
/**
* Return the additional (undeclared) property with the specified name.
*
* @param key name of the property
* @return an object
*/
public Object getAdditionalProperty(String key) {
if (this.additionalProperties == null) {
return null;
}
return this.additionalProperties.get(key);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OptionsSymbol optionsSymbol = (OptionsSymbol) o;
return Objects.equals(this.id, optionsSymbol.id) &&
Objects.equals(this.ticker, optionsSymbol.ticker) &&
Objects.equals(this.optionType, optionsSymbol.optionType) &&
Objects.equals(this.strikePrice, optionsSymbol.strikePrice) &&
Objects.equals(this.expirationDate, optionsSymbol.expirationDate) &&
Objects.equals(this.isMiniOption, optionsSymbol.isMiniOption) &&
Objects.equals(this.underlyingSymbol, optionsSymbol.underlyingSymbol)&&
Objects.equals(this.additionalProperties, optionsSymbol.additionalProperties);
}
@Override
public int hashCode() {
return Objects.hash(id, ticker, optionType, strikePrice, expirationDate, isMiniOption, underlyingSymbol, additionalProperties);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OptionsSymbol {\n");
sb.append(" id: ").append(toIndentedString(id)).append("\n");
sb.append(" ticker: ").append(toIndentedString(ticker)).append("\n");
sb.append(" optionType: ").append(toIndentedString(optionType)).append("\n");
sb.append(" strikePrice: ").append(toIndentedString(strikePrice)).append("\n");
sb.append(" expirationDate: ").append(toIndentedString(expirationDate)).append("\n");
sb.append(" isMiniOption: ").append(toIndentedString(isMiniOption)).append("\n");
sb.append(" underlyingSymbol: ").append(toIndentedString(underlyingSymbol)).append("\n");
sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).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 ");
}
public static HashSet openapiFields;
public static HashSet openapiRequiredFields;
static {
// a set of all properties/fields (JSON key names)
openapiFields = new HashSet();
openapiFields.add("id");
openapiFields.add("ticker");
openapiFields.add("option_type");
openapiFields.add("strike_price");
openapiFields.add("expiration_date");
openapiFields.add("is_mini_option");
openapiFields.add("underlying_symbol");
// a set of required properties/fields (JSON key names)
openapiRequiredFields = new HashSet();
openapiRequiredFields.add("id");
openapiRequiredFields.add("ticker");
openapiRequiredFields.add("option_type");
openapiRequiredFields.add("strike_price");
openapiRequiredFields.add("expiration_date");
openapiRequiredFields.add("underlying_symbol");
}
/**
* Validates the JSON Object and throws an exception if issues found
*
* @param jsonObj JSON Object
* @throws IOException if the JSON Object is invalid with respect to OptionsSymbol
*/
public static void validateJsonObject(JsonObject jsonObj) throws IOException {
if (jsonObj == null) {
if (!OptionsSymbol.openapiRequiredFields.isEmpty()) { // has required fields but JSON object is null
throw new IllegalArgumentException(String.format("The required field(s) %s in OptionsSymbol is not found in the empty JSON string", OptionsSymbol.openapiRequiredFields.toString()));
}
}
// check to make sure all required properties/fields are present in the JSON string
for (String requiredField : OptionsSymbol.openapiRequiredFields) {
if (jsonObj.get(requiredField) == null) {
throw new IllegalArgumentException(String.format("The required field `%s` is not found in the JSON string: %s", requiredField, jsonObj.toString()));
}
}
if (!jsonObj.get("id").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `id` to be a primitive type in the JSON string but got `%s`", jsonObj.get("id").toString()));
}
if (!jsonObj.get("ticker").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `ticker` to be a primitive type in the JSON string but got `%s`", jsonObj.get("ticker").toString()));
}
if (!jsonObj.get("option_type").isJsonPrimitive()) {
throw new IllegalArgumentException(String.format("Expected the field `option_type` to be a primitive type in the JSON string but got `%s`", jsonObj.get("option_type").toString()));
}
// validate the required field `underlying_symbol`
UnderlyingSymbol.validateJsonObject(jsonObj.getAsJsonObject("underlying_symbol"));
}
public static class CustomTypeAdapterFactory implements TypeAdapterFactory {
@SuppressWarnings("unchecked")
@Override
public TypeAdapter create(Gson gson, TypeToken type) {
if (!OptionsSymbol.class.isAssignableFrom(type.getRawType())) {
return null; // this class only serializes 'OptionsSymbol' and its subtypes
}
final TypeAdapter elementAdapter = gson.getAdapter(JsonElement.class);
final TypeAdapter thisAdapter
= gson.getDelegateAdapter(this, TypeToken.get(OptionsSymbol.class));
return (TypeAdapter) new TypeAdapter() {
@Override
public void write(JsonWriter out, OptionsSymbol value) throws IOException {
JsonObject obj = thisAdapter.toJsonTree(value).getAsJsonObject();
obj.remove("additionalProperties");
// serialize additonal properties
if (value.getAdditionalProperties() != null) {
for (Map.Entry entry : value.getAdditionalProperties().entrySet()) {
if (entry.getValue() instanceof String)
obj.addProperty(entry.getKey(), (String) entry.getValue());
else if (entry.getValue() instanceof Number)
obj.addProperty(entry.getKey(), (Number) entry.getValue());
else if (entry.getValue() instanceof Boolean)
obj.addProperty(entry.getKey(), (Boolean) entry.getValue());
else if (entry.getValue() instanceof Character)
obj.addProperty(entry.getKey(), (Character) entry.getValue());
else if (entry.getValue() == null) {
obj.addProperty(entry.getKey(), (String) null);
} else {
obj.add(entry.getKey(), gson.toJsonTree(entry.getValue()).getAsJsonObject());
}
}
}
elementAdapter.write(out, obj);
}
@Override
public OptionsSymbol read(JsonReader in) throws IOException {
JsonObject jsonObj = elementAdapter.read(in).getAsJsonObject();
validateJsonObject(jsonObj);
// store additional fields in the deserialized instance
OptionsSymbol instance = thisAdapter.fromJsonTree(jsonObj);
for (Map.Entry entry : jsonObj.entrySet()) {
if (!openapiFields.contains(entry.getKey())) {
if (entry.getValue().isJsonPrimitive()) { // primitive type
if (entry.getValue().getAsJsonPrimitive().isString())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsString());
else if (entry.getValue().getAsJsonPrimitive().isNumber())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsNumber());
else if (entry.getValue().getAsJsonPrimitive().isBoolean())
instance.putAdditionalProperty(entry.getKey(), entry.getValue().getAsBoolean());
else
throw new IllegalArgumentException(String.format("The field `%s` has unknown primitive type. Value: %s", entry.getKey(), entry.getValue().toString()));
} else if (entry.getValue().isJsonArray()) {
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), List.class));
} else { // JSON object
instance.putAdditionalProperty(entry.getKey(), gson.fromJson(entry.getValue(), HashMap.class));
}
}
}
return instance;
}
}.nullSafe();
}
}
/**
* Create an instance of OptionsSymbol given an JSON string
*
* @param jsonString JSON string
* @return An instance of OptionsSymbol
* @throws IOException if the JSON string is invalid with respect to OptionsSymbol
*/
public static OptionsSymbol fromJson(String jsonString) throws IOException {
return JSON.getGson().fromJson(jsonString, OptionsSymbol.class);
}
/**
* Convert an instance of OptionsSymbol to an JSON string
*
* @return JSON string
*/
public String toJson() {
return JSON.getGson().toJson(this);
}
}