cloudflare/resources/email-security/phishguard/reports.mjs

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.mjs";
import { V4PagePaginationArray, } from "../../../core/pagination.mjs";
import { path } from "../../../internal/utils/path.mjs";
export var BaseReports = /* @__PURE__ */ (() => {
    class BaseReports extends APIResource {
        /**
         * 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, options) {
            const { account_id, ...query } = params;
            return this._client.getAPIList(path `/accounts/${account_id}/email-security/phishguard/reports`, (V4PagePaginationArray), { query, ...options });
        }
    }
    BaseReports._key = Object.freeze([
        'emailSecurity',
        'phishguard',
        'reports',
    ]);
    return BaseReports;
})();
export class Reports extends BaseReports {
}
//# sourceMappingURL=reports.mjs.map