cloudflare
Version:
The official TypeScript library for the Cloudflare API
108 lines • 3.37 kB
TypeScript
import { APIResource } from "../../../../../../resource.js";
import * as Core from "../../../../../../core.js";
export declare class Spam extends APIResource {
/**
* Retrieves the top TLDs by emails classified as spam or not.
*/
get(spam: 'SPAM' | 'NOT_SPAM', query?: SpamGetParams, options?: Core.RequestOptions): Core.APIPromise<SpamGetResponse>;
get(spam: 'SPAM' | 'NOT_SPAM', options?: Core.RequestOptions): Core.APIPromise<SpamGetResponse>;
}
export interface SpamGetResponse {
meta: SpamGetResponse.Meta;
top_0: Array<SpamGetResponse.Top0>;
}
export declare namespace SpamGetResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: 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 Top0 {
name: 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).
*/
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';
/**
* 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.ts.map