// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

export interface ConsensusResponse {
  /**
   * Array of consensus estimate objects
   */
  data?: Array<ConsensusResponse.Data>;
}

export namespace ConsensusResponse {
  export interface Data {
    /**
     * Currency code for adjusting the data. Use 'ESTIMATE' as input value for the
     * values in Estimate Currency. For a list of currency ISO codes, visit
     * [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
     */
    currency?: string | null;

    /**
     * Number of Up Revisions within the consensus for the metric and period. The
     * default window size is 100 days. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).
     */
    down?: number | null;

    /**
     * Count or NEST of estimates in consensus calculation. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)
     */
    estimateCount?: number | null;

    /**
     * Estimate currency of the requested Security
     */
    estimateCurrency?: string | null;

    /**
     * Date of estimate expressed in YYYY-MM-DD format. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    estimateDate?: string | null;

    /**
     * Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD
     * format. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    fiscalEndDate?: string | null;

    /**
     * Company's 'fiscal period' for the estimate record. Periods for periodicity of
     * ANN = 1, and SEMI = 2. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598).
     */
    fiscalPeriod?: number | null;

    /**
     * Company's 'fiscal year' for the estimate record. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    fiscalYear?: number | null;

    /**
     * Factset Regional Security Identifier. Six alpha-numeric characters, excluding
     * vowels, with an -R suffix (XXXXXX-R). Identifies the security's best regional
     * security data series per currency. For equities, all primary listings per region
     * and currency are allocated a regional-level permanent identifier. The
     * regional-level permanent identifier will be available once a SEDOL representing
     * the region/currency has been allocated and the identifiers are on FactSet.
     */
    fsymId?: string | null;

    /**
     * Highest estimate in consensus calculation. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).
     */
    high?: number | null;

    /**
     * Lowest estimate in consensus calculation. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)
     */
    low?: number | null;

    /**
     * Mean of estimates in consensus calculation. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)
     */
    mean?: number | null;

    /**
     * Median of estimates in consensus calculation. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)
     */
    median?: number | null;

    /**
     * Company's Financial statement 'metric' that is estimated. Use the
     * factset-estimates/v#/metrics endpoint for a complete list. For more details,
     * visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034)
     */
    metric?: string | null;

    /**
     * The reporting interval for the estimate. This is derived from Estimate Date and
     * is translated to the Period List = ANN, QTR, SEMI, LTMA, or NMTA.
     */
    periodicity?: string | null;

    /**
     * 'Fiscal period' based on relationship to 'estimate date'. This is not applicable
     * for fixed-consensus endpoint. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    relativePeriod?: number | null;

    /**
     * Identifier that was used for the request.
     */
    requestId?: string;

    /**
     * Standard deviation of estimates in consensus calculation. For more details,
     * visit [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114)
     */
    standardDeviation?: number | null;

    /**
     * Number of Up Revisions within the consensus for the metric and period. The
     * default window size is 100 days For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16114).
     */
    up?: number | null;
  }
}

export interface DetailResponse {
  /**
   * Array of consensus estimate objects
   */
  data?: Array<DetailResponse.Data>;
}

export namespace DetailResponse {
  export interface Data {
    /**
     * The FactSet Entity Identifier for the analyst making the estimate.
     */
    analystId?: string | null;

    /**
     * The name of the analyst making the estimate.
     */
    analystName?: string | null;

    /**
     * The currency in which estimates are made by broker.
     */
    brokerEstimateCurrency?: string | null;

    /**
     * The FactSet Entity Identifier for the broker making the estimate.
     */
    brokerId?: string | null;

    /**
     * The name of the broker making the estimate.
     */
    brokerName?: string | null;

    /**
     * Currency code for adjusting the data. Use 'ESTIMATE' as input value for the
     * values in Estimate Currency. For a list of currency ISO codes, visit
     * [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
     */
    currency?: string | null;

    /**
     * Estimate currency of the requested Security
     */
    estimateCurrency?: string | null;

    /**
     * Date of estimate expressed in YYYY-MM-DD format. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    estimateDate?: string | null;

    /**
     * The value of the estimate.
     */
    estimateValue?: number | null;

    /**
     * Company's 'fiscal end date' for the estimate record expressed in YYYY-MM-DD
     * format
     */
    fiscalEndDate?: string | null;

    /**
     * Company's 'fiscal period' for the estimate record. 'Periodicity' defines context
     * for period.
     */
    fiscalPeriod?: number | null;

    /**
     * Company's 'fiscal year' for the estimate record
     */
    fiscalYear?: number | null;

    fsymId?: string | null;

    /**
     * Date and time when the data is available at the source.
     */
    inputDateTime?: string | null;

    /**
     * The date at which a broker provided an estimate that is a revision.
     */
    lastModifiedDate?: string | null;

    /**
     * Company's Financial statement 'metric' that is estimated. Use the
     * factset-estimates/v#/metrics endpoint for a complete list. For more details,
     * visit [Online Assistant Page #15034](https://oa.apps.factset.com/pages/15034).
     */
    metric?: string | null;

    /**
     * Company's 'periodicity' for the estimate record, reflecting Annual, Quarterly,
     * or Semi-Annual report periods.
     */
    periodicity?: string | null;

    /**
     * Date the previous estimate was made expressed in YYYY-MM-DD format. For more
     * details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    prevEstimateDate?: string | null;

    /**
     * The value of the previous estimate.
     */
    prevEstimateValue?: number | null;

    /**
     * 'Fiscal period' based on relationship to 'estimate date'. This is not applicable
     * for fixed-consensus endpoint. For more details, visit
     * [Online Assistant Page #16598](https://oa.apps.factset.com/pages/16598)
     */
    relativePeriod?: number | null;

    /**
     * Identifier that was used for the request.
     */
    requestId?: string;

    /**
     * Section of the estimate.Returns the details of brokers inlcuded and excluded in
     * the consensus
     */
    section?: string | null;

    /**
     * The currency that the company trades in.
     */
    securityCurrency?: string | null;

    /**
     * Status code of the estimate.
     */
    statusCode?: number | null;

    /**
     * Status description of the estimate.
     */
    statusText?: string | null;
  }
}