cloudflare
Version:
The official TypeScript library for the Cloudflare API
576 lines • 17.8 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as SummaryAPI from 'cloudflare/resources/radar/email/routing/summary';
export declare class Summary extends APIResource {
/**
* Percentage distribution of emails classified per ARC validation.
*/
arc(query?: SummaryARCParams, options?: Core.RequestOptions): Core.APIPromise<SummaryARCResponse>;
arc(options?: Core.RequestOptions): Core.APIPromise<SummaryARCResponse>;
/**
* Percentage distribution of emails classified per DKIM validation.
*/
dkim(query?: SummaryDKIMParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDKIMResponse>;
dkim(options?: Core.RequestOptions): Core.APIPromise<SummaryDKIMResponse>;
/**
* Percentage distribution of emails classified per DMARC validation.
*/
dmarc(query?: SummaryDMARCParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDMARCResponse>;
dmarc(options?: Core.RequestOptions): Core.APIPromise<SummaryDMARCResponse>;
/**
* Percentage distribution of emails by Encrypted
*/
encrypted(query?: SummaryEncryptedParams, options?: Core.RequestOptions): Core.APIPromise<SummaryEncryptedResponse>;
encrypted(options?: Core.RequestOptions): Core.APIPromise<SummaryEncryptedResponse>;
/**
* Percentage distribution of emails by Ip Version.
*/
ipVersion(query?: SummaryIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>;
ipVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>;
/**
* Percentage distribution of emails classified per SPF validation.
*/
spf(query?: SummarySPFParams, options?: Core.RequestOptions): Core.APIPromise<SummarySPFResponse>;
spf(options?: Core.RequestOptions): Core.APIPromise<SummarySPFResponse>;
}
export interface SummaryARCResponse {
meta: SummaryARCResponse.Meta;
summary_0: SummaryARCResponse.Summary0;
}
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
FAIL: string;
NONE: string;
PASS: string;
}
}
export interface SummaryDKIMResponse {
meta: SummaryDKIMResponse.Meta;
summary_0: SummaryDKIMResponse.Summary0;
}
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
FAIL: string;
NONE: string;
PASS: string;
}
}
export interface SummaryDMARCResponse {
meta: SummaryDMARCResponse.Meta;
summary_0: SummaryDMARCResponse.Summary0;
}
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
FAIL: string;
NONE: string;
PASS: string;
}
}
export interface SummaryEncryptedResponse {
meta: SummaryEncryptedResponse.Meta;
summary_0: SummaryEncryptedResponse.Summary0;
}
export declare namespace SummaryEncryptedResponse {
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
ENCRYPTED: string;
NOT_ENCRYPTED: string;
}
}
export interface SummaryIPVersionResponse {
meta: SummaryIPVersionResponse.Meta;
summary_0: SummaryIPVersionResponse.Summary0;
}
export declare namespace SummaryIPVersionResponse {
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
IPv4: string;
IPv6: string;
}
}
export interface SummarySPFResponse {
meta: SummarySPFResponse.Meta;
summary_0: SummarySPFResponse.Summary0;
}
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
interface Summary0 {
FAIL: string;
NONE: string;
PASS: string;
}
}
export interface SummaryARCParams {
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dkim.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for dmarc.
*/
dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for encrypted emails.
*/
encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for spf.
*/
spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
}
export interface SummaryDKIMParams {
/**
* Filter for arc (Authenticated Received Chain).
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dmarc.
*/
dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for encrypted emails.
*/
encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for spf.
*/
spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
}
export interface SummaryDMARCParams {
/**
* Filter for arc (Authenticated Received Chain).
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dkim.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for encrypted emails.
*/
encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for spf.
*/
spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
}
export interface SummaryEncryptedParams {
/**
* Filter for arc (Authenticated Received Chain).
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dkim.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for dmarc.
*/
dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for spf.
*/
spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
}
export interface SummaryIPVersionParams {
/**
* Filter for arc (Authenticated Received Chain).
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dkim.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for dmarc.
*/
dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for encrypted emails.
*/
encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for spf.
*/
spf?: Array<'PASS' | 'NONE' | 'FAIL'>;
}
export interface SummarySPFParams {
/**
* Filter for arc (Authenticated Received Chain).
*/
arc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* End of the date range (inclusive).
*/
dateEnd?: Array<string>;
/**
* 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<'1d' | '2d' | '7d' | '14d' | '28d' | '12w' | '24w' | '52w' | '1dControl' | '2dControl' | '7dControl' | '14dControl' | '28dControl' | '12wControl' | '24wControl'>;
/**
* Array of datetimes to filter the start of a series.
*/
dateStart?: Array<string>;
/**
* Filter for dkim.
*/
dkim?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for dmarc.
*/
dmarc?: Array<'PASS' | 'NONE' | 'FAIL'>;
/**
* Filter for encrypted emails.
*/
encrypted?: Array<'ENCRYPTED' | 'NOT_ENCRYPTED'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
}
export declare namespace Summary {
export import SummaryARCResponse = SummaryAPI.SummaryARCResponse;
export import SummaryDKIMResponse = SummaryAPI.SummaryDKIMResponse;
export import SummaryDMARCResponse = SummaryAPI.SummaryDMARCResponse;
export import SummaryEncryptedResponse = SummaryAPI.SummaryEncryptedResponse;
export import SummaryIPVersionResponse = SummaryAPI.SummaryIPVersionResponse;
export import SummarySPFResponse = SummaryAPI.SummarySPFResponse;
export import SummaryARCParams = SummaryAPI.SummaryARCParams;
export import SummaryDKIMParams = SummaryAPI.SummaryDKIMParams;
export import SummaryDMARCParams = SummaryAPI.SummaryDMARCParams;
export import SummaryEncryptedParams = SummaryAPI.SummaryEncryptedParams;
export import SummaryIPVersionParams = SummaryAPI.SummaryIPVersionParams;
export import SummarySPFParams = SummaryAPI.SummarySPFParams;
}
//# sourceMappingURL=summary.d.ts.map