cloudflare/resources/email-security/phishguard/reports.d.mts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../core/resource.mjs";
import { PagePromise, V4PagePaginationArray, type V4PagePaginationArrayParams } from "../../../core/pagination.mjs";
import { RequestOptions } from "../../../internal/request-options.mjs";
export declare class BaseReports extends APIResource {
    static readonly _key: readonly ['emailSecurity', 'phishguard', 'reports'];
    /**
     * Retrieves PhishGuard security alert reports for a specified date range. Reports
     * include detected threats, dispositions, and contextual information. Use for
     * security monitoring and threat analysis.
     *
     * @example
     * ```ts
     * // Automatically fetches more pages as needed.
     * for await (const reportListResponse of client.emailSecurity.phishguard.reports.list(
     *   { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
     * )) {
     *   // ...
     * }
     * ```
     */
    list(params: ReportListParams, options?: RequestOptions): PagePromise<ReportListResponsesV4PagePaginationArray, ReportListResponse>;
}
export declare class Reports extends BaseReports {
}
export type ReportListResponsesV4PagePaginationArray = V4PagePaginationArray<ReportListResponse>;
export interface ReportListResponse {
    id: number;
    content: string;
    /**
     * The verdict Email Security assigns to a message.
     */
    disposition: 'MALICIOUS' | 'MALICIOUS-BEC' | 'SUSPICIOUS' | 'SPOOF' | 'SPAM' | 'BULK' | 'ENCRYPTED' | 'EXTERNAL' | 'UNKNOWN' | 'NONE';
    fields: ReportListResponse.Fields;
    priority: string;
    title: string;
    created_at?: string | null;
    tags?: Array<ReportListResponse.Tag> | null;
    /**
     * @deprecated Use `created_at` instead.
     */
    ts?: string;
    updated_at?: string | null;
}
export declare namespace ReportListResponse {
    interface Fields {
        to: Array<string>;
        from?: string | null;
        occurred_at?: string;
        postfix_id?: string | null;
        /**
         * @deprecated Use `occurred_at` instead.
         */
        ts?: string;
    }
    interface Tag {
        category: string;
        value: string;
    }
}
export interface ReportListParams extends V4PagePaginationArrayParams {
    /**
     * Path param: Account identifier tag.
     */
    account_id: string;
    /**
     * Query param: End of the time range (RFC3339). Takes precedence over to_date.
     */
    end?: string;
    /**
     * Query param: Deprecated, use `start` instead. Start date in YYYY-MM-DD format.
     */
    from_date?: string;
    /**
     * Query param: Start of the time range (RFC3339). Takes precedence over from_date.
     */
    start?: string;
    /**
     * Query param: Deprecated, use `end` instead. End date in YYYY-MM-DD format.
     */
    to_date?: string;
}
export declare namespace Reports {
    export { type ReportListResponse as ReportListResponse, type ReportListResponsesV4PagePaginationArray as ReportListResponsesV4PagePaginationArray, type ReportListParams as ReportListParams, };
}
//# sourceMappingURL=reports.d.mts.map