cloudflare
Version:
The official TypeScript library for the Cloudflare API
365 lines (291 loc) • 8.92 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../../../resource';
import { isRequestOptions } from '../../../core';
import * as Core from '../../../core';
export class Top extends APIResource {
/**
* Retrieves the top user agents by HTTP requests.
*/
browser(query?: TopBrowserParams, options?: Core.RequestOptions): Core.APIPromise<TopBrowserResponse>;
browser(options?: Core.RequestOptions): Core.APIPromise<TopBrowserResponse>;
browser(
query: TopBrowserParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserResponse> {
if (isRequestOptions(query)) {
return this.browser({}, query);
}
return (
this._client.get('/radar/http/top/browser', { query, ...options }) as Core.APIPromise<{
result: TopBrowserResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Retrieves the top user agents, aggregated in families, by HTTP requests.
*/
browserFamily(
query?: TopBrowserFamilyParams,
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamilyResponse>;
browserFamily(options?: Core.RequestOptions): Core.APIPromise<TopBrowserFamilyResponse>;
browserFamily(
query: TopBrowserFamilyParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamilyResponse> {
if (isRequestOptions(query)) {
return this.browserFamily({}, query);
}
return (
this._client.get('/radar/http/top/browser_family', { query, ...options }) as Core.APIPromise<{
result: TopBrowserFamilyResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export interface TopBrowserResponse {
meta: TopBrowserResponse.Meta;
top_0: Array<TopBrowserResponse.Top0>;
}
export namespace TopBrowserResponse {
export interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: 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<ConfidenceInfo.Annotation>;
level?: number;
}
export namespace ConfidenceInfo {
export interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
export interface Top0 {
name: string;
value: string;
}
}
export interface TopBrowserFamilyResponse {
meta: TopBrowserFamilyResponse.Meta;
top_0: Array<TopBrowserFamilyResponse.Top0>;
}
export namespace TopBrowserFamilyResponse {
export interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: 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<ConfidenceInfo.Annotation>;
level?: number;
}
export namespace ConfidenceInfo {
export interface Annotation {
dataSource: string;
description: string;
eventType: string;
isInstantaneous: boolean;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
export interface Top0 {
name: string;
value: string;
}
}
export interface TopBrowserParams {
/**
* 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>;
/**
* Filters results by bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* Filters results by browser family.
*/
browserFamily?: Array<'CHROME' | 'EDGE' | 'FIREFOX' | 'SAFARI'>;
/**
* 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>;
/**
* Filters results by device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by HTTP protocol (HTTP vs. HTTPS).
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filters results by HTTP version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: 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>;
/**
* Filters results by operating system.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filters results by TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TopBrowserFamilyParams {
/**
* 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>;
/**
* Filters results by bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* 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>;
/**
* Filters results by device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Filters results by HTTP protocol (HTTP vs. HTTPS).
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filters results by HTTP version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filters results by IP version (Ipv4 vs. IPv6).
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limits the number of objects returned in the response.
*/
limit?: 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>;
/**
* Filters results by operating system.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filters results by TLS version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export declare namespace Top {
export {
type TopBrowserResponse as TopBrowserResponse,
type TopBrowserFamilyResponse as TopBrowserFamilyResponse,
type TopBrowserParams as TopBrowserParams,
type TopBrowserFamilyParams as TopBrowserFamilyParams,
};
}