@detectant-api/sdk 0.0.1 → 0.0.3

package/dist/esm/Client.mjs

@@ -0,0 +1,218 @@
+// This file was auto-generated by Fern from our API Definition.
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as DetectantApi from "./api/index.mjs";
+import { HealthClient } from "./api/resources/health/client/Client.mjs";
+import { ScansClient } from "./api/resources/scans/client/Client.mjs";
+import { normalizeClientOptionsWithAuth } from "./BaseClient.mjs";
+import { mergeHeaders, mergeOnlyDefinedHeaders } from "./core/headers.mjs";
+import * as core from "./core/index.mjs";
+import * as environments from "./environments.mjs";
+import { handleNonStatusCodeError } from "./errors/handleNonStatusCodeError.mjs";
+import * as errors from "./errors/index.mjs";
+export class Detectant {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    get health() {
+        var _a;
+        return ((_a = this._health) !== null && _a !== void 0 ? _a : (this._health = new HealthClient(this._options)));
+    }
+    get scans() {
+        var _a;
+        return ((_a = this._scans) !== null && _a !== void 0 ? _a : (this._scans = new ScansClient(this._options)));
+    }
+    /**
+     * Uploads one file and synchronously runs content-type and malware analysis.
+     * Only the first multipart part named `file` with a filename is
+     * scanned; other parts are ignored. Free accounts accept files up to
+     * 50 MiB; Grow and Scale accounts accept files up to 250 MiB.
+     *
+     * @param {core.file.Uploadable} file
+     * @param {Detectant.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.BadRequestError}
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.ForbiddenError}
+     * @throws {@link DetectantApi.ContentTooLargeError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link DetectantApi.ServiceUnavailableError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.scan(createReadStream("path/to/file"))
+     */
+    scan(file, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__scan(file, requestOptions));
+    }
+    __scan(file, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _body = yield core.newFormData();
+            yield _body.appendFile("file", file);
+            const _maybeEncodedRequest = yield _body.getRequest();
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.DetectantApiEnvironment.Default, "v1/scans"),
+                method: "POST",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new DetectantApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new DetectantApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new DetectantApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new DetectantApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new DetectantApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new DetectantApi.InternalServerError(_response.error.body, _response.rawResponse);
+                    case 503:
+                        throw new DetectantApi.ServiceUnavailableError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.DetectantApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/scans");
+        });
+    }
+    /**
+     * Uploads between 1 and 20 files in repeated `files` multipart parts. Each
+     * file uses its account plan's 50 MiB or 250 MiB per-file limit, validation, content-type
+     * analysis, malware detection, persistence, usage accounting, and billing path
+     * as `createScan`. The encoded multipart request limit is the plan's
+     * per-file limit × 20 plus 1 MiB for multipart framing.
+     *
+     * Results preserve submitted-file order. File-level validation or scanner
+     * failures are returned in the corresponding result and do not prevent
+     * other files from being scanned. The whole request is rejected only for
+     * request-level failures such as invalid multipart data, authentication or
+     * rate-limit failure, more than 20 files, or an oversized total request.
+     *
+     * @param {core.file.Uploadable[]} files
+     * @param {Detectant.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.BadRequestError}
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.ForbiddenError}
+     * @throws {@link DetectantApi.ContentTooLargeError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     import { createReadStream } from "fs";
+     *     await client.scanBatch([createReadStream("path/to/file")])
+     */
+    scanBatch(files, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__scanBatch(files, requestOptions));
+    }
+    __scanBatch(files, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _body = yield core.newFormData();
+            for (const _file of files) {
+                yield _body.appendFile("files", _file);
+            }
+            const _maybeEncodedRequest = yield _body.getRequest();
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, mergeOnlyDefinedHeaders(Object.assign({}, _maybeEncodedRequest.headers)), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
+            const _response = yield core.fetcher({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.DetectantApiEnvironment.Default, "v1/scans/batch"),
+                method: "POST",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                requestType: "file",
+                duplex: _maybeEncodedRequest.duplex,
+                body: _maybeEncodedRequest.body,
+                timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
+                maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+                fetchFn: (_j = this._options) === null || _j === void 0 ? void 0 : _j.fetch,
+                logging: this._options.logging,
+            });
+            if (_response.ok) {
+                return { data: _response.body, rawResponse: _response.rawResponse };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 400:
+                        throw new DetectantApi.BadRequestError(_response.error.body, _response.rawResponse);
+                    case 401:
+                        throw new DetectantApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 403:
+                        throw new DetectantApi.ForbiddenError(_response.error.body, _response.rawResponse);
+                    case 413:
+                        throw new DetectantApi.ContentTooLargeError(_response.error.body, _response.rawResponse);
+                    case 429:
+                        throw new DetectantApi.TooManyRequestsError(_response.error.body, _response.rawResponse);
+                    case 500:
+                        throw new DetectantApi.InternalServerError(_response.error.body, _response.rawResponse);
+                    default:
+                        throw new errors.DetectantApiError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/v1/scans/batch");
+        });
+    }
+    /**
+     * Make a passthrough request using the SDK's configured auth, retry, logging, etc.
+     * This is useful for making requests to endpoints not yet supported in the SDK.
+     * The input can be a URL string, URL object, or Request object. Relative paths are resolved against the configured base URL.
+     *
+     * @param {Request | string | URL} input - The URL, path, or Request object.
+     * @param {RequestInit} init - Standard fetch RequestInit options.
+     * @param {core.PassthroughRequest.RequestOptions} requestOptions - Per-request overrides (timeout, retries, headers, abort signal).
+     * @returns {Promise<Response>} A standard Response object.
+     */
+    fetch(input, init, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            return core.makePassthroughRequest(input, init, {
+                baseUrl: (_a = this._options.baseUrl) !== null && _a !== void 0 ? _a : this._options.environment,
+                headers: this._options.headers,
+                timeoutInSeconds: this._options.timeoutInSeconds,
+                maxRetries: this._options.maxRetries,
+                fetch: this._options.fetch,
+                logging: this._options.logging,
+                getAuthHeaders: () => __awaiter(this, void 0, void 0, function* () { return (yield this._options.authProvider.getAuthRequest()).headers; }),
+            }, requestOptions);
+        });
+    }
+}

