/**
 * Time Series
 *
 * Time series is the most common type of data available, and consists of a collection of data points over a period of time. Time series data is indexed by a single date field, and can be retrieved by any portion of time.
 * To use this endpoint, you’ll first make a free call to get an inventory of available time series data.
 */
export declare const timeSeries: () => Promise<readonly TimeSeries[]>;
/**
 * Time Series by Id
 *
 * @param id ID used to identify a time series dataset.
 * @param key Key used to identify data within a dataset. A common example is a symbol such as AAPL.
 * @param subkey The optional subkey can used to further refine data for a particular key if available.
 */
export declare const timeSeriesById: (id: string, key: string, subkey?: string) => Promise<TimeSeriesById>;
export declare type TimeSeriesRange = 'today' | 'yesterday' | 'ytd' | 'last-week' | 'last-month' | 'last-quarter' | 'd' | 'w' | 'm' | 'q' | 'y' | 'tomorrow' | 'this-week' | 'this-month' | 'this-quarter' | 'next-week' | 'next-month' | 'next-quarter' | string;
export interface TimeSeriesQSParams {
    /**  Returns data for a given range. Supported ranges described below. */
    readonly range: TimeSeriesRange;
    /**  Used in conjunction with range to return data in the future. */
    readonly calendar: boolean;
    /**  Limits the number of results returned. Defaults to 1. */
    readonly limit: number;
    /**
     * Allows you to query time series by any field in the result set. All time series data is stored by ID, then key, then subkey. If you want to query by any other field in the data, you can use subattribute.
     *   For example, news may be stored as /news/{symbol}/{newsId}, and the result data returns the keys id, symbol, date, sector, hasPaywall
     *   By default you can only query by symbol or id. Maybe you want to query all news where the sector is Technology. Your query would be:
     *   /time-series/news?subattribute=sector|Technology
     *   The syntax is subattribute={keyName}|{value}. Both the key name and the value are case sensitive. A pipe symbol is used to represent ‘equal to’.
     */
    readonly subattribute: string;
    /**
     * All time series data is stored by a single date field, and that field is used for any range or date parameters. You may want to query time series data by a different date in the result set. To change the date field used by range queries, pass the case sensitive field name with this parameter.
     *  For example, corporate buy back data may be stored by announce date, but also contains an end date which you’d rather query by. To query by end date you would use dateField=endDate&range=last-week
     */
    readonly dateField: string;
    /**  Returns data on or after the given from date. Format YYYY-MM-DD */
    readonly from: string;
    /**  Returns data on or before the given to date. Format YYYY-MM-DD */
    readonly to: string;
    /**  Returns data on the given date. Format YYYY-MM-DD */
    readonly on: string;
    /**  Returns the latest n number of records in the series */
    readonly last: string;
    /**  Returns the first n number of records in the series */
    readonly first: string;
    /**  The standard filter parameter. Filters return data to the specified comma delimited list of keys (case-sensitive) */
    readonly filter: string;
    /**  The standard format parameter. Returns data as JSON by default. See the data format section for supported types. */
    readonly format: string;
}
export interface TimeSeries {
    /**  The dataset ID */
    readonly id: string;
    /**  source of the data if available */
    readonly source: string;
    /**  The requested dataset key */
    readonly key: string;
    /**  The requested dataset subkey */
    readonly subkey: string;
    /**  The date field of the time series as epoch timestamp */
    readonly date: number;
}
export interface TimeSeriesById {
    /**  Dataset ID */
    readonly id: string;
    /**  Description of the dataset */
    readonly description: string;
    /**  Dataset key */
    readonly key: string;
    /**  Dataset subkey */
    readonly subkey: string;
    /**  Data weight to call the individual data point in number of messages. */
    readonly schema: object;
    /**  Data weight to call the time series in number of messages per array item (row) returned. */
    readonly weight: number;
    /**  ISO 8601 formatted date time the time series dataset was created. */
    readonly created: string;
    /**  ISO 8601 formatted date time the time series dataset was last updated. */
    readonly lastUpdated: string;
}