@vigilbase/cli/dist/lib/security-client.d.ts

Vigilbase CLI — security scanners, agent tools, and Vigilbase One from the terminal.

import { z } from 'zod';
import type { VigilbaseOneClient } from './one-client.js';
export type SecurityQuery = Record<string, string | number | boolean | undefined>;
export type SecurityPayload = Record<string, unknown>;
/** Wire envelopes match One's flarehawk-ui normalizers; JSON retains evidence fields. */
export declare const securityResponses: {
    analytics: z.ZodObject<{
        data: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    analyticsRows: z.ZodObject<{
        data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    dnsSecurity: z.ZodObject<{
        data: z.ZodObject<{
            series: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            top_domains: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    providerEvents: z.ZodObject<{
        data: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        hasData: z.ZodBoolean;
        count: z.ZodNumber;
        provider: z.ZodString;
        dataset: z.ZodString;
        aggregates: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    deviceHealth: z.ZodObject<{
        data: z.ZodObject<{
            timeseries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            devices: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    appTests: z.ZodObject<{
        data: z.ZodObject<{
            timeseries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            tests: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    gateway: z.ZodObject<{
        data: z.ZodObject<{
            surface: z.ZodEnum<{
                http: "http";
                dns: "dns";
                network: "network";
            }>;
            timeseries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            top: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            secondary: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    access: z.ZodObject<{
        data: z.ZodObject<{
            timeseries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            apps: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            users: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            idps: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            geo: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    sessions: z.ZodObject<{
        data: z.ZodObject<{
            timeseries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            users: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    devicePosture: z.ZodObject<{
        data: z.ZodObject<{
            checks: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    accountInventory: z.ZodObject<{
        data: z.ZodObject<{
            connections: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            assetDatasets: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            logpushJobs: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    accountAudit: z.ZodObject<{
        data: z.ZodObject<{
            summary: z.ZodRecord<z.ZodString, z.ZodUnknown>;
            over_time: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            top_actions: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            top_resource_products: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            outcomes: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            recent_changes: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    accountIngestion: z.ZodObject<{
        data: z.ZodObject<{
            volume: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            by_asset: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    accountPosture: z.ZodObject<{
        data: z.ZodObject<{
            posture: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
            heatmap: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    providers: z.ZodObject<{
        providers: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    notifications: z.ZodObject<{
        notifications: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        unreadCount: z.ZodNumber;
    }, z.core.$loose>;
    notificationSettings: z.ZodObject<{
        channels: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        preferences: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
    }, z.core.$loose>;
    preferences: z.ZodObject<{
        preferences: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    slackChannels: z.ZodObject<{
        channels: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    ipList: z.ZodObject<{
        entries: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    assetRemediation: z.ZodObject<{
        effective: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    autonomy: z.ZodObject<{
        settings: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    datasets: z.ZodObject<{
        datasets: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
    }, z.core.$loose>;
    defaultAsset: z.ZodObject<{
        asset_id: z.ZodNullable<z.ZodString>;
    }, z.core.$loose>;
    graph: z.ZodObject<{
        asset_id: z.ZodString;
        domain_id: z.ZodString;
        dataset: z.ZodString;
        nodes: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        edges: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    availableAssets: z.ZodObject<{
        assets: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    connectionRemediation: z.ZodObject<{
        cascading_default: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    logpushStatus: z.ZodObject<{
        stored: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        asset: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        receipt: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        canRecreate: z.ZodBoolean;
        warnings: z.ZodArray<z.ZodString>;
        updatedAt: z.ZodString;
    }, z.core.$loose>;
    workerStats: z.ZodObject<{
        period: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        requests: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        errors: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        cpuTime: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        queue: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        links: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        queueMetricsError: z.ZodNullable<z.ZodString>;
        updatedAt: z.ZodString;
    }, z.core.$loose>;
    reportSettings: z.ZodObject<{
        enabled: z.ZodBoolean;
        delivery_day: z.ZodString;
        delivery_time_utc: z.ZodString;
        email_recipients: z.ZodArray<z.ZodString>;
        include_traffic: z.ZodBoolean;
        include_incidents: z.ZodBoolean;
        include_top_threats: z.ZodBoolean;
    }, z.core.$loose>;
    alerts: z.ZodObject<{
        alerts: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    alert: z.ZodObject<{
        alert: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    shareLinks: z.ZodObject<{
        share_links: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    lifecycleEmails: z.ZodObject<{
        enabled: z.ZodBoolean;
    }, z.core.$loose>;
    broadcastEmails: z.ZodObject<{
        marketingEmailEnabled: z.ZodBoolean;
        releaseEmailEnabled: z.ZodBoolean;
        releaseInAppEnabled: z.ZodBoolean;
    }, z.core.$loose>;
    applications: z.ZodObject<{
        grants: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    overview: z.ZodObject<{
        overview: z.ZodObject<{
            stats: z.ZodRecord<z.ZodString, z.ZodUnknown>;
        }, z.core.$loose>;
    }, z.core.$loose>;
    incidents: z.ZodObject<{
        incidents: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        total: z.ZodNumber;
    }, z.core.$loose>;
    incident: z.ZodObject<{
        incident: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    timeline: z.ZodObject<{
        events: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        next_cursor: z.ZodNullable<z.ZodString>;
        degraded: z.ZodBoolean;
    }, z.core.$loose>;
    logs: z.ZodObject<{
        logs: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    assets: z.ZodObject<{
        domains: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
    }, z.core.$loose>;
    detections: z.ZodObject<{
        rules: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
        detections: z.ZodOptional<z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
    }, z.core.$loose>;
    connections: z.ZodObject<{
        connections: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        total: z.ZodNumber;
    }, z.core.$loose>;
    connection: z.ZodObject<{
        connection: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    reports: z.ZodObject<{
        reports: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        total: z.ZodNumber;
    }, z.core.$loose>;
    report: z.ZodObject<{
        report: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    audit: z.ZodObject<{
        events: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
        next_cursor: z.ZodNullable<z.ZodString>;
    }, z.core.$loose>;
    intel: z.ZodObject<{
        query: z.ZodString;
        query_type: z.ZodEnum<{
            asn: "asn";
            ip: "ip";
            cidr: "cidr";
            ja3: "ja3";
            ja4: "ja4";
        }>;
        quota: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>;
    quota: z.ZodUnion<readonly [z.ZodObject<{
        quota: z.ZodRecord<z.ZodString, z.ZodUnknown>;
    }, z.core.$loose>, z.ZodObject<{
        used: z.ZodNumber;
        remaining: z.ZodNullable<z.ZodNumber>;
    }, z.core.$loose>]>;
    update: z.ZodUnion<readonly [z.ZodObject<{
        ok: z.ZodLiteral<true>;
        status: z.ZodString;
    }, z.core.$loose>, z.ZodObject<{
        success: z.ZodLiteral<true>;
        incident_id: z.ZodString;
        status: z.ZodString;
    }, z.core.$loose>]>;
};
export type SecurityView = keyof typeof securityResponses;
export type SecurityRequest = {
    path: string;
    query: SecurityQuery;
    customerId?: string;
    view: SecurityView;
    body?: {
        status: string;
        note?: string;
    };
};
export declare class SecurityClient {
    private readonly one;
    constructor(one: VigilbaseOneClient);
    request(input: SecurityRequest): Promise<SecurityPayload>;
}