package/dist/esm/api/client/index.d.mts

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/client/index.mjs

@@ -0,0 +1 @@
+export * from "./requests/index.mjs";

package/dist/esm/api/client/requests/CreateScanBatchRequest.d.mts

@@ -0,0 +1,5 @@
+/**
+ * @example
+ *     {}
+ */
+export type CreateScanBatchRequest = {};

package/dist/esm/api/client/requests/CreateScanBatchRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/client/requests/CreateScanRequest.d.mts

@@ -0,0 +1,5 @@
+/**
+ * @example
+ *     {}
+ */
+export type CreateScanRequest = {};

package/dist/esm/api/client/requests/CreateScanRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/client/requests/index.d.mts

@@ -0,0 +1,2 @@
+export type { CreateScanBatchRequest } from "./CreateScanBatchRequest.mjs";
+export type { CreateScanRequest } from "./CreateScanRequest.mjs";

package/dist/esm/api/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/errors/BadRequestError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class BadRequestError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/BadRequestError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class BadRequestError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "BadRequestError",
+            statusCode: 400,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "BadRequestError";
+    }
+}

package/dist/esm/api/errors/ContentTooLargeError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class ContentTooLargeError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/ContentTooLargeError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class ContentTooLargeError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ContentTooLargeError",
+            statusCode: 413,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "ContentTooLargeError";
+    }
+}

package/dist/esm/api/errors/ForbiddenError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class ForbiddenError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/ForbiddenError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class ForbiddenError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ForbiddenError",
+            statusCode: 403,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "ForbiddenError";
+    }
+}

package/dist/esm/api/errors/InternalServerError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class InternalServerError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/InternalServerError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class InternalServerError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "InternalServerError",
+            statusCode: 500,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "InternalServerError";
+    }
+}

package/dist/esm/api/errors/NotFoundError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class NotFoundError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/NotFoundError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class NotFoundError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "NotFoundError",
+            statusCode: 404,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "NotFoundError";
+    }
+}

