@detectant-api/sdk 0.0.1 → 0.0.2

package/dist/esm/api/resources/health/client/Client.mjs

@@ -0,0 +1,115 @@
+// 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 { normalizeClientOptions } from "../../../../BaseClient.mjs";
+import { mergeHeaders } 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";
+import * as DetectantApi from "../../../index.mjs";
+/**
+ * Service health probes.
+ */
+export class HealthClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptions(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) {
+        return core.HttpResponsePromise.fromPromise(this.__getLiveness(requestOptions));
+    }
+    __getLiveness(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.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, "health/live"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                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") {
+                throw new errors.DetectantApiError({
+                    statusCode: _response.error.statusCode,
+                    body: _response.error.body,
+                    rawResponse: _response.rawResponse,
+                });
+            }
+            return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/health/live");
+        });
+    }
+    /**
+     * 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) {
+        return core.HttpResponsePromise.fromPromise(this.__getReadiness(requestOptions));
+    }
+    __getReadiness(requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const _headers = mergeHeaders((_a = this._options) === null || _a === void 0 ? void 0 : _a.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, "health/ready"),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                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 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, "GET", "/health/ready");
+        });
+    }
+}

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

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

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

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

package/dist/esm/api/resources/health/exports.d.mts

@@ -0,0 +1,2 @@
+export { HealthClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/health/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { HealthClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

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

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

package/dist/esm/api/resources/health/index.mjs

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

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

@@ -0,0 +1,3 @@
+export * as health from "./health/index.mjs";
+export * from "./scans/client/requests/index.mjs";
+export * as scans from "./scans/index.mjs";

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

@@ -0,0 +1,3 @@
+export * as health from "./health/index.mjs";
+export * from "./scans/client/requests/index.mjs";
+export * as scans from "./scans/index.mjs";

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

@@ -0,0 +1,54 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.mjs";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as DetectantApi from "../../../index.mjs";
+export declare namespace ScansClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * Submit files and retrieve account-scoped scan results.
+ */
+export declare class ScansClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ScansClient.Options>;
+    constructor(options?: ScansClient.Options);
+    /**
+     * Returns scans owned by the authenticated account in descending creation order.
+     *
+     * @param {DetectantApi.ListScansRequest} request
+     * @param {ScansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.BadRequestError}
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.scans.listScans()
+     */
+    listScans(request?: DetectantApi.ListScansRequest, requestOptions?: ScansClient.RequestOptions): core.HttpResponsePromise<DetectantApi.ScanList>;
+    private __listScans;
+    /**
+     * Returns one scan owned by the authenticated account.
+     *
+     * @param {DetectantApi.GetScanRequest} request
+     * @param {ScansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.NotFoundError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.scans.getScan({
+     *         scan_id: "scan_0123456789abcdef0123456789abcdef"
+     *     })
+     */
+    getScan(request: DetectantApi.GetScanRequest, requestOptions?: ScansClient.RequestOptions): core.HttpResponsePromise<DetectantApi.Scan>;
+    private __getScan;
+}

package/dist/esm/api/resources/scans/client/Client.mjs

