cloudflare
Version:
The official TypeScript library for the Cloudflare API
167 lines • 6.88 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
import * as BotClassAPI from "./bot-class.js";
import { BotClass, BotClassGetParams, BotClassGetResponse } from "./bot-class.js";
import * as BrowserFamilyAPI from "./browser-family.js";
import { BrowserFamily, BrowserFamilyGetParams, BrowserFamilyGetResponse } from "./browser-family.js";
import * as DeviceTypeAPI from "./device-type.js";
import { DeviceType, DeviceTypeGetParams, DeviceTypeGetResponse } from "./device-type.js";
import * as HTTPMethodAPI from "./http-method.js";
import { HTTPMethod, HTTPMethodGetParams, HTTPMethodGetResponse } from "./http-method.js";
import * as HTTPProtocolAPI from "./http-protocol.js";
import { HTTPProtocol, HTTPProtocolGetParams, HTTPProtocolGetResponse } from "./http-protocol.js";
import * as IPVersionAPI from "./ip-version.js";
import { IPVersion, IPVersionGetParams, IPVersionGetResponse } from "./ip-version.js";
import * as OSAPI from "./os.js";
import { OS, OSGetParams, OSGetResponse } from "./os.js";
import * as TLSVersionAPI from "./tls-version.js";
import { TLSVersion, TLSVersionGetParams, TLSVersionGetResponse } from "./tls-version.js";
export declare class Ases extends APIResource {
botClass: BotClassAPI.BotClass;
deviceType: DeviceTypeAPI.DeviceType;
httpProtocol: HTTPProtocolAPI.HTTPProtocol;
httpMethod: HTTPMethodAPI.HTTPMethod;
ipVersion: IPVersionAPI.IPVersion;
os: OSAPI.OS;
tlsVersion: TLSVersionAPI.TLSVersion;
browserFamily: BrowserFamilyAPI.BrowserFamily;
/**
* Retrieves the top autonomous systems by HTTP requests.
*/
get(query?: AseGetParams, options?: Core.RequestOptions): Core.APIPromise<AseGetResponse>;
get(options?: Core.RequestOptions): Core.APIPromise<AseGetResponse>;
}
export interface AseGetResponse {
meta: AseGetResponse.Meta;
top_0: Array<AseGetResponse.Top0>;
}
export declare namespace AseGetResponse {
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 {
clientASN: number;
clientASName: string;
value: string;
}
}
export interface AseGetParams {
/**
* 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 declare namespace Ases {
export { type AseGetResponse as AseGetResponse, type AseGetParams as AseGetParams };
export { BotClass as BotClass, type BotClassGetResponse as BotClassGetResponse, type BotClassGetParams as BotClassGetParams, };
export { DeviceType as DeviceType, type DeviceTypeGetResponse as DeviceTypeGetResponse, type DeviceTypeGetParams as DeviceTypeGetParams, };
export { HTTPProtocol as HTTPProtocol, type HTTPProtocolGetResponse as HTTPProtocolGetResponse, type HTTPProtocolGetParams as HTTPProtocolGetParams, };
export { HTTPMethod as HTTPMethod, type HTTPMethodGetResponse as HTTPMethodGetResponse, type HTTPMethodGetParams as HTTPMethodGetParams, };
export { IPVersion as IPVersion, type IPVersionGetResponse as IPVersionGetResponse, type IPVersionGetParams as IPVersionGetParams, };
export { OS as OS, type OSGetResponse as OSGetResponse, type OSGetParams as OSGetParams };
export { TLSVersion as TLSVersion, type TLSVersionGetResponse as TLSVersionGetResponse, type TLSVersionGetParams as TLSVersionGetParams, };
export { BrowserFamily as BrowserFamily, type BrowserFamilyGetResponse as BrowserFamilyGetResponse, type BrowserFamilyGetParams as BrowserFamilyGetParams, };
}
//# sourceMappingURL=ases.d.ts.map