cloudflare/src/resources/security-center/insights/class.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 * as IssuesAPI from '../../intel/attack-surface-report/issues';
import { APIPromise } from '../../../core/api-promise';
import { CloudflareError } from '../../../core/error';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseClass extends APIResource {
  static override readonly _key: readonly ['securityCenter', 'insights', 'class'] = Object.freeze([
    'securityCenter',
    'insights',
    'class',
  ] as const);

  /**
   * Retrieves Security Center insight counts aggregated by classification class.
   *
   * @example
   * ```ts
   * const classes =
   *   await client.securityCenter.insights.class.get({
   *     account_id: 'account_id',
   *   });
   * ```
   */
  get(
    params: ClassGetParams | null | undefined = {},
    options?: RequestOptions,
  ): APIPromise<ClassGetResponse> {
    const { account_id, zone_id, ...query } = params ?? {};
    if (!account_id && !zone_id) {
      throw new CloudflareError('You must provide either account_id or zone_id.');
    }
    if (account_id && zone_id) {
      throw new CloudflareError('You cannot provide both account_id and zone_id.');
    }
    const { accountOrZone, accountOrZoneId } =
      account_id ?
        {
          accountOrZone: 'accounts',
          accountOrZoneId: account_id,
        }
      : {
          accountOrZone: 'zones',
          accountOrZoneId: zone_id,
        };
    return (
      this._client.get(path`/${accountOrZone}/${accountOrZoneId}/security-center/insights/class`, {
        query,
        ...options,
      }) as APIPromise<{ result: ClassGetResponse }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class Class extends BaseClass {}

export type ClassGetResponse = Array<ClassGetResponse.ClassGetResponseItem>;

export namespace ClassGetResponse {
  export interface ClassGetResponseItem {
    count?: number;

    value?: string;
  }
}

export interface ClassGetParams {
  /**
   * Path param: The Account ID to use for this endpoint. Mutually exclusive with the
   * Zone ID.
   */
  account_id?: string;

  /**
   * Path param: The Zone ID to use for this endpoint. Mutually exclusive with the
   * Account ID.
   */
  zone_id?: string;

  /**
   * Query param
   */
  dismissed?: boolean;

  /**
   * Query param
   */
  issue_class?: Array<string>;

  /**
   * Query param
   */
  'issue_class~neq'?: Array<string>;

  /**
   * Query param
   */
  issue_type?: Array<IssuesAPI.IssueTypeParam>;

  /**
   * Query param
   */
  'issue_type~neq'?: Array<IssuesAPI.IssueTypeParam>;

  /**
   * Query param
   */
  product?: Array<string>;

  /**
   * Query param
   */
  'product~neq'?: Array<string>;

  /**
   * Query param
   */
  severity?: Array<IssuesAPI.SeverityQueryParamParam>;

  /**
   * Query param
   */
  'severity~neq'?: Array<IssuesAPI.SeverityQueryParamParam>;

  /**
   * Query param
   */
  source?: Array<'cloudflare' | 'riskrecon'>;

  /**
   * Query param
   */
  subject?: Array<string>;

  /**
   * Query param
   */
  'subject~neq'?: Array<string>;
}

export declare namespace Class {
  export { type ClassGetResponse as ClassGetResponse, type ClassGetParams as ClassGetParams };
}