import type LocalizationOptions from '../Shared/LocalizationOptions';
import type { MorningstarConverterOptions, MorningstarOptions, MorningstarSecurityOptions } from '../Shared/MorningstarOptions';
export interface CumulativeReturnSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * When `true`, includes category bands.
     *
     * @default true
    */
    categoryBands?: boolean;
    /**
     * Number of decimal places. Used when `outputType=compactjson`.
     *
     * @default 2
    */
    decPlaces?: number;
    /**
     * When true, excludes stub month.
     *
     * @default false
     */
    excludeStubMonth?: boolean;
    /**
     * Series type to retrieve.
     */
    type: 'CumulativeReturn';
}
export interface DividendSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * Whether to include currency information as an additional column for each
     * security (`true`), or not (`false`). The name of the additional column
     * has the format `[SID]_Currency`, e.g. `F0GBR04S23_Currency`.
     *
     * @default false
     */
    includeCurrency?: boolean;
    /**
     * Series type to retrieve.
     */
    type: 'Dividend';
}
export interface GrowthSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * When `true`, includes category bands.
     *
     * @default true
     */
    categoryBands?: boolean;
    /**
     * Start value for growth series.
     *
     * @default 10000
     */
    startValue?: number;
    /**
     * Series type to retrieve.
     */
    type: 'Growth';
    /**
     * Defines the start day when `frequency=weekly`.
     *
     * @default null
     */
    weeklyStartDay?: ('firstAvailable');
}
export interface PriceSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * Series type to retrieve.
     */
    type: 'Price';
    /**
     * The type of price to retrieve.
     *
     * `SPLITADJ` is the default when instrument type is `CEF`.
     */
    priceType?: PriceType;
}
export type PriceType = ('PRICE' | 'NAV-CF' | 'SPLITADJ' | 'BONDCLEANPRICE' | 'BONDACCRUEDINTEREST' | 'TAXADJNAV');
export interface RatingSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * Series type to retrieve.
     */
    type: 'Rating';
}
export interface OHLCVSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * Series type to retrieve.
     */
    type: 'OHLCV';
    /**
     * When this property is `true`, open, high and low are replaced with
     * the close value if the volume is zero.
     *
     * If volume is zero, open high low are zero too. If you do not prefer this
     * behavior, you can enable this property.
     *
     * @default false
     */
    replaceZeroWithCloseValue?: boolean;
    /**
     * Security to retrieve.
     */
    securities?: Array<MorningstarSecurityOptions>;
}
export interface ReturnSeriesOptions extends TimeSeriesConverterOptions {
    /**
     * Series type to retrieve.
     */
    type: 'Return';
}
export interface RollingReturnSeriesOptions extends TimeSeriesConverterOptions {
    /**
     *
     * Defines the length of the rolling time window for calculating returns.
     * It represents the number of days, months, or years, depending on the
     * selected frequency. By default, the frequency is daily.
     *
     * @default 10
     */
    rollingPeriod?: number;
    /**
     * Series type to retrieve.
     */
    type: 'RollingReturn';
}
export interface TimeSeriesConverterOptions extends MorningstarConverterOptions {
}
export interface TimeSeriesOptions extends MorningstarOptions {
    /**
     * Common type-independent series options.
     */
    converter?: TimeSeriesConverterOptions;
    /**
     * Currency code (ISO alpha-3) for requested values.
     */
    currencyId?: string;
    /**
     * The end date for the requested securities data. This can be either a
     * JavaScript timestamp or a date string.
     */
    endDate?: (number | string);
    /**
     * Specifies the frequency of the data.
     * Default is `daily`.
     */
    frequency?: TimeSeriesFrequency;
    /**
     * Localization options.
     */
    localization?: LocalizationOptions;
    /**
     * Performance type to base the return on.
     */
    performanceType?: string;
    /**
     * Sets if restructured dates should be considered.
     *
     * @default 'ignore'
     */
    restructureDateOptions?: ('ignore' | 'validate');
    /**
     * Securities to retrieve.
     *
     * **NOTE: When series type is `OHLCV`, only one security is supported.**
     */
    securities?: Array<MorningstarSecurityOptions>;
    /**
     * Type-based series options.
     */
    series?: TimeSeriesType;
    /**
     * The start date for the requested securities data. This can be either a
     * JavaScript timestamp or a date string.
     */
    startDate?: (number | string);
    /**
     * Tax option.
     */
    taxOption?: ('pretax' | 'posttax');
    /**
     * Sets the length of the time period. For example, if `timePeriodUnit` is set
     * to monthly and `timePeriod` value is 24, time series data for 24 months
     * is returned.
     *
     * If `timePeriod` has no value, the service returns results since inception.
     *
     * **Note:** `timePeriod` value overrides the `startDate` value.
     *
     * @default 12
     */
    timePeriod?: number;
    /**
     * Sets the time period unit of the time series.
     *
     * @default 'months'
     */
    timePeriodUnit?: ('months' | 'days' | 'years');
}
export type TimeSeriesFrequency = ('daily' | 'weekly' | 'monthly' | 'quarterly' | 'annual');
export type TimeSeriesType = (CumulativeReturnSeriesOptions | DividendSeriesOptions | GrowthSeriesOptions | PriceSeriesOptions | RatingSeriesOptions | OHLCVSeriesOptions | ReturnSeriesOptions | RollingReturnSeriesOptions);
export default TimeSeriesOptions;