cloudflare/resources/email-auth/spf/inspect.js

The official TypeScript library for the Cloudflare API

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Inspect = exports.BaseInspect = void 0;
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
const resource_1 = require("../../../core/resource.js");
const path_1 = require("../../../internal/utils/path.js");
var BaseInspect = /* @__PURE__ */ (() => {
    class BaseInspect extends resource_1.APIResource {
        /**
         * Inspects a specific SPF TXT record and returns a parsed tree structure in the
         * spflimit-worker format.
         *
         * The record ID must be provided via the `id` query parameter.
         *
         * Returns a recursive tree showing:
         *
         * - Parsed components with their qualifiers and types
         * - Nested includes recursively resolved within components
         * - Per-component and total lookup counts
         * - Detailed error information with context
         *
         * @example
         * ```ts
         * const inspect = await client.emailAuth.spf.inspect.get({
         *   zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
         *   id: 'id',
         * });
         * ```
         */
        get(params, options) {
            const { zone_id, ...query } = params;
            return this._client.get((0, path_1.path) `/zones/${zone_id}/email/auth/spf/inspect`, { query, ...options })._thenUnwrap((obj) => obj.result);
        }
    }
    BaseInspect._key = Object.freeze([
        'emailAuth',
        'spf',
        'inspect',
    ]);
    return BaseInspect;
})();
exports.BaseInspect = BaseInspect;
class Inspect extends BaseInspect {
}
exports.Inspect = Inspect;
//# sourceMappingURL=inspect.js.map