package/dist/esm/api/errors/ServiceUnavailableError.d.mts

@@ -0,0 +1,5 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+export declare class ServiceUnavailableError extends errors.DetectantApiError {
+    constructor(body?: unknown, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/ServiceUnavailableError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class ServiceUnavailableError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "ServiceUnavailableError",
+            statusCode: 503,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "ServiceUnavailableError";
+    }
+}

package/dist/esm/api/errors/TooManyRequestsError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class TooManyRequestsError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/TooManyRequestsError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class TooManyRequestsError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "TooManyRequestsError",
+            statusCode: 429,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "TooManyRequestsError";
+    }
+}

package/dist/esm/api/errors/UnauthorizedError.d.mts

@@ -0,0 +1,7 @@
+import type * as core from "../../core/index.mjs";
+import * as errors from "../../errors/index.mjs";
+import type * as DetectantApi from "../index.mjs";
+export declare class UnauthorizedError extends errors.DetectantApiError {
+    readonly body: DetectantApi.ErrorResponse;
+    constructor(body: DetectantApi.ErrorResponse, rawResponse?: core.RawResponse);
+}

package/dist/esm/api/errors/UnauthorizedError.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+import * as errors from "../../errors/index.mjs";
+export class UnauthorizedError extends errors.DetectantApiError {
+    constructor(body, rawResponse) {
+        super({
+            message: "UnauthorizedError",
+            statusCode: 401,
+            body: body,
+            rawResponse: rawResponse,
+        });
+        Object.setPrototypeOf(this, new.target.prototype);
+        if (Error.captureStackTrace) {
+            Error.captureStackTrace(this, this.constructor);
+        }
+        this.name = "UnauthorizedError";
+    }
+}

package/dist/esm/api/errors/index.d.mts

@@ -0,0 +1,8 @@
+export * from "./BadRequestError.mjs";
+export * from "./ContentTooLargeError.mjs";
+export * from "./ForbiddenError.mjs";
+export * from "./InternalServerError.mjs";
+export * from "./NotFoundError.mjs";
+export * from "./ServiceUnavailableError.mjs";
+export * from "./TooManyRequestsError.mjs";
+export * from "./UnauthorizedError.mjs";

package/dist/esm/api/errors/index.mjs

@@ -0,0 +1,8 @@
+export * from "./BadRequestError.mjs";
+export * from "./ContentTooLargeError.mjs";
+export * from "./ForbiddenError.mjs";
+export * from "./InternalServerError.mjs";
+export * from "./NotFoundError.mjs";
+export * from "./ServiceUnavailableError.mjs";
+export * from "./TooManyRequestsError.mjs";
+export * from "./UnauthorizedError.mjs";

package/dist/esm/api/index.d.mts

@@ -0,0 +1,4 @@
+export * from "./client/index.mjs";
+export * from "./errors/index.mjs";
+export * from "./resources/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/index.mjs

@@ -0,0 +1,4 @@
+export * from "./client/index.mjs";
+export * from "./errors/index.mjs";
+export * from "./resources/index.mjs";
+export * from "./types/index.mjs";

package/dist/esm/api/resources/health/client/Client.d.mts

@@ -0,0 +1,43 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptions } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as DetectantApi from "../../../index.mjs";
+export declare namespace HealthClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Service health probes.
+ */
+export declare class HealthClient {
+    protected readonly _options: NormalizedClientOptions<HealthClient.Options>;
+    constructor(options?: HealthClient.Options);
+    /**
+     * Returns successfully while the API process can serve requests.
+     *
+     * @param {HealthClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.health.getLiveness()
+     */
+    getLiveness(requestOptions?: HealthClient.RequestOptions): core.HttpResponsePromise<DetectantApi.HealthResponse>;
+    private __getLiveness;
+    /**
+     * Checks the database, schema, scanner signatures, and scanning dependencies.
+     *
+     * @param {HealthClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.ServiceUnavailableError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.health.getReadiness()
+     */
+    getReadiness(requestOptions?: HealthClient.RequestOptions): core.HttpResponsePromise<DetectantApi.HealthResponse>;
+    private __getReadiness;
+}