cloudflare/resources/radar/email/security/summary.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Summary = exports.BaseSummary = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../../core/resource.js");
var BaseSummary = /* @__PURE__ */ (() => {
    class BaseSummary extends resource_1.APIResource {
        /**
         * Retrieves the distribution of emails by ARC (Authenticated Received Chain)
         * validation.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        arc(query = {}, options) {
            return this._client.get('/radar/email/security/summary/arc', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by DKIM (DomainKeys Identified Mail)
         * validation.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        dkim(query = {}, options) {
            return this._client.get('/radar/email/security/summary/dkim', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by DMARC (Domain-based Message
         * Authentication, Reporting and Conformance) validation.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        dmarc(query = {}, options) {
            return this._client.get('/radar/email/security/summary/dmarc', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by malicious classification.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        malicious(query = {}, options) {
            return this._client.get('/radar/email/security/summary/malicious', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the proportion of emails by spam classification (spam vs. non-spam).
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        spam(query = {}, options) {
            return this._client.get('/radar/email/security/summary/spam', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by SPF (Sender Policy Framework)
         * validation.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        spf(query = {}, options) {
            return this._client.get('/radar/email/security/summary/spf', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the proportion of emails by spoof classification (spoof vs.
         * non-spoof).
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        spoof(query = {}, options) {
            return this._client.get('/radar/email/security/summary/spoof', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by threat categories.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        threatCategory(query = {}, options) {
            return this._client.get('/radar/email/security/summary/threat_category', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
        /**
         * Retrieves the distribution of emails by TLS version.
         *
         * @deprecated Use [Radar Email Security Summary By Dimension](https://developers.cloudflare.com/api/resources/radar/subresources/email/subresources/security/methods/summary_v2/) instead.
         */
        tlsVersion(query = {}, options) {
            return this._client.get('/radar/email/security/summary/tls_version', { query, ...options })._thenUnwrap((obj) => obj.result);
        }
    }
    BaseSummary._key = Object.freeze([
        'radar',
        'email',
        'security',
        'summary',
    ]);
    return BaseSummary;
})();
exports.BaseSummary = BaseSummary;
class Summary extends BaseSummary {
}
exports.Summary = Summary;
//# sourceMappingURL=summary.js.map