cloudflare/resources/security-center/insights/class.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import * as IssuesAPI from "../../intel/attack-surface-report/issues.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseClass extends APIResource {
    static readonly _key: readonly ['securityCenter', 'insights', 'class'];
    /**
     * 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>;
}
export declare class Class extends BaseClass {
}
export type ClassGetResponse = Array<ClassGetResponse.ClassGetResponseItem>;
export declare namespace ClassGetResponse {
    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 };
}
//# sourceMappingURL=class.d.mts.map