cloudflare/src/resources/cloudforce-one/threat-events/countries.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';
import { path } from '../../../internal/utils/path';

export class BaseCountries extends APIResource {
  static override readonly _key: readonly ['cloudforceOne', 'threatEvents', 'countries'] = Object.freeze([
    'cloudforceOne',
    'threatEvents',
    'countries',
  ] as const);

  /**
   * Lists countries referenced in Cloudforce One threat intelligence data.
   *
   * @example
   * ```ts
   * const countries =
   *   await client.cloudforceOne.threatEvents.countries.list({
   *     account_id: 'account_id',
   *   });
   * ```
   */
  list(params: CountryListParams, options?: RequestOptions): APIPromise<CountryListResponse> {
    const { account_id } = params;
    return this._client.get(path`/accounts/${account_id}/cloudforce-one/events/countries`, options);
  }
}
export class Countries extends BaseCountries {}

export type CountryListResponse = Array<CountryListResponse.CountryListResponseItem>;

export namespace CountryListResponse {
  export interface CountryListResponseItem {
    result: Array<CountryListResponseItem.Result>;

    success: string;
  }

  export namespace CountryListResponseItem {
    export interface Result {
      alpha2: string;

      alpha3: string;

      name: string;
    }
  }
}

export interface CountryListParams {
  /**
   * Account ID.
   */
  account_id: string;
}

export declare namespace Countries {
  export { type CountryListResponse as CountryListResponse, type CountryListParams as CountryListParams };
}