com.factset.sdk.FactSetFundamentals.models.FundamentalsRequest Maven / Gradle / Ivy

Go to download
/*
 * FactSet Fundamentals API
 * Gain access to current, comprehensive, and comparative information on securities in worldwide developed and emerging markets. Composed of annual and interim/quarterly data, detailed historical financial statement content, per share data, and calculated ratios, FactSet Fundamentals provides you with the information you need for a global investment perspective. 
 *
 * The version of the OpenAPI document: 1.0.2
 * Contact: [email protected]
 *
 * 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.factset.sdk.FactSetFundamentals.models;

import java.util.Objects;
import java.util.Arrays;
import java.util.Map;
import java.util.HashMap;
import com.factset.sdk.FactSetFundamentals.models.Periodicity;
import com.factset.sdk.FactSetFundamentals.models.Restated;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.fasterxml.jackson.annotation.JsonValue;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.factset.sdk.FactSetFundamentals.JSON;


/**
 * Fundamentals request body elements
 */
@ApiModel(description = "Fundamentals request body elements")
@JsonPropertyOrder({
  FundamentalsRequest.JSON_PROPERTY_IDS,
  FundamentalsRequest.JSON_PROPERTY_PERIODICITY,
  FundamentalsRequest.JSON_PROPERTY_FISCAL_PERIOD_START,
  FundamentalsRequest.JSON_PROPERTY_FISCAL_PERIOD_END,
  FundamentalsRequest.JSON_PROPERTY_METRICS,
  FundamentalsRequest.JSON_PROPERTY_CURRENCY,
  FundamentalsRequest.JSON_PROPERTY_RESTATED
})
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
public class FundamentalsRequest implements Serializable {
  private static final long serialVersionUID = 1L;

  public static final String JSON_PROPERTY_IDS = "ids";
  private java.util.List ids = new java.util.ArrayList<>();

  public static final String JSON_PROPERTY_PERIODICITY = "periodicity";
  private Periodicity periodicity = Periodicity.QTR;

  public static final String JSON_PROPERTY_FISCAL_PERIOD_START = "fiscalPeriodStart";
  private String fiscalPeriodStart;

  public static final String JSON_PROPERTY_FISCAL_PERIOD_END = "fiscalPeriodEnd";
  private String fiscalPeriodEnd;

  public static final String JSON_PROPERTY_METRICS = "metrics";
  private java.util.List metrics = new java.util.ArrayList<>();

  public static final String JSON_PROPERTY_CURRENCY = "currency";
  private String currency = "LOCAL";

  public static final String JSON_PROPERTY_RESTATED = "restated";
  private Restated restated = Restated.RP;


  public FundamentalsRequest ids(java.util.List ids) {
    this.ids = ids;
    return this;
  }

  public FundamentalsRequest addIdsItem(String idsItem) {
    this.ids.add(idsItem);
    return this;
  }

   /**
   * Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. 
   * @return ids
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "[\"FDS-US\"]", required = true, value = "Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input. ")
  @JsonProperty(JSON_PROPERTY_IDS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public java.util.List getIds() {
    return ids;
  }


  @JsonProperty(JSON_PROPERTY_IDS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setIds(java.util.List ids) {
    this.ids = ids;
  }


  public FundamentalsRequest periodicity(Periodicity periodicity) {
    this.periodicity = periodicity;
    return this;
  }

   /**
   * Get periodicity
   * @return periodicity
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_PERIODICITY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Periodicity getPeriodicity() {
    return periodicity;
  }


  @JsonProperty(JSON_PROPERTY_PERIODICITY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setPeriodicity(Periodicity periodicity) {
    this.periodicity = periodicity;
  }


  public FundamentalsRequest fiscalPeriodStart(String fiscalPeriodStart) {
    this.fiscalPeriodStart = fiscalPeriodStart;
    return this;
  }

   /**
   * Fiscal period start expressed as YYYY-MM-DD.  Calendar date that will fall back to most recent completed period during resolution. 
   * @return fiscalPeriodStart
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "2017-09-01", value = "Fiscal period start expressed as YYYY-MM-DD.  Calendar date that will fall back to most recent completed period during resolution. ")
  @JsonProperty(JSON_PROPERTY_FISCAL_PERIOD_START)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFiscalPeriodStart() {
    return fiscalPeriodStart;
  }


  @JsonProperty(JSON_PROPERTY_FISCAL_PERIOD_START)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFiscalPeriodStart(String fiscalPeriodStart) {
    this.fiscalPeriodStart = fiscalPeriodStart;
  }


  public FundamentalsRequest fiscalPeriodEnd(String fiscalPeriodEnd) {
    this.fiscalPeriodEnd = fiscalPeriodEnd;
    return this;
  }

   /**
   * Fiscal period end expressed YYYY-MM-DD.  Calendar date that will fall back to most recent completed period during resolution. 
   * @return fiscalPeriodEnd
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "2018-03-01", value = "Fiscal period end expressed YYYY-MM-DD.  Calendar date that will fall back to most recent completed period during resolution. ")
  @JsonProperty(JSON_PROPERTY_FISCAL_PERIOD_END)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getFiscalPeriodEnd() {
    return fiscalPeriodEnd;
  }


  @JsonProperty(JSON_PROPERTY_FISCAL_PERIOD_END)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setFiscalPeriodEnd(String fiscalPeriodEnd) {
    this.fiscalPeriodEnd = fiscalPeriodEnd;
  }


  public FundamentalsRequest metrics(java.util.List metrics) {
    this.metrics = metrics;
    return this;
  }

  public FundamentalsRequest addMetricsItem(String metricsItem) {
    this.metrics.add(metricsItem);
    return this;
  }

   /**
   * Requested List of Financial Statement Items or Ratios. Use /metrics endpoint for a complete list of available FF_* metric items. 
   * @return metrics
  **/
  @javax.annotation.Nonnull
  @ApiModelProperty(example = "[\"FF_SALES\"]", required = true, value = "Requested List of Financial Statement Items or Ratios. Use /metrics endpoint for a complete list of available FF_* metric items. ")
  @JsonProperty(JSON_PROPERTY_METRICS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)

