import { APIResource } from "../../../../core/resource.js"; import * as EmailAPI from "../email.js"; import { APIPromise } from "../../../../core/api-promise.js"; import { RequestOptions } from "../../../../internal/request-options.js"; export declare class BaseSummary extends APIResource { static readonly _key: readonly ['radar', 'email', 'routing', 'summary']; /** * Retrieves the distribution of emails by ARC (Authenticated Received Chain) * validation. * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ arc(query?: SummaryARCParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail) * validation. * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ dkim(query?: SummaryDKIMParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of emails by DMARC (Domain-based Message * Authentication, Reporting and Conformance) validation. * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ dmarc(query?: SummaryDMARCParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of emails by encryption status (encrypted vs. * not-encrypted). * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ encrypted(query?: SummaryEncryptedParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of emails by IP version. * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ ipVersion(query?: SummaryIPVersionParams | null | undefined, options?: RequestOptions): APIPromise; /** * Retrieves the distribution of emails by SPF (Sender Policy Framework) * validation. * * @deprecated Use [Radar Email Routing Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/routing/methods/summary_v2/) instead. */ spf(query?: SummarySPFParams | null | undefined, options?: RequestOptions): APIPromise; } export declare class Summary extends BaseSummary { } export interface SummaryARCResponse { /** * Metadata for the results. */ meta: SummaryARCResponse.Meta; summary_0: EmailAPI.RadarEmailSummary; } export declare namespace SummaryARCResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryDKIMResponse { /** * Metadata for the results. */ meta: SummaryDKIMResponse.Meta; summary_0: EmailAPI.RadarEmailSummary; } export declare namespace SummaryDKIMResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryDMARCResponse { /** * Metadata for the results. */ meta: SummaryDMARCResponse.Meta; summary_0: EmailAPI.RadarEmailSummary; } export declare namespace SummaryDMARCResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryEncryptedResponse { /** * Metadata for the results. */ meta: SummaryEncryptedResponse.Meta; summary_0: SummaryEncryptedResponse.Summary0; } export declare namespace SummaryEncryptedResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Summary0 { /** * A numeric string. */ ENCRYPTED: string; /** * A numeric string. */ NOT_ENCRYPTED: string; } } export interface SummaryIPVersionResponse { /** * Metadata for the results. */ meta: SummaryIPVersionResponse.Meta; summary_0: SummaryIPVersionResponse.Summary0; } export declare namespace SummaryIPVersionResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } interface Summary0 { /** * A numeric string. */ IPv4: string; /** * A numeric string. */ IPv6: string; } } export interface SummarySPFResponse { /** * Metadata for the results. */ meta: SummarySPFResponse.Meta; summary_0: EmailAPI.RadarEmailSummary; } export declare namespace SummarySPFResponse { /** * Metadata for the results. */ interface Meta { confidenceInfo: Meta.ConfidenceInfo; dateRange: Array; /** * 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; } namespace Meta { interface ConfidenceInfo { annotations: Array; /** * 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; } } interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } interface Unit { name: string; value: string; } } } export interface SummaryARCParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * 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'>; /** * Filters results by encryption status (encrypted vs. not-encrypted). */ encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by SPF (Sender Policy Framework) validation status. */ spf?: Array<'PASS' | 'NONE' | 'FAIL'>; } export interface SummaryDKIMParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * Filters results by DMARC (Domain-based Message Authentication, Reporting and * Conformance) validation status. */ dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>; /** * Filters results by encryption status (encrypted vs. not-encrypted). */ encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by SPF (Sender Policy Framework) validation status. */ spf?: Array<'PASS' | 'NONE' | 'FAIL'>; } export interface SummaryDMARCParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * Filters results by DKIM (DomainKeys Identified Mail) validation status. */ dkim?: Array<'PASS' | 'NONE' | 'FAIL'>; /** * Filters results by encryption status (encrypted vs. not-encrypted). */ encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by SPF (Sender Policy Framework) validation status. */ spf?: Array<'PASS' | 'NONE' | 'FAIL'>; } export interface SummaryEncryptedParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * 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'; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by SPF (Sender Policy Framework) validation status. */ spf?: Array<'PASS' | 'NONE' | 'FAIL'>; } export interface SummaryIPVersionParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * 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'>; /** * Filters results by encryption status (encrypted vs. not-encrypted). */ encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Array of names used to label the series in the response. */ name?: Array; /** * Filters results by SPF (Sender Policy Framework) validation status. */ spf?: Array<'PASS' | 'NONE' | 'FAIL'>; } export interface SummarySPFParams { /** * 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; /** * Filters results by relative date range ending at the current time, with each * value producing a separate series. Use `d` for days (up to `364d`) or `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; /** * 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; /** * 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'>; /** * Filters results by encryption status (encrypted vs. not-encrypted). */ encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Filters results by IP version (Ipv4 vs. IPv6). */ ipVersion?: Array<'IPv4' | 'IPv6'>; /** * Array of names used to label the series in the response. */ name?: Array; } export declare namespace Summary { export { type SummaryARCResponse as SummaryARCResponse, type SummaryDKIMResponse as SummaryDKIMResponse, type SummaryDMARCResponse as SummaryDMARCResponse, type SummaryEncryptedResponse as SummaryEncryptedResponse, type SummaryIPVersionResponse as SummaryIPVersionResponse, type SummarySPFResponse as SummarySPFResponse, type SummaryARCParams as SummaryARCParams, type SummaryDKIMParams as SummaryDKIMParams, type SummaryDMARCParams as SummaryDMARCParams, type SummaryEncryptedParams as SummaryEncryptedParams, type SummaryIPVersionParams as SummaryIPVersionParams, type SummarySPFParams as SummarySPFParams, }; } //# sourceMappingURL=summary.d.ts.map