cloudflare
Version:
The official TypeScript library for the Cloudflare API
388 lines (317 loc) • 9.12 kB
text/typescript
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import * as Core from "../../../core";
import { APIResource } from "../../../resource";
import { isRequestOptions } from "../../../core";
import * as TopAPI from "./top";
export class Top extends APIResource {
/**
* Get the top user agents aggregated in families by HTTP traffic. Values are a
* percentage out of the total traffic.
*/
browserFamilies(
query?: TopBrowserFamiliesParams,
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamiliesResponse>;
browserFamilies(options?: Core.RequestOptions): Core.APIPromise<TopBrowserFamiliesResponse>;
browserFamilies(
query: TopBrowserFamiliesParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowserFamiliesResponse> {
if (isRequestOptions(query)) {
return this.browserFamilies({}, query);
}
return (
this._client.get('/radar/http/top/browser_families', { query, ...options }) as Core.APIPromise<{
result: TopBrowserFamiliesResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
/**
* Get the top user agents by HTTP traffic. Values are a percentage out of the
* total traffic.
*/
browsers(query?: TopBrowsersParams, options?: Core.RequestOptions): Core.APIPromise<TopBrowsersResponse>;
browsers(options?: Core.RequestOptions): Core.APIPromise<TopBrowsersResponse>;
browsers(
query: TopBrowsersParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<TopBrowsersResponse> {
if (isRequestOptions(query)) {
return this.browsers({}, query);
}
return (
this._client.get('/radar/http/top/browsers', { query, ...options }) as Core.APIPromise<{
result: TopBrowsersResponse;
}>
)._thenUnwrap((obj) => obj.result);
}
}
export interface Browser {
name: string;
value: string;
}
export interface TopBrowserFamiliesResponse {
meta: TopBrowserFamiliesResponse.Meta;
top_0: Array<Browser>;
}
export namespace TopBrowserFamiliesResponse {
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface TopBrowsersResponse {
meta: TopBrowsersResponse.Meta;
top_0: Array<Browser>;
}
export namespace TopBrowsersResponse {
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: unknown;
endTime?: string;
linkedUrl?: string;
startTime?: string;
}
}
}
}
export interface TopBrowserFamiliesParams {
/**
* 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<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* 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<string>;
/**
* 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 device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limit the number of objects in the response.
*/
limit?: number;
/**
* 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<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export interface TopBrowsersParams {
/**
* 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<string>;
/**
* Filter for bot class. Refer to
* [Bot classes](https://developers.cloudflare.com/radar/concepts/bot-classes/).
*/
botClass?: Array<'LIKELY_AUTOMATED' | 'LIKELY_HUMAN'>;
/**
* 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<string>;
/**
* 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 device type.
*/
deviceType?: Array<'DESKTOP' | 'MOBILE' | 'OTHER'>;
/**
* Format results are returned in.
*/
format?: 'JSON' | 'CSV';
/**
* Filter for http protocol.
*/
httpProtocol?: Array<'HTTP' | 'HTTPS'>;
/**
* Filter for http version.
*/
httpVersion?: Array<'HTTPv1' | 'HTTPv2' | 'HTTPv3'>;
/**
* Filter for ip version.
*/
ipVersion?: Array<'IPv4' | 'IPv6'>;
/**
* Limit the number of objects in the response.
*/
limit?: number;
/**
* 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<string>;
/**
* Array of names that will be used to name the series in responses.
*/
name?: Array<string>;
/**
* Filter for os name.
*/
os?: Array<'WINDOWS' | 'MACOSX' | 'IOS' | 'ANDROID' | 'CHROMEOS' | 'LINUX' | 'SMART_TV'>;
/**
* Filter for tls version.
*/
tlsVersion?: Array<'TLSv1_0' | 'TLSv1_1' | 'TLSv1_2' | 'TLSv1_3' | 'TLSvQUIC'>;
}
export namespace Top {
export import Browser = TopAPI.Browser;
export import TopBrowserFamiliesResponse = TopAPI.TopBrowserFamiliesResponse;
export import TopBrowsersResponse = TopAPI.TopBrowsersResponse;
export import TopBrowserFamiliesParams = TopAPI.TopBrowserFamiliesParams;
export import TopBrowsersParams = TopAPI.TopBrowsersParams;
}