@@ -0,0 +1,159 @@
+// 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 { normalizeClientOptionsWithAuth } from "../../../../BaseClient.mjs";
+import { mergeHeaders } 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";
+import * as DetectantApi from "../../../index.mjs";
+/**
+ * Submit files and retrieve account-scoped scan results.
+ */
+export class ScansClient {
+    constructor(options = {}) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * Returns scans owned by the authenticated account in descending creation order.
+     *
+     * @param {DetectantApi.ListScansRequest} request
+     * @param {ScansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.BadRequestError}
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.scans.listScans()
+     */
+    listScans(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__listScans(request, requestOptions));
+    }
+    __listScans() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { limit, cursor, verdict, filename, engine_signature: engineSignature, detection_rule: detectionRule, } = request;
+            const _queryParams = {
+                limit,
+                cursor,
+                verdict,
+                filename,
+                engine_signature: engineSignature,
+                detection_rule: detectionRule,
+            };
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.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: "GET",
+                headers: _headers,
+                queryString: core.url
+                    .queryBuilder()
+                    .addMany(_queryParams)
+                    .mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams)
+                    .build(),
+                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 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, "GET", "/v1/scans");
+        });
+    }
+    /**
+     * Returns one scan owned by the authenticated account.
+     *
+     * @param {DetectantApi.GetScanRequest} request
+     * @param {ScansClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link DetectantApi.UnauthorizedError}
+     * @throws {@link DetectantApi.NotFoundError}
+     * @throws {@link DetectantApi.TooManyRequestsError}
+     * @throws {@link DetectantApi.InternalServerError}
+     * @throws {@link errors.DetectantApiError}
+     * @throws {@link errors.DetectantApiTimeoutError}
+     *
+     * @example
+     *     await client.scans.getScan({
+     *         scan_id: "scan_0123456789abcdef0123456789abcdef"
+     *     })
+     */
+    getScan(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getScan(request, requestOptions));
+    }
+    __getScan(request, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { scan_id: scanId } = request;
+            const _authRequest = yield this._options.authProvider.getAuthRequest();
+            const _headers = mergeHeaders(_authRequest.headers, (_a = this._options) === null || _a === void 0 ? void 0 : _a.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/${core.url.encodePathParam(scanId)}`),
+                method: "GET",
+                headers: _headers,
+                queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
+                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 401:
+                        throw new DetectantApi.UnauthorizedError(_response.error.body, _response.rawResponse);
+                    case 404:
+                        throw new DetectantApi.NotFoundError(_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, "GET", "/v1/scans/{scan_id}");
+        });
+    }
+}

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

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

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

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

package/dist/esm/api/resources/scans/client/requests/GetScanRequest.d.mts

@@ -0,0 +1,10 @@
+/**
+ * @example
+ *     {
+ *         scan_id: "scan_0123456789abcdef0123456789abcdef"
+ *     }
+ */
+export interface GetScanRequest {
+    /** Scan identifier returned by `createScan` or `listScans`. */
+    scan_id: string;
+}

package/dist/esm/api/resources/scans/client/requests/GetScanRequest.mjs

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

package/dist/esm/api/resources/scans/client/requests/ListScansRequest.d.mts

@@ -0,0 +1,18 @@
+/**
+ * @example
+ *     {}
+ */
+export interface ListScansRequest {
+    /** Maximum results to return. Values above 200 are capped at 200; omission uses 50. */
+    limit?: number;
+    /** Opaque cursor returned as `next_cursor` by a previous request. */
+    cursor?: string;
+    /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored verdict; `%` and `_` act as wildcards. */
+    verdict?: string;
+    /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored filename; `%` and `_` act as wildcards. */
+    filename?: string;
+    /** Case-sensitive PostgreSQL `LIKE` fragment matched against the stored engine signature; `%` and `_` act as wildcards. */
+    engine_signature?: string;
+    /** Case-sensitive PostgreSQL `LIKE` fragment matched against stored detection rules; `%` and `_` act as wildcards. */
+    detection_rule?: string;
+}

package/dist/esm/api/resources/scans/client/requests/ListScansRequest.mjs

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

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

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

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

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

package/dist/esm/api/resources/scans/exports.d.mts

@@ -0,0 +1,2 @@
+export { ScansClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/scans/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ScansClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

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

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

package/dist/esm/api/resources/scans/index.mjs

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

package/dist/esm/api/types/ApiError.d.mts

@@ -0,0 +1,8 @@
+export interface ApiError {
+    /** Stable machine-readable error code. */
+    code: string;
+    /** Human-readable error message. */
+    message: string;
+    /** Context such as the ID of a failed stored scan. Empty when no context applies. */
+    details: Record<string, string>;
+}

package/dist/esm/api/types/ApiError.mjs

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

package/dist/esm/api/types/ErrorResponse.d.mts

@@ -0,0 +1,4 @@
+import type * as DetectantApi from "../index.mjs";
+export interface ErrorResponse {
+    error: DetectantApi.ApiError;
+}

package/dist/esm/api/types/ErrorResponse.mjs

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

package/dist/esm/api/types/HealthResponse.d.mts

@@ -0,0 +1,10 @@
+export interface HealthResponse {
+    status: HealthResponse.Status;
+}
+export declare namespace HealthResponse {
+    const Status: {
+        readonly Ok: "ok";
+        readonly Degraded: "degraded";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+}

package/dist/esm/api/types/HealthResponse.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var HealthResponse;
+(function (HealthResponse) {
+    HealthResponse.Status = {
+        Ok: "ok",
+        Degraded: "degraded",
+    };
+})(HealthResponse || (HealthResponse = {}));

package/dist/esm/api/types/Scan.d.mts

@@ -0,0 +1,32 @@
+import type * as DetectantApi from "../index.mjs";
+export interface Scan {
+    /** Server-generated scan identifier. */
+    id: string;
+    created_at: string;
+    status: Scan.Status;
+    verdict: Scan.Verdict;
+    /** Filename supplied by the multipart upload. */
+    filename: string;
+    sha256: string;
+    size_bytes: number;
+    duration_ms: number;
+    /** Failure information, or `null` when the scan completed. */
+    failure: DetectantApi.ScanFailure | null;
+    /** Detection names reported for the file. Empty when no threats were detected. */
+    detections: string[];
+    type_analysis: DetectantApi.TypeAnalysis;
+}
+export declare namespace Scan {
+    const Status: {
+        readonly Completed: "completed";
+        readonly Failed: "failed";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Verdict: {
+        readonly Clean: "clean";
+        readonly Malicious: "malicious";
+        readonly Suspicious: "suspicious";
+        readonly Unknown: "unknown";
+    };
+    type Verdict = (typeof Verdict)[keyof typeof Verdict];
+}

package/dist/esm/api/types/Scan.mjs

@@ -0,0 +1,14 @@
+// This file was auto-generated by Fern from our API Definition.
+export var Scan;
+(function (Scan) {
+    Scan.Status = {
+        Completed: "completed",
+        Failed: "failed",
+    };
+    Scan.Verdict = {
+        Clean: "clean",
+        Malicious: "malicious",
+        Suspicious: "suspicious",
+        Unknown: "unknown",
+    };
+})(Scan || (Scan = {}));

package/dist/esm/api/types/ScanBatchResponse.d.mts

@@ -0,0 +1,5 @@
+import type * as DetectantApi from "../index.mjs";
+export interface ScanBatchResponse {
+    /** One outcome per submitted file, in submission order. */
+    results: DetectantApi.ScanBatchResult[];
+}

package/dist/esm/api/types/ScanBatchResponse.mjs

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

package/dist/esm/api/types/ScanBatchResult.d.mts

@@ -0,0 +1,13 @@
+import type * as DetectantApi from "../index.mjs";
+export interface ScanBatchResult {
+    /** Zero-based position of the submitted file. */
+    index: number;
+    /** Filename supplied by the multipart part. */
+    filename: string;
+    /** HTTP status that the equivalent single-file request would return. */
+    http_status: number;
+    /** Stored scan result, including its scan ID, or null when validation failed before a scan was created. */
+    scan: DetectantApi.Scan | null;
+    /** Per-file validation or scanning error, or null when the scan completed. */
+    error: DetectantApi.ApiError | null;
+}

package/dist/esm/api/types/ScanBatchResult.mjs

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

package/dist/esm/api/types/ScanFailure.d.mts

@@ -0,0 +1,11 @@
+export interface ScanFailure {
+    code: ScanFailure.Code;
+    message: string;
+}
+export declare namespace ScanFailure {
+    const Code: {
+        readonly ScannerUnavailable: "SCANNER_UNAVAILABLE";
+        readonly ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED";
+    };
+    type Code = (typeof Code)[keyof typeof Code];
+}

package/dist/esm/api/types/ScanFailure.mjs

@@ -0,0 +1,8 @@
+// This file was auto-generated by Fern from our API Definition.
+export var ScanFailure;
+(function (ScanFailure) {
+    ScanFailure.Code = {
+        ScannerUnavailable: "SCANNER_UNAVAILABLE",
+        ContentExpansionLimitExceeded: "CONTENT_EXPANSION_LIMIT_EXCEEDED",
+    };
+})(ScanFailure || (ScanFailure = {}));

package/dist/esm/api/types/ScanList.d.mts

@@ -0,0 +1,7 @@
+import type * as DetectantApi from "../index.mjs";
+export interface ScanList {
+    /** Scan records. Empty when the account has no scans. */
+    items: DetectantApi.Scan[];
+    /** Opaque cursor for the next page, or `null` when no next page exists. */
+    next_cursor: string | null;
+}

package/dist/esm/api/types/ScanList.mjs

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

package/dist/esm/api/types/TypeAnalysis.d.mts

@@ -0,0 +1,26 @@
+import type * as DetectantApi from "../index.mjs";
+export interface TypeAnalysis {
+    declared: DetectantApi.TypeDeclaration;
+    identified: DetectantApi.TypeIdentification;
+    status: TypeAnalysis.Status;
+    structurally_valid: boolean | null;
+    confidence: TypeAnalysis.Confidence;
+    reason: DetectantApi.TypeAnalysisReason | null;
+}
+export declare namespace TypeAnalysis {
+    const Status: {
+        readonly Match: "match";
+        readonly Compatible: "compatible";
+        readonly Mismatch: "mismatch";
+        readonly Malformed: "malformed";
+        readonly Unscannable: "unscannable";
+        readonly Unknown: "unknown";
+    };
+    type Status = (typeof Status)[keyof typeof Status];
+    const Confidence: {
+        readonly High: "high";
+        readonly Medium: "medium";
+        readonly Low: "low";
+    };
+    type Confidence = (typeof Confidence)[keyof typeof Confidence];
+}

package/dist/esm/api/types/TypeAnalysis.mjs

@@ -0,0 +1,17 @@
+// This file was auto-generated by Fern from our API Definition.
+export var TypeAnalysis;
+(function (TypeAnalysis) {
+    TypeAnalysis.Status = {
+        Match: "match",
+        Compatible: "compatible",
+        Mismatch: "mismatch",
+        Malformed: "malformed",
+        Unscannable: "unscannable",
+        Unknown: "unknown",
+    };
+    TypeAnalysis.Confidence = {
+        High: "high",
+        Medium: "medium",
+        Low: "low",
+    };
+})(TypeAnalysis || (TypeAnalysis = {}));