import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as ConsensusRatingsAPI from "./consensus-ratings.js";
export declare class ConsensusRatings extends APIResource {
    /**
     * Returns ratings from the FactSet Estimates database for current and historical
     * for an individual security using rolling fiscal dates as of a specific date.
     */
    create(body: ConsensusRatingCreateParams, options?: Core.RequestOptions): Core.APIPromise<ConsensusRatingsResponse>;
    /**
     * Returns ratings from the FactSet Estimates database for current and historical
     * for an individual security using rolling fiscal dates as of a specific date.
     */
    list(query: ConsensusRatingListParams, options?: Core.RequestOptions): Core.APIPromise<ConsensusRatingsResponse>;
}
export interface ConsensusRatingsResponse {
    /**
     * Array of consensus ratings estimate objects
     */
    data?: Array<ConsensusRatingsResponse.Data>;
}
export declare namespace ConsensusRatingsResponse {
    interface Data {
        /**
         * The number of Buy ratings taken into account in the calculation of a consensus.
         * This information is shown only for a 100-day consensus.
         */
        buyCount?: number | 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;
        fsymId?: string | null;
        /**
         * The number of Hold ratings taken into account in the calculation of a consensus.
         * This information is shown only for a 100-day consensus.
         */
        holdCount?: number | null;
        /**
         * The number of Overweight ratings taken into account in the calculation of a
         * consensus. This information is shown only for a 100-day consensus.
         */
        overweightCount?: number | null;
        /**
         * The total number of ratings taken into account in the calculation of a
         * consensus. This information is shown only for a 100-day consensus.
         */
        ratingsNestTotal?: number | null;
        /**
         * The mean average of ratings for the fiscal dates indicated, where each
         * underlying rating is given a numerical score and then aggregated to a mean
         * consensus - **_Individual Ratings Scores_** |Value|Rating Description| |---|---|
         * |1|Buy| |1.5|Overweight| |2|Hold| |2.5|Underweight| |3|Sell|
         */
        ratingsNote?: number | null;
        /**
         * The mean textual rating for the fiscal dates indicated. The text rating is
         * assigned by falling within the below defined ranges - **_Textual Ranges for
         * Average_** |Value|Rating Description| |---|---| |< 1.25|Buy| |< 1.75|Overweight|
         * |< 2.25|Hold| |< 2.75|Underweight| |<= 3|Sell|
         */
        ratingsNoteText?: string | null;
        /**
         * Identifier that was used for the request.
         */
        requestId?: string;
        /**
         * The number of Sell ratings taken into account in the calculation of a consensus.
         * This information is shown only for a 100-day consensus.
         */
        sellCount?: number | null;
        /**
         * The number of Underweight ratings taken into account in the calculation of a
         * consensus. This information is shown only for a 100-day consensus.
         */
        underweightCount?: number | null;
    }
}
export interface ConsensusRatingCreateParams {
    /**
     * The requested list of security identifiers. Accepted ID types include Market
     * Tickers, SEDOL, ISINs, CUSIPs, or FactSet Permanent Ids. _ Make Note - id limit
     * of 3000 for defaults, otherwise the service is limited to a 30 second duration.
     * This can be reached when increasing total number of metrics requested and depth
     * of history. _
     */
    ids: Array<string>;
    /**
     * The end date requested for a given date range in **YYYY-MM-DD** format. If left
     * blank, the API will default to previous close. Future dates (T+1) are not
     * accepted in this endpoint.
     */
    endDate?: string;
    /**
     * Controls the display frequency of the data returned.
     *
     * - **D** = Daily
     * - **W** = Weekly, based on the last day of the week of the start date.
     * - **AM** = Monthly, based on the start date (e.g., if the start date is June 16,
     *   data is displayed for June 16, May 16, April 16 etc.).
     * - **AQ** = Quarterly, based on the start date.
     * - **AY** = Actual Annual, based on the start date.
     */
    frequency?: 'D' | 'W' | 'AM' | 'AQ' | 'AY';
    /**
     * The start date requested for a given date range in **YYYY-MM-DD** format. If
     * left blank, the API will default to previous close. Future dates (T+1) are not
     * accepted in this #endpoint.
     */
    startDate?: string;
}
export interface ConsensusRatingListParams {
    /**
     * Security or Entity identifiers. FactSet Identifiers, tickers, CUSIP and SEDOL
     * are accepted input. <p>**\*ids limit** = 3000 per request*</p> * Make Note - id
     * limit of 3000 for defaults, otherwise the service is limited to a 30 second
     * duration. This can be reached when increasing total number of metrics requested
     * and depth of history. \*
     */
    ids: Array<string>;
    /**
     * End date for point in time of estimates expressed in YYYY-MM-DD format.
     */
    endDate?: string;
    /**
     * Controls the frequency of the data returned.
     *
     * - **D** = Daily
     * - **W** = Weekly, based on the last day of the week of the start date.
     * - **AM** = Monthly, based on the start date (e.g., if the start date is June 16,
     *   data is displayed for June 16, May 16, April 16 etc.).
     * - **AQ** = Quarterly, based on the start date.
     * - **AY** = Actual Annual, based on the start date.
     */
    frequency?: 'D' | 'W' | 'AM' | 'AQ' | 'AY';
    /**
     * Start date for point in time of estimates expressed in YYYY-MM-DD format.
     */
    startDate?: string;
}
export declare namespace ConsensusRatings {
    export import ConsensusRatingsResponse = ConsensusRatingsAPI.ConsensusRatingsResponse;
    export import ConsensusRatingCreateParams = ConsensusRatingsAPI.ConsensusRatingCreateParams;
    export import ConsensusRatingListParams = ConsensusRatingsAPI.ConsensusRatingListParams;
}
//# sourceMappingURL=consensus-ratings.d.ts.map