  public java.util.List getMetrics() {
    return metrics;
  }


  @JsonProperty(JSON_PROPERTY_METRICS)
  @JsonInclude(value = JsonInclude.Include.ALWAYS)
  public void setMetrics(java.util.List metrics) {
    this.metrics = metrics;
  }


  public FundamentalsRequest currency(String currency) {
    this.currency = currency;
    return this;
  }

   /**
   * Currency code for currency values. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470). 
   * @return currency
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(example = "USD", value = "Currency code for currency values. For a list of currency ISO codes, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470). ")
  @JsonProperty(JSON_PROPERTY_CURRENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public String getCurrency() {
    return currency;
  }


  @JsonProperty(JSON_PROPERTY_CURRENCY)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setCurrency(String currency) {
    this.currency = currency;
  }


  public FundamentalsRequest restated(Restated restated) {
    this.restated = restated;
    return this;
  }

   /**
   * Get restated
   * @return restated
  **/
  @javax.annotation.Nullable
  @ApiModelProperty(value = "")
  @JsonProperty(JSON_PROPERTY_RESTATED)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)

  public Restated getRestated() {
    return restated;
  }


  @JsonProperty(JSON_PROPERTY_RESTATED)
  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
  public void setRestated(Restated restated) {
    this.restated = restated;
  }


  /**
   * Return true if this fundamentalsRequest object is equal to o.
   */
  @Override
  public boolean equals(Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    FundamentalsRequest fundamentalsRequest = (FundamentalsRequest) o;
    return Objects.equals(this.ids, fundamentalsRequest.ids) &&
        Objects.equals(this.periodicity, fundamentalsRequest.periodicity) &&
        Objects.equals(this.fiscalPeriodStart, fundamentalsRequest.fiscalPeriodStart) &&
        Objects.equals(this.fiscalPeriodEnd, fundamentalsRequest.fiscalPeriodEnd) &&
        Objects.equals(this.metrics, fundamentalsRequest.metrics) &&
        Objects.equals(this.currency, fundamentalsRequest.currency) &&
        Objects.equals(this.restated, fundamentalsRequest.restated);
  }

  @Override
  public int hashCode() {
    return Objects.hash(ids, periodicity, fiscalPeriodStart, fiscalPeriodEnd, metrics, currency, restated);
  }

  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class FundamentalsRequest {\n");
    sb.append("    ids: ").append(toIndentedString(ids)).append("\n");
    sb.append("    periodicity: ").append(toIndentedString(periodicity)).append("\n");
    sb.append("    fiscalPeriodStart: ").append(toIndentedString(fiscalPeriodStart)).append("\n");
    sb.append("    fiscalPeriodEnd: ").append(toIndentedString(fiscalPeriodEnd)).append("\n");
    sb.append("    metrics: ").append(toIndentedString(metrics)).append("\n");
    sb.append("    currency: ").append(toIndentedString(currency)).append("\n");
    sb.append("    restated: ").append(toIndentedString(restated)).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    ");
  }

}