cloudflare/resources/radar/search.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.mjs";
import { APIPromise } from "../../core/api-promise.mjs";
import { RequestOptions } from "../../internal/request-options.mjs";
export declare class BaseSearch extends APIResource {
    static readonly _key: readonly ['radar', 'search'];
    /**
     * Searches for locations, autonomous systems, reports, bots, certificate logs,
     * certificate authorities, industries and verticals. Location names can be
     * localized by sending an `Accept-Language` HTTP header with a BCP 47 language tag
     * (e.g., `Accept-Language: pt-PT`). The full quality-value chain is supported
     * (e.g., `pt-PT,pt;q=0.9,en;q=0.8`).
     *
     * @example
     * ```ts
     * const response = await client.radar.search.global({
     *   query: 'United',
     * });
     * ```
     */
    global(query: SearchGlobalParams, options?: RequestOptions): APIPromise<SearchGlobalResponse>;
}
export declare class Search extends BaseSearch {
}
export interface SearchGlobalResponse {
    search: Array<SearchGlobalResponse.Search>;
}
export declare namespace SearchGlobalResponse {
    interface Search {
        code: string;
        name: string;
        type: string;
    }
}
export interface SearchGlobalParams {
    /**
     * String used to perform the search operation.
     */
    query: string;
    /**
     * Search types excluded from results.
     */
    exclude?: Array<'ADM1S' | 'ASNS' | 'BOTS' | 'CERTIFICATE_AUTHORITIES' | 'CERTIFICATE_LOGS' | 'ORIGINS' | 'ORIGIN_REGIONS' | 'INDUSTRIES' | 'LOCATIONS' | 'NOTEBOOKS' | 'TLDS' | 'VERTICALS'>;
    /**
     * Format in which results will be returned.
     */
    format?: 'JSON' | 'CSV';
    /**
     * Search types included in results.
     */
    include?: Array<'ADM1S' | 'ASNS' | 'BOTS' | 'CERTIFICATE_AUTHORITIES' | 'CERTIFICATE_LOGS' | 'ORIGINS' | 'ORIGIN_REGIONS' | 'INDUSTRIES' | 'LOCATIONS' | 'NOTEBOOKS' | 'TLDS' | 'VERTICALS'>;
    /**
     * Limits the number of objects returned in the response.
     */
    limit?: number;
    /**
     * Limits the number of objects per search category.
     */
    limitPerGroup?: number;
}
export declare namespace Search {
    export { type SearchGlobalResponse as SearchGlobalResponse, type SearchGlobalParams as SearchGlobalParams };
}
//# sourceMappingURL=search.d.mts.map