cloudflare/src/resources/zero-trust/dlp/limits.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 BaseLimits extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'dlp', 'limits'] = Object.freeze([
    'zeroTrust',
    'dlp',
    'limits',
  ] as const);

  /**
   * Retrieves current DLP usage limits and quotas for the account, including maximum
   * allowed counts and current usage for custom entries, dataset cells, and document
   * fingerprints.
   *
   * @example
   * ```ts
   * const limits = await client.zeroTrust.dlp.limits.list({
   *   account_id: 'account_id',
   * });
   * ```
   */
  list(params: LimitListParams, options?: RequestOptions): APIPromise<LimitListResponse> {
    const { account_id } = params;
    return (
      this._client.get(path`/accounts/${account_id}/dlp/limits`, options) as APIPromise<{
        result: LimitListResponse;
      }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Limits extends BaseLimits {}

export interface LimitListResponse {
  /**
   * Maximum number of custom regex entries allowed for the account.
   */
  max_custom_regex_entries: number;

  /**
   * Maximum number of dataset cells allowed for the account, across all EDM and CWL
   * datasets.
   */
  max_dataset_cells: number;

  /**
   * Maximum number of document fingerprints allowed for the account.
   */
  max_document_fingerprints: number;

  /**
   * Number of custom regex entries currently configured for the account.
   */
  used_custom_regex_entries: number;

  /**
   * Number of dataset cells currently configured for the account, across all EDM and
   * CWL datasets. Document fingerprints do not count towards this limit.
   */
  used_dataset_cells: number;

  /**
   * Number of document fingerprints currently configured for the account.
   */
  used_document_fingerprints: number;
}

export interface LimitListParams {
  account_id: string;
}

export declare namespace Limits {
  export { type LimitListResponse as LimitListResponse, type LimitListParams as LimitListParams };
}