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

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { APIPromise } from "../../../core/api-promise.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseClassification extends APIResource {
    static readonly _key: readonly ['securityCenter', 'insights', 'classification'];
    /**
     * Updates the user classification for a Security Center insight. Valid values are
     * 'false_positive' or 'accept_risk'. To reset, set classification to null. Cannot
     * change directly between classification values - must reset to null first.
     *
     * @example
     * ```ts
     * const classification =
     *   await client.securityCenter.insights.classification.update(
     *     'issue_id',
     *     { account_id: 'account_id' },
     *   );
     * ```
     */
    update(issueID: string, params: ClassificationUpdateParams, options?: RequestOptions): APIPromise<ClassificationUpdateResponse>;
}
export declare class Classification extends BaseClassification {
}
export interface ClassificationUpdateResponse {
    errors: Array<ClassificationUpdateResponse.Error>;
    messages: Array<ClassificationUpdateResponse.Message>;
    /**
     * Whether the API call was successful.
     */
    success: true;
}
export declare namespace ClassificationUpdateResponse {
    interface Error {
        code: number;
        message: string;
        documentation_url?: string;
        source?: Error.Source;
    }
    namespace Error {
        interface Source {
            pointer?: string;
        }
    }
    interface Message {
        code: number;
        message: string;
        documentation_url?: string;
        source?: Message.Source;
    }
    namespace Message {
        interface Source {
            pointer?: string;
        }
    }
}
export interface ClassificationUpdateParams {
    /**
     * 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;
    /**
     * Body param: User-defined classification for the insight. Can be
     * 'false_positive', 'accept_risk', 'other', or null.
     */
    classification?: 'false_positive' | 'accept_risk' | 'other' | null;
    /**
     * Body param: Rationale for the classification change. Required when
     * classification is 'accept_risk' or 'other'.
     */
    rationale?: string;
}
export declare namespace Classification {
    export { type ClassificationUpdateResponse as ClassificationUpdateResponse, type ClassificationUpdateParams as ClassificationUpdateParams, };
}
//# sourceMappingURL=classification.d.mts.map