cloudflare/src/resources/intel/ip-lists.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 '../../resource';
import * as Core from '../../core';
import { SinglePage } from '../../pagination';

export class IPLists extends APIResource {
  /**
   * Get IP Lists.
   *
   * @example
   * ```ts
   * // Automatically fetches more pages as needed.
   * for await (const ipList of client.intel.ipLists.get({
   *   account_id: '023e105f4ecef8ad9ca31a8372d0c353',
   * })) {
   *   // ...
   * }
   * ```
   */
  get(params: IPListGetParams, options?: Core.RequestOptions): Core.PagePromise<IPListsSinglePage, IPList> {
    const { account_id } = params;
    return this._client.getAPIList(`/accounts/${account_id}/intel/ip-list`, IPListsSinglePage, options);
  }
}

export class IPListsSinglePage extends SinglePage<IPList> {}

export interface IPList {
  id?: number;

  description?: string;

  name?: string;
}

export interface IPListGetParams {
  /**
   * Identifier.
   */
  account_id: string;
}

IPLists.IPListsSinglePage = IPListsSinglePage;

export declare namespace IPLists {
  export {
    type IPList as IPList,
    IPListsSinglePage as IPListsSinglePage,
    type IPListGetParams as IPListGetParams,
  };
}