UNPKG

cloudflare

Version:

The official TypeScript library for the Cloudflare API

1,114 lines 45.4 kB
import { APIResource } from "../../../resource.js"; import * as Core from "../../../core.js"; export declare class Summary extends APIResource { /** * Retrieves the distribution of DNS queries by cache status. */ cacheHit(query?: SummaryCacheHitParams, options?: Core.RequestOptions): Core.APIPromise<SummaryCacheHitResponse>; cacheHit(options?: Core.RequestOptions): Core.APIPromise<SummaryCacheHitResponse>; /** * Retrieves the distribution of DNS responses by DNSSEC (DNS Security Extensions) * support. */ dnssec(query?: SummaryDNSSECParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECResponse>; dnssec(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECResponse>; /** * Retrieves the distribution of DNS queries by DNSSEC (DNS Security Extensions) * client awareness. */ dnssecAware(query?: SummaryDNSSECAwareParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECAwareResponse>; dnssecAware(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECAwareResponse>; /** * Retrieves the distribution of DNSSEC-validated answers by end-to-end security * status. */ dnssecE2E(query?: SummaryDNSSECE2EParams, options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECE2EResponse>; dnssecE2E(options?: Core.RequestOptions): Core.APIPromise<SummaryDNSSECE2EResponse>; /** * Retrieves the distribution of DNS queries by IP version. */ ipVersion(query?: SummaryIPVersionParams, options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>; ipVersion(options?: Core.RequestOptions): Core.APIPromise<SummaryIPVersionResponse>; /** * Retrieves the distribution of DNS queries by matching answers. */ matchingAnswer(query?: SummaryMatchingAnswerParams, options?: Core.RequestOptions): Core.APIPromise<SummaryMatchingAnswerResponse>; matchingAnswer(options?: Core.RequestOptions): Core.APIPromise<SummaryMatchingAnswerResponse>; /** * Retrieves the distribution of DNS queries by DNS transport protocol. */ protocol(query?: SummaryProtocolParams, options?: Core.RequestOptions): Core.APIPromise<SummaryProtocolResponse>; protocol(options?: Core.RequestOptions): Core.APIPromise<SummaryProtocolResponse>; /** * Retrieves the distribution of DNS queries by type. */ queryType(query?: SummaryQueryTypeParams, options?: Core.RequestOptions): Core.APIPromise<SummaryQueryTypeResponse>; queryType(options?: Core.RequestOptions): Core.APIPromise<SummaryQueryTypeResponse>; /** * Retrieves the distribution of DNS queries by response code. */ responseCode(query?: SummaryResponseCodeParams, options?: Core.RequestOptions): Core.APIPromise<SummaryResponseCodeResponse>; responseCode(options?: Core.RequestOptions): Core.APIPromise<SummaryResponseCodeResponse>; /** * Retrieves the distribution of DNS queries by minimum response TTL. */ responseTTL(query?: SummaryResponseTTLParams, options?: Core.RequestOptions): Core.APIPromise<SummaryResponseTTLResponse>; responseTTL(options?: Core.RequestOptions): Core.APIPromise<SummaryResponseTTLResponse>; } export interface SummaryCacheHitResponse { meta: SummaryCacheHitResponse.Meta; summary_0: SummaryCacheHitResponse.Summary0; } export declare namespace SummaryCacheHitResponse { 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 { NEGATIVE: string; POSITIVE: string; } } export interface SummaryDNSSECResponse { meta: SummaryDNSSECResponse.Meta; summary_0: SummaryDNSSECResponse.Summary0; } export declare namespace SummaryDNSSECResponse { 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 { INSECURE: string; INVALID: string; OTHER: string; SECURE: string; } } export interface SummaryDNSSECAwareResponse { meta: SummaryDNSSECAwareResponse.Meta; summary_0: SummaryDNSSECAwareResponse.Summary0; } export declare namespace SummaryDNSSECAwareResponse { 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_SUPPORTED: string; SUPPORTED: string; } } export interface SummaryDNSSECE2EResponse { meta: SummaryDNSSECE2EResponse.Meta; summary_0: SummaryDNSSECE2EResponse.Summary0; } export declare namespace SummaryDNSSECE2EResponse { 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 { NEGATIVE: string; POSITIVE: 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: boolean; endTime?: string; linkedUrl?: string; startTime?: string; } } } interface Summary0 { IPv4: string; IPv6: string; } } export interface SummaryMatchingAnswerResponse { meta: SummaryMatchingAnswerResponse.Meta; summary_0: SummaryMatchingAnswerResponse.Summary0; } export declare namespace SummaryMatchingAnswerResponse { 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 { NEGATIVE: string; POSITIVE: string; } } export interface SummaryProtocolResponse { meta: SummaryProtocolResponse.Meta; summary_0: SummaryProtocolResponse.Summary0; } export declare namespace SummaryProtocolResponse { 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 { HTTPS: string; TCP: string; TLS: string; UDP: string; } } export interface SummaryQueryTypeResponse { meta: SummaryQueryTypeResponse.Meta; summary_0: Record<string, string>; } export declare namespace SummaryQueryTypeResponse { 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 SummaryResponseCodeResponse { meta: SummaryResponseCodeResponse.Meta; summary_0: Record<string, string>; } export declare namespace SummaryResponseCodeResponse { 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 SummaryResponseTTLResponse { meta: SummaryResponseTTLResponse.Meta; summary_0: SummaryResponseTTLResponse.Summary0; } export declare namespace SummaryResponseTTLResponse { 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 { gt_15m_lte_1h: string; gt_1d_lte_1w: string; gt_1h_lte_1d: string; gt_1m_lte_5m: string; gt_1w: string; gt_5m_lte_15m: string; lte_1m: string; } } export interface SummaryCacheHitParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryDNSSECParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryDNSSECAwareParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryDNSSECE2EParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryIPVersionParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryMatchingAnswerParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryProtocolParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryQueryTypeParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects per group to the top items within the specified * time range. If there are more items than the limit, the response will include * the count of items, with any remaining items grouped together under an "other" * category. */ limitPerGroup?: number; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryResponseCodeParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Limits the number of objects per group to the top items within the specified * time range. If there are more items than the limit, the response will include * the count of items, with any remaining items grouped together under an "other" * category. */ limitPerGroup?: number; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export interface SummaryResponseTTLParams { /** * Comma-separated list of Autonomous System Numbers (ASNs). Prefix with `-` to * exclude ASNs from results. For example, `-174, 3356` excludes results from * AS174, but includes results from AS3356. */ asn?: Array<string>; /** * Comma-separated list of continents (alpha-2 continent codes). Prefix with `-` to * exclude continents from results. For example, `-EU,NA` excludes results from EU, * but includes results from NA. */ continent?: Array<string>; /** * 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>; /** * Format in which results will be returned. */ format?: 'JSON' | 'CSV'; /** * Comma-separated list of locations (alpha-2 codes). Prefix with `-` to exclude * locations from results. For example, `-US,PT` excludes results from the US, but * includes results from PT. */ location?: Array<string>; /** * Array of names used to label the series in the response. */ name?: Array<string>; /** * Includes empty DNS responses (NODATA). */ nodata?: boolean; /** * Filters results by DNS transport protocol. */ protocol?: 'UDP' | 'TCP' | 'HTTPS' | 'TLS'; /** * Filters results by DNS query type. */ queryType?: 'A' | 'AAAA' | 'A6' | 'AFSDB' | 'ANY' | 'APL' | 'ATMA' | 'AXFR' | 'CAA' | 'CDNSKEY' | 'CDS' | 'CERT' | 'CNAME' | 'CSYNC' | 'DHCID' | 'DLV' | 'DNAME' | 'DNSKEY' | 'DOA' | 'DS' | 'EID' | 'EUI48' | 'EUI64' | 'GPOS' | 'GID' | 'HINFO' | 'HIP' | 'HTTPS' | 'IPSECKEY' | 'ISDN' | 'IXFR' | 'KEY' | 'KX' | 'L32' | 'L64' | 'LOC' | 'LP' | 'MAILA' | 'MAILB' | 'MB' | 'MD' | 'MF' | 'MG' | 'MINFO' | 'MR' | 'MX' | 'NAPTR' | 'NB' | 'NBSTAT' | 'NID' | 'NIMLOC' | 'NINFO' | 'NS' | 'NSAP' | 'NSEC' | 'NSEC3' | 'NSEC3PARAM' | 'NULL' | 'NXT' | 'OPENPGPKEY' | 'OPT' | 'PTR' | 'PX' | 'RKEY' | 'RP' | 'RRSIG' | 'RT' | 'SIG' | 'SINK' | 'SMIMEA' | 'SOA' | 'SPF' | 'SRV' | 'SSHFP' | 'SVCB' | 'TA' | 'TALINK' | 'TKEY' | 'TLSA' | 'TSIG' | 'TXT' | 'UINFO' | 'UID' | 'UNSPEC' | 'URI' | 'WKS' | 'X25' | 'ZONEMD' | null; /** * Filters results by DNS response code. */ responseCode?: 'NOERROR' | 'FORMERR' | 'SERVFAIL' | 'NXDOMAIN' | 'NOTIMP' | 'REFUSED' | 'YXDOMAIN' | 'YXRRSET' | 'NXRRSET' | 'NOTAUTH' | 'NOTZONE' | 'BADSIG' | 'BADKEY' | 'BADTIME' | 'BADMODE' | 'BADNAME' | 'BADALG' | 'BADTRUNC' | 'BADCOOKIE'; /** * Filters results by country code top-level domain (ccTLD). */ tld?: Array<string>; } export declare namespace Summary { export { type SummaryCacheHitResponse as SummaryCacheHitResponse, type SummaryDNSSECResponse as SummaryDNSSECResponse, type SummaryDNSSECAwareResponse as SummaryDNSSECAwareResponse, type SummaryDNSSECE2EResponse as SummaryDNSSECE2EResponse, type SummaryIPVersionResponse as SummaryIPVersionResponse, type SummaryMatchingAnswerResponse as SummaryMatchingAnswerResponse, type SummaryProtocolResponse as SummaryProtocolResponse, type SummaryQueryTypeResponse as SummaryQueryTypeResponse, type SummaryResponseCodeResponse as SummaryResponseCodeResponse, type SummaryResponseTTLResponse as SummaryResponseTTLResponse, type SummaryCacheHitParams as SummaryCacheHitParams, type SummaryDNSSECParams as SummaryDNSSECParams, type SummaryDNSSECAwareParams as SummaryDNSSECAwareParams, type SummaryDNSSECE2EParams as SummaryDNSSECE2EParams, type SummaryIPVersionParams as SummaryIPVersionParams, type SummaryMatchingAnswerParams as SummaryMatchingAnswerParams, type SummaryProtocolParams as SummaryProtocolParams, type SummaryQueryTypeParams as SummaryQueryTypeParams, type SummaryResponseCodeParams as SummaryResponseCodeParams, type SummaryResponseTTLParams as SummaryResponseTTLParams, }; } //# sourceMappingURL=summary.d.ts.map