cloudflare
Version:
The official TypeScript library for the Cloudflare API
818 lines • 26.5 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
import * as EmailAPI from "../email.js";
export declare class Summary extends APIResource {
/**
* Retrieves the distribution of emails by ARC (Authenticated Received Chain)
* validation.
*/
arc(query?: SummaryARCParams, options?: Core.RequestOptions): Core.APIPromise<SummaryARCResponse>;
arc(options?: Core.RequestOptions): Core.APIPromise<SummaryARCResponse>;
/**
* Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail)
* validation.
*/
dkim(query?: SummaryDKIMParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDKIMResponse>;
dkim(options?: Core.RequestOptions): Core.APIPromise<SummaryDKIMResponse>;
/**
* Retrieves the distribution of emails by DMARC (Domain-based Message
* Authentication, Reporting and Conformance) validation.
*/
dmarc(query?: SummaryDMARCParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDMARCResponse>;
dmarc(options?: Core.RequestOptions): Core.APIPromise<SummaryDMARCResponse>;
/**
* Retrieves the distribution of emails by malicious classification.
*/
malicious(query?: SummaryMaliciousParams, options?: Core.RequestOptions): Core.APIPromise<SummaryMaliciousResponse>;
malicious(options?: Core.RequestOptions): Core.APIPromise<SummaryMaliciousResponse>;
/**
* Retrieves the proportion of emails by spam classification (spam vs. non-spam).
*/
spam(query?: SummarySpamParams, options?: Core.RequestOptions): Core.APIPromise<SummarySpamResponse>;
spam(options?: Core.RequestOptions): Core.APIPromise<SummarySpamResponse>;
/**
* Retrieves the distribution of emails by SPF (Sender Policy Framework)
* validation.
*/
spf(query?: SummarySPFParams, options?: Core.RequestOptions): Core.APIPromise<SummarySPFResponse>;
spf(options?: Core.RequestOptions): Core.APIPromise<SummarySPFResponse>;
/**
* Retrieves the proportion of emails by spoof classification (spoof vs.
* non-spoof).
*/
spoof(query?: SummarySpoofParams, options?: Core.RequestOptions): Core.APIPromise<SummarySpoofResponse>;
spoof(options?: Core.RequestOptions): Core.APIPromise<SummarySpoofResponse>;
/**
* Retrieves the distribution of emails by threat categories.
*/
threatCategory(query?: SummaryThreatCategoryParams, options?: Core.RequestOptions): Core.APIPromise<SummaryThreatCategoryResponse>;
threatCategory(options?: Core.RequestOptions): Core.APIPromise<SummaryThreatCategoryResponse>;
/**
* Retrieves the distribution of emails by TLS version.
*/
tlsVersion(query?: SummaryTLSVersionParams, options?: Core.RequestOptions): Core.APIPromise<SummaryTLSVersionResponse>;
tlsVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryTLSVersionResponse>;
}
export interface SummaryARCResponse {
meta: SummaryARCResponse.Meta;
summary_0: EmailAPI.RadarEmailSummary;
}
export declare namespace SummaryARCResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface SummaryDKIMResponse {
meta: SummaryDKIMResponse.Meta;
summary_0: EmailAPI.RadarEmailSummary;
}
export declare namespace SummaryDKIMResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface SummaryDMARCResponse {
meta: SummaryDMARCResponse.Meta;
summary_0: EmailAPI.RadarEmailSummary;
}
export declare namespace SummaryDMARCResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface SummaryMaliciousResponse {
meta: SummaryMaliciousResponse.Meta;
summary_0: SummaryMaliciousResponse.Summary0;
}
export declare namespace SummaryMaliciousResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
MALICIOUS: string;
NOT_MALICIOUS: string;
}
}
export interface SummarySpamResponse {
meta: SummarySpamResponse.Meta;
summary_0: SummarySpamResponse.Summary0;
}
export declare namespace SummarySpamResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
NOT_SPAM: string;
SPAM: string;
}
}
export interface SummarySPFResponse {
meta: SummarySPFResponse.Meta;
summary_0: EmailAPI.RadarEmailSummary;
}
export declare namespace SummarySPFResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface SummarySpoofResponse {
meta: SummarySpoofResponse.Meta;
summary_0: SummarySpoofResponse.Summary0;
}
export declare namespace SummarySpoofResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
NOT_SPOOF: string;
SPOOF: string;
}
}
export interface SummaryThreatCategoryResponse {
meta: SummaryThreatCategoryResponse.Meta;
summary_0: SummaryThreatCategoryResponse.Summary0;
}
export declare namespace SummaryThreatCategoryResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
BrandImpersonation: string;
CredentialHarvester: string;
IdentityDeception: string;
Link: string;
}
}
export interface SummaryTLSVersionResponse {
meta: SummaryTLSVersionResponse.Meta;
summary_0: SummaryTLSVersionResponse.Summary0;
}
export declare namespace SummaryTLSVersionResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
}
namespace Meta {
interface DateRange {
/**
* Adjusted end of date range.
*/
endTime: string;
/**
* Adjusted start of date range.
*/
startTime: string;
}
interface ConfidenceInfo {
annotations?: Array<ConfidenceInfo.Annotation>;
level?: number;
}
namespace ConfidenceInfo {
interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
'TLS 1.0': string;
'TLS 1.1': string;
'TLS 1.2': string;
'TLS 1.3': string;
}
}
export interface SummaryARCParams {
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummaryDKIMParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* 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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummaryDMARCParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
dateStart?: Array<string>;
/**
* Filters results by DKIM (DomainKeys Identified Mail) validation status.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummaryMaliciousParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummarySpamParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummarySPFParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* Filters results by TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummarySpoofParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummaryThreatCategoryParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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 TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3'>;
}
export interface SummaryTLSVersionParams {
/**
* Filters results by ARC (Authenticated Received Chain) validation.
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* Filters results by the specified date range. For example, use `7d` and
* `7dcontrol` to compare this week with the previous week. Use this parameter or
* set specific start and end dates (`dateStart` and `dateEnd` parameters).
*/
dateRange?: Array<string>;
/**
* Start of the date range.
*/
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';
/**
* 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'>;
}
export declare namespace Summary {
export { type SummaryARCResponse as SummaryARCResponse, type SummaryDKIMResponse as SummaryDKIMResponse, type SummaryDMARCResponse as SummaryDMARCResponse, type SummaryMaliciousResponse as SummaryMaliciousResponse, type SummarySpamResponse as SummarySpamResponse, type SummarySPFResponse as SummarySPFResponse, type SummarySpoofResponse as SummarySpoofResponse, type SummaryThreatCategoryResponse as SummaryThreatCategoryResponse, type SummaryTLSVersionResponse as SummaryTLSVersionResponse, type SummaryARCParams as SummaryARCParams, type SummaryDKIMParams as SummaryDKIMParams, type SummaryDMARCParams as SummaryDMARCParams, type SummaryMaliciousParams as SummaryMaliciousParams, type SummarySpamParams as SummarySpamParams, type SummarySPFParams as SummarySPFParams, type SummarySpoofParams as SummarySpoofParams, type SummaryThreatCategoryParams as SummaryThreatCategoryParams, type SummaryTLSVersionParams as SummaryTLSVersionParams, };
}
//# sourceMappingURL=summary.d.ts.map