cloudflare
Version:
The official TypeScript library for the Cloudflare API
93 lines • 2.77 kB
TypeScript
import { APIResource } from "../../../../resource.js";
import * as Core from "../../../../core.js";
export declare class UserAgents extends APIResource {
/**
* Retrieves the top user agents on robots.txt files.
*/
directive(query?: UserAgentDirectiveParams, options?: Core.RequestOptions): Core.APIPromise<UserAgentDirectiveResponse>;
directive(options?: Core.RequestOptions): Core.APIPromise<UserAgentDirectiveResponse>;
}
export interface UserAgentDirectiveResponse {
meta: UserAgentDirectiveResponse.Meta;
top_0: Array<UserAgentDirectiveResponse.Top0>;
}
export declare namespace UserAgentDirectiveResponse {
interface Meta {
dateRange: Array<Meta.DateRange>;
lastUpdated: string;
normalization: string;
confidenceInfo?: Meta.ConfidenceInfo;
units?: Array<Meta.Unit>;
}
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 Unit {
name: string;
value: string;
}
}
interface Top0 {
name: string;
value: number;
fully?: number;
partially?: number;
}
}
export interface UserAgentDirectiveParams {
/**
* Array of dates to filter the results.
*/
date?: Array<string>;
/**
* Filters results by robots.txt directive.
*/
directive?: 'ALLOW' | 'DISALLOW';
/**
* Filters results by domain category.
*/
domainCategory?: Array<string>;
/**
* Format in which results will be returned.
*/
format?: 'JSON' | 'CSV';
/**
* Limits the number of objects returned in the response.
*/
limit?: number;
/**
* Array of names used to label the series in the response.
*/
name?: Array<string>;
/**
* Filters results by user agent category.
*/
userAgentCategory?: 'AI';
}
export declare namespace UserAgents {
export { type UserAgentDirectiveResponse as UserAgentDirectiveResponse, type UserAgentDirectiveParams as UserAgentDirectiveParams, };
}
//# sourceMappingURL=user-agents.d.ts.map