cloudflare/src/resources/radar/search.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../core/resource';
import { APIPromise } from '../../core/api-promise';
import { RequestOptions } from '../../internal/request-options';

export class BaseSearch extends APIResource {
  static override readonly _key: readonly ['radar', 'search'] = Object.freeze(['radar', 'search'] as const);

  /**
   * 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> {
    return (
      this._client.get('/radar/search/global', { query, ...options }) as APIPromise<{
        result: SearchGlobalResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Search extends BaseSearch {}

export interface SearchGlobalResponse {
  search: Array<SearchGlobalResponse.Search>;
}

export namespace SearchGlobalResponse {
  export 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 };
}