import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
import * as MetricsAPI from "./metrics.js";
export declare class Metrics extends APIResource {
    /**
     * Returns list of available Estimate metrics that can be used in the `metrics`
     * parameter of related endpoints. **By default, Factset provides Estimated items
     * in millions. For specific metric methodology definitions, reference the `OAurl`
     * response items to launch the available methodology page.**
     */
    create(body: MetricCreateParams, options?: Core.RequestOptions): Core.APIPromise<MetricsResponse>;
    /**
     * Returns list of available Estimate metrics that can be used in the `metrics`
     * parameter of related endpoints. **By default, Factset provides Estimated items
     * in millions. For specific metric methodology definitions, reference the `OAurl`
     * response items to launch the available methodology page.**
     */
    list(query?: MetricListParams, options?: Core.RequestOptions): Core.APIPromise<MetricsResponse>;
    list(options?: Core.RequestOptions): Core.APIPromise<MetricsResponse>;
}
export interface MetricsResponse {
    /**
     * Array of metric objects representing the metrics that can be requested from the
     * estimates APIs.
     */
    data?: Array<MetricsResponse.Data>;
}
export declare namespace MetricsResponse {
    interface Data {
        /**
         * Primary Category of metric item, such as, FINANCIAL_STATEMENT or INDUSTRY_METRIC
         */
        category?: string | null;
        /**
         * Metric identifier to be used as `metrics` input in the FactSet Estimate
         * endpoints.
         */
        metric?: string | null;
        /**
         * Plain text name of the metric.
         */
        name?: string | null;
        /**
         * The Online Assistant Page URL, used to lookup the definition and methodology of
         * the requested item.
         */
        OAurl?: string | null;
        /**
         * Sub-category of metric items, such as the INCOME_STATEMENT or AIRLINES.
         */
        subcategory?: string | null;
    }
}
export interface MetricCreateParams {
    /**
     * Filters the list of Estimate metrics by major category -
     *
     * - **FINANCIAL_STATEMENT** = Includes Balance Sheet, Cash Flow, and Income
     *   Statement.
     * - **INDUSTRY_METRICS** = Industry specific metrics.
     * - **OTHER** = Target Price
     */
    category?: 'FINANCIAL_STATEMENT' | 'INDUSTRY_METRIC' | 'OTHER';
    /**
     * Sub-Category Filter for the Primary Category Requested. Choose a related
     * sub-category for the Category requested. For methodology, visit
     * [OA 16038](https://my.apps.factset.com/oa/pages/16038) <p>Financial Statement -
     *
     * - **BALANCE_SHEET** - Balance Sheet line items, such as Assets, Long-term Debt,
     *   and more.
     * - **CASH_FLOW** - Cash Flow Statement line items, such as Free Cash Flow and
     *   Share Repurchases
     * - **INCOME_STATEMENT** - Income Statement line items, such as EPS, Sales, DPS,
     *   and more.
     * - **MISCELLANEOUS** - EPS Long Term Growth
     * </p> <p> Industry Metrics -
     *
     * - **AIRLINES** - Including items such as Revenue Passenger, Total Revenue per
     *   ASK, Available Seats, and more.
     * - **BANKS** - Including items such as Net Interest Income, Trading Income, Net
     *   Loans, and more. SUPPLEMENTAL
     * - **COMMODITIES** - Including items such as Average Target Price.
     * - **COMPUTER_HARDWARE** - Including items such as Total Addressable Market.
     * - **CONSUMER_SERVICES** - Including items such as Gross Merchandise Volume
     * - **EDUCATION** - Including Items such as Total Student Enrollment
     * - **FINANCIAL_SERVICE_PROVIDER** - Including items such as Annual Subscription
     *   Value
     * - **HOME_BUILDERS** - Including items such as Home Sales, Land Sales,
     *   Cancellation Rates, and more.
     * - **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost
     *   Ratio, SS Admissions and more.
     * - **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR,
     *   and more.
     * - **INSURANCE** - Including items such as Gross Premiums Written, Underwriting
     *   Income, and Claims.
     * - **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost
     *   Ratio, SS Admissions and more.
     * - **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR,
     *   and more.
     * - **INSURANCE** - Including items such as Gross Premiums Written, Underwriting
     *   Income, and Claims.
     * - **MARIJUANA** - Including items such as Cost per Gram and Kg of Cannabis Sold.
     * - **MINING** - Including items such as Realized Price and Total Production
     * - **MULTIFINANCIAL** - Including items such as AUM, Net Flows, and Fee Related
     *   Earnings.
     * - **OIL_AND_GAS** - Including items such as Downstream Income, Production per
     *   Day, and Exploration Expense.
     * - **OTHER** - Target Price
     * - **REITS** - Including items such as Funds from Operations, Implied Cap Rate,
     *   and LTV.
     * - **RESTAURANTS** - Including items such as Restaurant Margin.
     * - **RETAILERS** - Including items such as Stores Information, Selling Space and
     *   Net sales per square foot.
     * - **TELECOMMUNICATIONS** - Including items such as Gross Adds, Monthly Revenue
     *   Per User, Churn, and more.
     * - **TRANSPORTATION** - Including items such as Revenue Per Unit, Volume Growth,
     *   and Operating Ratio.</p>
     */
    subcategory?: 'AIRLINES' | 'BALANCE_SHEET' | 'BANKS' | 'CASH_FLOW' | 'COMMODITIES' | 'COMPUTER_HARDWARE' | 'CONSUMER_SERVICES' | 'EDUCATION' | 'FINANCIAL_SERVICE_PROVIDER' | 'HOME_BUILDERS' | 'HOSPITALS' | 'HOTELS' | 'INCOME_STATEMENT' | 'INSURANCE' | 'MARIJUANA' | 'MINING' | 'MISCELLANEOUS' | 'MULTIFINANCIAL' | 'OIL_AND_GAS' | 'OTHER' | 'REITS' | 'RESTAURANTS' | 'RETAILERS' | 'TELECOMMUNICATIONS' | 'TRANSPORTATION';
}
export interface MetricListParams {
    /**
     * Filters the list of Estimate metrics by major category -
     *
     * - **FINANCIAL_STATEMENT** = Includes Balance Sheet, Cash Flow, and Income
     *   Statement.
     * - **INDUSTRY_METRICS** = Industry specific metrics.
     * - **OTHER** = Target Price
     */
    category?: 'FINANCIAL_STATEMENT' | 'INDUSTRY_METRIC' | 'OTHER';
    /**
     * Sub-Category Filter for the Primary Category Requested. Choose a related
     * sub-category for the Category requested. For methodology, visit
     * [OA 16038](https://my.apps.factset.com/oa/pages/16038) <p>Financial Statement -
     *
     * - **BALANCE_SHEET** - Balance Sheet line items, such as Assets, Long-term Debt,
     *   and more.
     * - **CASH_FLOW** - Cash Flow Statement line items, such as Free Cash Flow and
     *   Share Repurchases
     * - **INCOME_STATEMENT** - Income Statement line items, such as EPS, Sales, DPS,
     *   and more.
     * - **MISCELLANEOUS** - EPS Long Term Growth
     * </p> <p> Industry Metrics -
     *
     * - **AIRLINES** - Including items such as Revenue Passenger, Total Revenue per
     *   ASK, Available Seats, and more.
     * - **BANKS** - Including items such as Net Interest Income, Trading Income, Net
     *   Loans, and more. SUPPLEMENTAL
     * - **COMMODITIES** - Including items such as Average Target Price.
     * - **COMPUTER_HARDWARE** - Including items such as Total Addressable Market.
     * - **CONSUMER_SERVICES** - Including items such as Gross Merchandise Volume
     * - **EDUCATION** - Including Items such as Total Student Enrollment
     * - **FINANCIAL_SERVICE_PROVIDER** - Including items such as Annual Subscription
     *   Value
     * - **HOME_BUILDERS** - Including items such as Home Sales, Land Sales,
     *   Cancellation Rates, and more.
     * - **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost
     *   Ratio, SS Admissions and more.
     * - **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR,
     *   and more.
     * - **INSURANCE** - Including items such as Gross Premiums Written, Underwriting
     *   Income, and Claims.
     * - **HOSPITALS** - Including items such as Bad Debt Provisions, Medical Cost
     *   Ratio, SS Admissions and more.
     * - **HOTELS** - Including items such as Average Daily Rate, Occupancy %, RevPAR,
     *   and more.
     * - **INSURANCE** - Including items such as Gross Premiums Written, Underwriting
     *   Income, and Claims.
     * - **MARIJUANA** - Including items such as Cost per Gram and Kg of Cannabis Sold.
     * - **MINING** - Including items such as Realized Price and Total Production
     * - **MULTIFINANCIAL** - Including items such as AUM, Net Flows, and Fee Related
     *   Earnings.
     * - **OIL_AND_GAS** - Including items such as Downstream Income, Production per
     *   Day, and Exploration Expense.
     * - **OTHER** - Target Price
     * - **REITS** - Including items such as Funds from Operations, Implied Cap Rate,
     *   and LTV.
     * - **RESTAURANTS** - Including items such as Restaurant Margin.
     * - **RETAILERS** - Including items such as Stores Information, Selling Space and
     *   Net sales per square foot.
     * - **TELECOMMUNICATIONS** - Including items such as Gross Adds, Monthly Revenue
     *   Per User, Churn, and more.
     * - **TRANSPORTATION** - Including items such as Revenue Per Unit, Volume Growth,
     *   and Operating Ratio.</p>
     */
    subcategory?: 'AIRLINES' | 'BALANCE_SHEET' | 'BANKS' | 'CASH_FLOW' | 'COMMODITIES' | 'COMPUTER_HARDWARE' | 'CONSUMER_SERVICES' | 'EDUCATION' | 'FINANCIAL_SERVICE_PROVIDER' | 'HOME_BUILDERS' | 'HOSPITALS' | 'HOTELS' | 'INCOME_STATEMENT' | 'INSURANCE' | 'MARIJUANA' | 'MINING' | 'MISCELLANEOUS' | 'MULTIFINANCIAL' | 'OIL_AND_GAS' | 'OTHER' | 'REITS' | 'RESTAURANTS' | 'RETAILERS' | 'TELECOMMUNICATIONS' | 'TRANSPORTATION';
}
export declare namespace Metrics {
    export import MetricsResponse = MetricsAPI.MetricsResponse;
    export import MetricCreateParams = MetricsAPI.MetricCreateParams;
    export import MetricListParams = MetricsAPI.MetricListParams;
}
//# sourceMappingURL=metrics.d.ts.map