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

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Reports = exports.BaseReports = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../core/resource.js");
const pagination_1 = require("../../../core/pagination.js");
const path_1 = require("../../../internal/utils/path.js");
var BaseReports = /* @__PURE__ */ (() => {
    class BaseReports extends resource_1.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((0, path_1.path) `/accounts/${account_id}/email-security/phishguard/reports`, (pagination_1.V4PagePaginationArray), { query, ...options });
        }
    }
    BaseReports._key = Object.freeze([
        'emailSecurity',
        'phishguard',
        'reports',
    ]);
    return BaseReports;
})();
exports.BaseReports = BaseReports;
class Reports extends BaseReports {
}
exports.Reports = Reports;
//# sourceMappingURL=reports.js.map