import { APIResource } from "../../../../../../core/resource.mjs";
import { APIPromise } from "../../../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../../../internal/request-options.mjs";
export declare class BaseSpam extends APIResource {
    static readonly _key: readonly ['radar', 'email', 'security', 'top', 'tlds', 'spam'];
    /**
     * Retrieves the top TLDs by emails classified as spam or not.
     *
     * @example
     * ```ts
     * const spam =
     *   await client.radar.email.security.top.tlds.spam.get(
     *     'SPAM',
     *   );
     * ```
     */
    get(spam: 'SPAM' | 'NOT_SPAM', query?: SpamGetParams | null | undefined, options?: RequestOptions): APIPromise<SpamGetResponse>;
}
export declare class Spam extends BaseSpam {
}
export interface SpamGetResponse {
    /**
     * Metadata for the results.
     */
    meta: SpamGetResponse.Meta;
    top_0: Array<SpamGetResponse.Top0>;
}
export declare namespace SpamGetResponse {
    /**
     * Metadata for the results.
     */
    interface Meta {
        confidenceInfo: Meta.ConfidenceInfo | null;
        dateRange: Array<Meta.DateRange>;
        /**
         * Timestamp of the last dataset update.
         */
        lastUpdated: string;
        /**
         * Normalization method applied to the results. Refer to
         * [Normalization methods](https://developers.cloudflare.com/radar/concepts/normalization/).
         */
        normalization: 'PERCENTAGE' | 'MIN0_MAX' | 'MIN_MAX' | 'RAW_VALUES' | 'PERCENTAGE_CHANGE' | 'ROLLING_AVERAGE' | 'OVERLAPPED_PERCENTAGE' | 'RATIO';
        /**
         * Measurement units for the results.
         */
        units: Array<Meta.Unit>;
    }
    namespace Meta {
        interface ConfidenceInfo {
            annotations: Array<ConfidenceInfo.Annotation>;
            /**
             * Provides an indication of how much confidence Cloudflare has in the data.
             */
            level: number;
        }
        namespace ConfidenceInfo {
            /**
             * Annotation associated with the result (e.g. outage or other type of event).
             */
            interface Annotation {
                /**
                 * Data source for annotations.
                 */
                dataSource: 'ALL' | 'AI_BOTS' | 'AI_GATEWAY' | 'BGP' | 'BOTS' | 'CONNECTION_ANOMALY' | 'CT' | 'DNS' | 'DNS_MAGNITUDE' | 'DNS_AS112' | 'DOS' | 'EMAIL_ROUTING' | 'EMAIL_SECURITY' | 'FW' | 'FW_PG' | 'HTTP' | 'HTTP_CONTROL' | 'HTTP_CRAWLER_REFERER' | 'HTTP_ORIGINS' | 'IQI' | 'LEAKED_CREDENTIALS' | 'NET' | 'ROBOTS_TXT' | 'SPEED' | 'WORKERS_AI';
                description: string;
                endDate: string;
                /**
                 * Event type for annotations.
                 */
                eventType: 'EVENT' | 'GENERAL' | 'OUTAGE' | 'PARTIAL_PROJECTION' | 'PIPELINE' | 'TRAFFIC_ANOMALY';
                /**
                 * Whether event is a single point in time or a time range.
                 */
                isInstantaneous: boolean;
                linkedUrl: string;
                startDate: string;
                tags?: Array<string>;
            }
        }
        interface DateRange {
            /**
             * Adjusted end of date range.
             */
            endTime: string;
            /**
             * Adjusted start of date range.
             */
            startTime: string;
        }
        interface Unit {
            name: string;
            value: string;
        }
    }
    interface Top0 {
        name: string;
        /**
         * A numeric string.
         */
        value: string;
    }
}
export interface SpamGetParams {
    /**
     * Filters results by ARC (Authenticated Received Chain) validation.
     */
    arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
    /**
     * End of the date range (inclusive). Alternative to `dateRange`; provide together
     * with `dateStart`. When requesting comparison series, every series must resolve
     * to the same duration as the main series. Each `dateStart`/`dateEnd` is floored
     * to the nearest 15 minutes before evaluation, so windows whose durations match
     * only before alignment may be rejected.
     */
    dateEnd?: Array<string>;
    /**
     * Filters results by relative date range ending at the current time, with each
     * value producing a separate series. Use `<n>d` for days (up to `364d`) or `<n>w`
     * for weeks (up to `52w`). Append `control` to request the equivalent previous
     * period for comparison: the comparison window is shifted back by the current
     * window's length rounded up to a whole number of weeks, so it keeps the same
     * weekday alignment and does not overlap the current window (e.g. `7dcontrol`
     * covers days -14 to -7, `10dcontrol` covers days -24 to -14). For example, pass
     * `7d` and `7dcontrol` to compare this week with the previous week. All series
     * must resolve to the same duration as the main series; relative ranges (including
     * `control`) satisfy this automatically. Use this parameter or set specific start
     * and end dates (`dateStart` and `dateEnd` parameters).
     */
    dateRange?: Array<string>;
    /**
     * Start of the date range. Alternative to `dateRange`; provide together with
     * `dateEnd`. When requesting comparison series, every series must resolve to the
     * same duration as the main series. Each `dateStart`/`dateEnd` is floored to the
     * nearest 15 minutes before evaluation, so windows whose durations match only
     * before alignment may be rejected.
     */
    dateStart?: Array<string>;
    /**
     * Filters results by DKIM (DomainKeys Identified Mail) validation status.
     */
    dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
    /**
     * Filters results by DMARC (Domain-based Message Authentication, Reporting and
     * Conformance) validation status.
     */
    dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
    /**
     * Format in which results will be returned.
     */
    format?: 'JSON' | 'CSV';
    /**
     * Limits the number of objects returned in the response.
     */
    limit?: number;
    /**
     * Array of names used to label the series in the response.
     */
    name?: Array<string>;
    /**
     * Filters results by SPF (Sender Policy Framework) validation status.
     */
    spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
    /**
     * Filters results by TLD category.
     */
    tldCategory?: 'CLASSIC' | 'COUNTRY';
    /**
     * Filters results by TLS version.
     */
    tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export declare namespace Spam {
    export { type SpamGetResponse as SpamGetResponse, type SpamGetParams as SpamGetParams };
}
//# sourceMappingURL=spam.d.mts.map