// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details. import * as Core from 'cloudflare/core'; import { APIResource } from 'cloudflare/resource'; import { isRequestOptions } from 'cloudflare/core'; import * as SummaryAPI from 'cloudflare/resources/radar/as112/summary'; export class Summary extends APIResource { /** * Percentage distribution of DNS queries to AS112 by DNSSEC support. */ dnssec(query?: SummaryDNSSECParams, options?: Core.RequestOptions): Core.APIPromise; dnssec(options?: Core.RequestOptions): Core.APIPromise; dnssec( query: SummaryDNSSECParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.dnssec({}, query); } return ( this._client.get('/radar/as112/summary/dnssec', { query, ...options }) as Core.APIPromise<{ result: SummaryDNSSECResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Percentage distribution of DNS queries, to AS112, by EDNS support. */ edns(query?: SummaryEdnsParams, options?: Core.RequestOptions): Core.APIPromise; edns(options?: Core.RequestOptions): Core.APIPromise; edns( query: SummaryEdnsParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.edns({}, query); } return ( this._client.get('/radar/as112/summary/edns', { query, ...options }) as Core.APIPromise<{ result: SummaryEdnsResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Percentage distribution of DNS queries to AS112 per IP Version. */ ipVersion( query?: SummaryIPVersionParams, options?: Core.RequestOptions, ): Core.APIPromise; ipVersion(options?: Core.RequestOptions): Core.APIPromise; ipVersion( query: SummaryIPVersionParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.ipVersion({}, query); } return ( this._client.get('/radar/as112/summary/ip_version', { query, ...options }) as Core.APIPromise<{ result: SummaryIPVersionResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Percentage distribution of DNS queries to AS112 per protocol. */ protocol( query?: SummaryProtocolParams, options?: Core.RequestOptions, ): Core.APIPromise; protocol(options?: Core.RequestOptions): Core.APIPromise; protocol( query: SummaryProtocolParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.protocol({}, query); } return ( this._client.get('/radar/as112/summary/protocol', { query, ...options }) as Core.APIPromise<{ result: SummaryProtocolResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Percentage distribution of DNS queries to AS112 by Query Type. */ queryType( query?: SummaryQueryTypeParams, options?: Core.RequestOptions, ): Core.APIPromise; queryType(options?: Core.RequestOptions): Core.APIPromise; queryType( query: SummaryQueryTypeParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.queryType({}, query); } return ( this._client.get('/radar/as112/summary/query_type', { query, ...options }) as Core.APIPromise<{ result: SummaryQueryTypeResponse; }> )._thenUnwrap((obj) => obj.result); } /** * Percentage distribution of AS112 dns requests classified per Response Codes. */ responseCodes( query?: SummaryResponseCodesParams, options?: Core.RequestOptions, ): Core.APIPromise; responseCodes(options?: Core.RequestOptions): Core.APIPromise; responseCodes( query: SummaryResponseCodesParams | Core.RequestOptions = {}, options?: Core.RequestOptions, ): Core.APIPromise { if (isRequestOptions(query)) { return this.responseCodes({}, query); } return ( this._client.get('/radar/as112/summary/response_codes', { query, ...options }) as Core.APIPromise<{ result: SummaryResponseCodesResponse; }> )._thenUnwrap((obj) => obj.result); } } export interface SummaryDNSSECResponse { meta: SummaryDNSSECResponse.Meta; summary_0: SummaryDNSSECResponse.Summary0; } export namespace SummaryDNSSECResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { NOT_SUPPORTED: string; SUPPORTED: string; } } export interface SummaryEdnsResponse { meta: SummaryEdnsResponse.Meta; summary_0: SummaryEdnsResponse.Summary0; } export namespace SummaryEdnsResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { NOT_SUPPORTED: string; SUPPORTED: string; } } export interface SummaryIPVersionResponse { meta: SummaryIPVersionResponse.Meta; summary_0: SummaryIPVersionResponse.Summary0; } export namespace SummaryIPVersionResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { IPv4: string; IPv6: string; } } export interface SummaryProtocolResponse { meta: SummaryProtocolResponse.Meta; summary_0: SummaryProtocolResponse.Summary0; } export namespace SummaryProtocolResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { tcp: string; udp: string; } } export interface SummaryQueryTypeResponse { meta: SummaryQueryTypeResponse.Meta; summary_0: SummaryQueryTypeResponse.Summary0; } export namespace SummaryQueryTypeResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { A: string; AAAA: string; PTR: string; SOA: string; SRV: string; } } export interface SummaryResponseCodesResponse { meta: SummaryResponseCodesResponse.Meta; summary_0: SummaryResponseCodesResponse.Summary0; } export namespace SummaryResponseCodesResponse { export interface Meta { dateRange: Array; lastUpdated: string; normalization: string; confidenceInfo?: Meta.ConfidenceInfo; } export namespace Meta { export interface DateRange { /** * Adjusted end of date range. */ endTime: string; /** * Adjusted start of date range. */ startTime: string; } export interface ConfidenceInfo { annotations?: Array; level?: number; } export namespace ConfidenceInfo { export interface Annotation { dataSource: string; description: string; eventType: string; isInstantaneous: unknown; endTime?: string; linkedUrl?: string; startTime?: string; } } } export interface Summary0 { NOERROR: string; NXDOMAIN: string; } } export interface SummaryDNSSECParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export interface SummaryEdnsParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export interface SummaryIPVersionParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export interface SummaryProtocolParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export interface SummaryQueryTypeParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export interface SummaryResponseCodesParams { /** * Array of comma separated list of ASNs, start with `-` to exclude from results. * For example, `-174, 3356` excludes results from AS174, but includes results from * AS3356. */ asn?: Array; /** * Array of comma separated list of continents (alpha-2 continent codes). Start * with `-` to exclude from results. For example, `-EU,NA` excludes results from * Europe, but includes results from North America. */ continent?: Array; /** * End of the date range (inclusive). */ dateEnd?: Array; /** * 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; /** * Format results are returned in. */ format?: 'JSON' | 'CSV'; /** * Array of comma separated list of locations (alpha-2 country codes). Start with * `-` to exclude from results. For example, `-US,PT` excludes results from the US, * but includes results from PT. */ location?: Array; /** * Array of names that will be used to name the series in responses. */ name?: Array; } export namespace Summary { export import SummaryDNSSECResponse = SummaryAPI.SummaryDNSSECResponse; export import SummaryEdnsResponse = SummaryAPI.SummaryEdnsResponse; export import SummaryIPVersionResponse = SummaryAPI.SummaryIPVersionResponse; export import SummaryProtocolResponse = SummaryAPI.SummaryProtocolResponse; export import SummaryQueryTypeResponse = SummaryAPI.SummaryQueryTypeResponse; export import SummaryResponseCodesResponse = SummaryAPI.SummaryResponseCodesResponse; export import SummaryDNSSECParams = SummaryAPI.SummaryDNSSECParams; export import SummaryEdnsParams = SummaryAPI.SummaryEdnsParams; export import SummaryIPVersionParams = SummaryAPI.SummaryIPVersionParams; export import SummaryProtocolParams = SummaryAPI.SummaryProtocolParams; export import SummaryQueryTypeParams = SummaryAPI.SummaryQueryTypeParams; export import SummaryResponseCodesParams = SummaryAPI.SummaryResponseCodesParams; }