@chainpatrol/sdk 0.8.0 → 0.9.0

package/dist/api/index.d.mts

@@ -0,0 +1,902 @@
+type ApiCredential = {
+    kind: "api-key";
+    value: string;
+} | {
+    kind: "bearer";
+    value: string;
+};
+type CredentialProvider = () => ApiCredential | Promise<ApiCredential>;
+interface ChainPatrolApiClientOptions {
+    baseUrl?: string;
+    credential: CredentialProvider;
+    timeoutMs?: number;
+}
+interface ConfigEntry {
+    id: number;
+    title: string;
+    status: string;
+    cron: string | null;
+    config: Record<string, unknown>;
+}
+interface DetectionSource {
+    source: string;
+    scope: "global" | "organization";
+    configs: ConfigEntry[];
+}
+interface ApiClient {
+    assetCheck: (input: AssetCheckInput) => Promise<AssetCheckResult>;
+    assetSearch: (input: AssetSearchInput) => Promise<AssetSearchResult>;
+    listAssets: (input: AssetListInput) => Promise<AssetListResult>;
+    listDetectionConfigs: (slug: string) => Promise<DetectionSource[]>;
+    updateDetectionConfig: (input: DetectionConfigUpdateInput) => Promise<DetectionConfigUpdateResult>;
+    runDetectionConfigs: (input: DetectionConfigRunInput) => Promise<DetectionConfigRunResult>;
+    validateDetectionConfigs: (input: DetectionConfigValidateInput) => Promise<DetectionConfigValidateResult>;
+    getDetectionDrift: (input: DetectionDriftInput) => Promise<DetectionDriftResult>;
+    listDetections: (input: DetectionListInput) => Promise<DetectionListResult>;
+    getOperationsQueuesSnapshot: (input: OperationsQueuesSnapshotInput) => Promise<OperationsQueuesSnapshotResult>;
+    getMetricsSummary: (input: MetricsSummaryInput) => Promise<MetricsSummaryResult>;
+    getMetricsFound: (input: MetricsFoundInput) => Promise<MetricsFoundResult>;
+    getMetricsBreakdown: (input: MetricsBreakdownInput) => Promise<MetricsBreakdownResult>;
+    createReport: (input: ReportCreateInput) => Promise<ReportCreateResult>;
+    listOrganizationReports: (input: OrganizationReportsListInput) => Promise<OrganizationReportsListResult>;
+    searchReports: (input: ReportsSearchInput) => Promise<ReportsSearchResult>;
+    listTakedowns: (input: TakedownsListInput) => Promise<TakedownsListResult>;
+    listThreats: (input: ThreatsListInput) => Promise<ThreatsListResult>;
+    getOrganizationMetrics: (input: OrganizationMetricsInput) => Promise<OrganizationMetricsResult>;
+    listOrganizationAssets: (input: OrganizationAssetsListInput) => Promise<OrganizationAssetsListResult>;
+    listOrganizationAssetGroups: () => Promise<OrganizationAssetGroupsListResult>;
+    listOrganizationBrands: () => Promise<OrganizationBrandsListResult>;
+    listHealthchecks: () => Promise<HealthchecksListResult>;
+    runHealthcheck: (endpoint: string, input: Record<string, unknown>) => Promise<HealthcheckResult>;
+    getUserOrgs: (input: UserOrgsInput) => Promise<UserOrgsResult>;
+    getUserOrg: (input: UserOrgGetInput) => Promise<UserOrgGetResult>;
+    getCurrentUser: () => Promise<UserMeResult>;
+    validateApiKey: () => Promise<ValidateApiKeyResult>;
+}
+interface AssetCheckInput {
+    content: string;
+}
+type AssetCheckStatus = "ALLOWED" | "BLOCKED" | "UNKNOWN";
+interface AssetCheckSourceEntry {
+    source: string;
+    status: AssetCheckStatus;
+}
+interface AssetCheckResult {
+    status: AssetCheckStatus;
+    source: string;
+    reason?: string;
+    sources: AssetCheckSourceEntry[];
+    message?: string;
+    code?: string;
+    watchStatus?: "ENABLED" | "DISABLED";
+}
+interface AssetSearchInput {
+    content?: string;
+    assetId?: number;
+    assetIds?: number[];
+}
+interface AssetSearchResultItem {
+    asset: {
+        id: number;
+        content: string;
+        type: string;
+        status: string;
+        watchStatus: string;
+        createdAt: string;
+        updatedAt: string;
+    } | null;
+    reports: Array<{
+        id: number;
+        title: string | null;
+        status: string;
+        createdAt: string;
+    }>;
+    takedown: {
+        id: number;
+        status: string;
+        createdAt: string;
+        updatedAt: string;
+        tasks: Array<{
+            id: number;
+            type: string;
+            status: string;
+            retractionStatus: string;
+            externalId: string | null;
+            submittedAt: string | null;
+            retractedAt: string | null;
+            lastResponseAt: string | null;
+            createdAt: string;
+            updatedAt: string;
+            takedownProvider: {
+                name: string;
+            } | null;
+        }>;
+    } | null;
+    blockedBy: Array<{
+        consumer: string;
+        name: string | null;
+        consumedAt: string;
+    }>;
+}
+interface AssetSearchResult extends AssetSearchResultItem {
+    results?: AssetSearchResultItem[];
+}
+interface AssetListInput {
+    type: string;
+    status?: string;
+    startDate?: string;
+    endDate?: string;
+    perPage?: number;
+    nextPage?: string;
+}
+interface AssetListItem {
+    content: string;
+    type: string;
+    status: string;
+    watchStatus: string;
+    updatedAt: string;
+}
+interface AssetListResult {
+    assets: AssetListItem[];
+    next_page: string | null;
+}
+interface DetectionConfigUpdateInput {
+    slug: string;
+    configId: number;
+    status?: "ENABLED" | "DISABLED";
+    title?: string;
+    description?: string | null;
+    cron?: string | null;
+    config?: Record<string, unknown>;
+    mergeConfig?: boolean;
+}
+interface DetectionConfigUpdateResult {
+    config: {
+        id: number;
+        source: string;
+        status: string;
+        title: string;
+        description: string | null;
+        cron: string | null;
+        config: Record<string, unknown>;
+        updatedAt: string;
+    };
+}
+interface DetectionConfigRunInput {
+    slug: string;
+    configId?: number;
+    source?: string;
+    includeDisabled?: boolean;
+}
+interface DetectionConfigRunResult {
+    ranCount: number;
+    successCount: number;
+    failedCount: number;
+    results: Array<{
+        configId: number;
+        source: string;
+        ok: boolean;
+        message: string | null;
+        assetsCount: number;
+    }>;
+}
+interface DetectionConfigValidateInput {
+    slug: string;
+    source?: string;
+    minResults?: number;
+    lookbackHours?: number;
+    runBeforeValidate?: boolean;
+    includeDisabled?: boolean;
+}
+interface DetectionConfigValidateResult {
+    ok: boolean;
+    summary: {
+        checkedConfigs: number;
+        passingConfigs: number;
+        failingConfigs: number;
+        lookbackHours: number;
+        minResults: number;
+    };
+    validations: Array<{
+        configId: number;
+        source: string;
+        status: string;
+        ran: boolean;
+        runOk: boolean;
+        runMessage: string | null;
+        recentResultCount: number;
+        valid: boolean;
+    }>;
+}
+interface DetectionDriftInput {
+    slug: string;
+    lookbackHours?: number;
+    startDate?: string;
+    endDate?: string;
+    source?: string;
+    configIds?: number[];
+    includeDisabled?: boolean;
+    thresholds?: {
+        zeroResultsMaxHours?: number;
+        noisyResultsPerDay?: number;
+        noisyAllowedRatioThreshold?: number;
+        staleConfigDays?: number;
+    };
+}
+interface DetectionDriftResult {
+    ok: boolean;
+    range: {
+        startDate: string;
+        endDate: string;
+        lookbackHours: number;
+    };
+    thresholds: {
+        zeroResultsMaxHours: number;
+        noisyResultsPerDay: number;
+        noisyAllowedRatioThreshold: number;
+        staleConfigDays: number;
+    };
+    summary: {
+        checkedConfigs: number;
+        signalCount: number;
+        zeroResultsCount: number;
+        noisyCount: number;
+        staleCount: number;
+    };
+    signals: Array<{
+        signal: "zero_results_too_long" | "noisy_source" | "stale_query";
+        configId: number;
+        source: string;
+        title: string | null;
+        status: string;
+        severity: "low" | "medium" | "high";
+        details: Record<string, unknown>;
+    }>;
+}
+interface OperationsQueuesSnapshotInput {
+    slug?: string;
+    all?: boolean;
+    windowHours?: number;
+}
+interface OperationsQueuesSnapshotResult {
+    generatedAt: string;
+    scope: {
+        slug: string | null;
+        all: boolean;
+    };
+    reviewQueue: {
+        totalPendingProposals: number;
+        distinctReports: number;
+        ageBuckets: {
+            lt24h: number;
+            h24to72: number;
+            h72to168: number;
+            gte168h: number;
+        };
+        slaBuckets: {
+            breached: number;
+            dueWithin24h: number;
+            dueWithin72h: number;
+            beyond72h: number;
+            missingSla: number;
+        };
+        byOrg: Array<{
+            slug: string;
+            pendingProposals: number;
+        }>;
+    };
+    takedownQueue: {
+        totalOpen: number;
+        statusCounts: {
+            todo: number;
+            inProgress: number;
+            pendingInput: number;
+        };
+        ageBuckets: {
+            lt24h: number;
+            h24to72: number;
+            h72to168: number;
+            gte168h: number;
+        };
+        staleInProgress: number;
+        byOrg: Array<{
+            slug: string;
+            openTakedowns: number;
+        }>;
+    };
+}
+interface MetricsSummaryInput {
+    slug: string;
+    startDate?: string;
+    endDate?: string;
+    brandIds?: number[];
+}
+interface MetricsSummaryResult {
+    metrics: {
+        reports: number;
+        newThreats: number;
+        threatsWatchlisted: number;
+        takedownsFiled: number;
+        takedownsCompleted: number;
+        domainThreats: number;
+        twitterThreats: number;
+        telegramThreats: number;
+        otherThreats: number;
+    };
+    blockedByDay: Array<{
+        date: string;
+        count: number;
+    }>;
+    blockedByType: Array<{
+        type: string;
+        count: number;
+    }>;
+}
+interface MetricsFoundInput {
+    slug: string;
+    startDate: string;
+    endDate: string;
+    brandIds?: number[];
+}
+interface MetricsFoundResult {
+    metric: "new_threats";
+    found: number;
+    range: {
+        startDate: string;
+        endDate: string;
+    };
+}
+interface MetricsBreakdownInput {
+    slug: string;
+    by: "day" | "type" | "brand";
+    startDate?: string;
+    endDate?: string;
+    brandIds?: number[];
+}
+interface MetricsBreakdownResult {
+    by: "day" | "type" | "brand";
+    points: Array<{
+        key: string;
+        count: number;
+        date?: string;
+        type?: string;
+        brandId?: number;
+        brandSlug?: string;
+        brandName?: string;
+    }>;
+}
+interface ReportAssetInput {
+    content: string;
+    status?: "BLOCKED" | "ALLOWED" | "UNKNOWN";
+    brandSlug?: string;
+}
+interface ReportCreateInput {
+    organizationSlug?: string;
+    title?: string;
+    description?: string;
+    contactInfo?: string;
+    attachmentUrls?: string[];
+    externalSubmissionLink?: string;
+    userAgent?: string;
+    referrer?: string;
+    assets: ReportAssetInput[];
+    rawAssetsInput?: string;
+    externalReporter?: {
+        avatarUrl?: string;
+        platformIdentifier: string;
+        platform: string;
+        displayName: string;
+    };
+}
+interface ReportCreateResult {
+    id: number;
+    createdAt: string;
+    organization: {
+        id: number;
+        slug: string;
+        name: string;
+    } | null;
+}
+declare const REPORT_REVIEW_DECISIONS: readonly ["APPROVE", "REJECT", "SKIP", "ESCALATE"];
+type ReportReviewDecision = (typeof REPORT_REVIEW_DECISIONS)[number];
+declare const REPORT_STATUSES: readonly ["TODO", "IN_PROGRESS", "CLOSED"];
+type ReportStatus = (typeof REPORT_STATUSES)[number];
+interface OrganizationReportsListInput {
+    slug: string;
+    limit?: number;
+    cursor?: number;
+    status?: string;
+    searchQuery?: string;
+    reporterQuery?: string;
+    reportedByCustomer?: boolean;
+    excludeAutomation?: boolean;
+    onlyRejected?: boolean;
+    reviewStatuses?: ReportReviewDecision[];
+    assetTypes?: string[];
+    brandIds?: number[];
+    countryCodes?: string[];
+    reviewedByUserId?: number;
+    startDate?: string;
+    endDate?: string;
+    updatedAtStartDate?: string;
+    updatedAtEndDate?: string;
+}
+interface OrganizationReportsListResult {
+    reports: Array<{
+        id: number;
+        title: string;
+        description: string;
+        status: string | null;
+        reportedByCustomer: boolean;
+        createdAt: string;
+        updatedAt: string;
+        proposals: Array<{
+            reviewStatus: string;
+            asset: {
+                id: number;
+                type: string;
+                content: string;
+                status: string;
+            };
+        }>;
+        reporter: {
+            id: number;
+            role: string;
+            fullName: string;
+            avatarUrl: string | null;
+        } | null;
+        externalReporter: {
+            id: number;
+            displayName: string | null;
+            avatarUrl: string | null;
+            platform: string;
+        } | null;
+    }>;
+    nextCursor: number | null;
+    totalCount: number;
+}
+declare const DETECTION_CONFIDENCE_LEVELS: readonly ["none", "low", "medium", "high"];
+type DetectionConfidence = (typeof DETECTION_CONFIDENCE_LEVELS)[number];
+type DetectionReportStatus = "REPORTED" | "NOT_REPORTED";
+declare const DETECTION_REPORTED_FILTERS: readonly ["reported", "not_reported"];
+type DetectionReportedFilter = (typeof DETECTION_REPORTED_FILTERS)[number];
+declare const LIVENESS_FILTER_VALUES: readonly ["ALIVE", "DEAD", "UNKNOWN"];
+type LivenessFilterValue = (typeof LIVENESS_FILTER_VALUES)[number];
+declare const WATCHLIST_FILTER_VALUES: readonly ["ENABLED", "DISABLED"];
+type WatchlistFilterValue = (typeof WATCHLIST_FILTER_VALUES)[number];
+interface DetectionListInput {
+    slug: string;
+    cursor?: number;
+    limit?: number;
+    query?: string;
+    startDate?: string;
+    endDate?: string;
+    sources?: string[];
+    confidence?: DetectionConfidence[];
+    assetStatus?: string[];
+    assetType?: string[];
+    brandIds?: number[];
+    liveness?: LivenessFilterValue[];
+    watchlist?: WatchlistFilterValue[];
+    reported?: DetectionReportedFilter[];
+    countryCodes?: string[];
+    onlyDeleted?: boolean;
+}
+interface DetectionListItem {
+    id: number;
+    threatContent: string;
+    source: string;
+    createdAt: string;
+    confidence: DetectionConfidence;
+    reportStatus: DetectionReportStatus;
+    asset: {
+        id: number;
+        content: string;
+        type: string;
+        status: string;
+    };
+}
+interface DetectionListResult {
+    detections: DetectionListItem[];
+    nextCursor?: number;
+}
+interface ThreatsListInput {
+    query?: string;
+    startDate?: string;
+    endDate?: string;
+    assetType?: string[];
+    sorting?: Array<{
+        key: string;
+        direction: "asc" | "desc";
+    }>;
+    perPage?: number;
+    nextPage?: string;
+}
+interface ThreatItem {
+    id: number;
+    content: string;
+    type: string;
+    blockedAt: string;
+}
+interface ThreatsListResult {
+    threats: ThreatItem[];
+    next_page: string | null;
+}
+interface OrganizationAssetsListInput {
+    type?: string;
+    groupId?: number;
+    query?: string;
+    perPage?: number;
+    nextPage?: string;
+}
+interface OrganizationAssetItem {
+    id: number;
+    content: string;
+    type: string;
+    status: string;
+    name: string | null;
+    description: string | null;
+    group: {
+        id: number;
+        name: string;
+    } | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface OrganizationAssetsListResult {
+    assets: OrganizationAssetItem[];
+    next_page: string | null;
+}
+interface AssetGroupItem {
+    id: number;
+    name: string;
+    assetCount: number;
+}
+interface OrganizationAssetGroupsListResult {
+    groups: AssetGroupItem[];
+}
+type BrandType = "ORGANIZATION" | "INDIVIDUAL";
+interface BrandItem {
+    id: number;
+    slug: string;
+    name: string;
+    type: BrandType;
+    description: string | null;
+    brandGroupId: number | null;
+    createdAt: string;
+}
+interface OrganizationBrandsListResult {
+    brands: BrandItem[];
+}
+interface ReportsSearchInput {
+    assetContents: string[];
+    reportedByCustomer?: boolean;
+}
+interface ReportsSearchResultItem {
+    id: number;
+    status: string;
+    reportedByCustomer: boolean;
+    assets: string[];
+}
+interface ReportsSearchResult {
+    reports: ReportsSearchResultItem[];
+}
+interface UserMeResult {
+    user: {
+        id: number;
+        name: string;
+        avatarUrl: string | null;
+        email: string;
+        role: string;
+        protectionConfig: {
+            linkMonitoring: boolean;
+            socialMediaScanning: boolean;
+            historyScanning: boolean;
+        } | null;
+    };
+}
+interface ValidateApiKeyResult {
+    status: "success";
+    message: string;
+}
+declare const TAKEDOWN_STATUSES: readonly ["TODO", "IN_PROGRESS", "COMPLETED", "CANCELLED", "PENDING_RETRACTION", "RETRACTION_SENT", "RETRACTED", "PENDING_INPUT"];
+type TakedownStatus = (typeof TAKEDOWN_STATUSES)[number];
+declare const LIVENESS_STATUSES: readonly ["UNKNOWN", "ALIVE", "DEAD"];
+type LivenessStatus = (typeof LIVENESS_STATUSES)[number];
+declare const TAKEDOWN_SORT_KEYS: readonly ["updatedAt", "createdAt", "takedownStatus", "takedownUpdatedAt", "assigneeId", "brandId"];
+type TakedownSortKey = (typeof TAKEDOWN_SORT_KEYS)[number];
+interface TakedownsListInput {
+    organizationSlug?: string;
+    query?: string;
+    startDate?: string;
+    endDate?: string;
+    assetType?: string[];
+    takedownStatus?: TakedownStatus[];
+    livenessStatus?: LivenessStatus[];
+    brandIds?: number[];
+    assigneeIds?: number[];
+    startedAtStartDate?: string;
+    startedAtEndDate?: string;
+    hideAutomatedTakedowns?: boolean;
+    hideAutomatedLivenessChecks?: boolean;
+    sorting?: Array<{
+        key: TakedownSortKey;
+        direction: "asc" | "desc";
+    }>;
+    perPage?: number;
+    nextPage?: string;
+}
+interface TakedownItem {
+    id: number;
+    status: TakedownStatus;
+    createdAt: string;
+    updatedAt: string;
+    asset: {
+        id: number;
+        content: string;
+        type: string;
+        livenessStatus: LivenessStatus | null;
+    };
+    assignee: {
+        id: number;
+        fullName: string | null;
+    } | null;
+    brand: {
+        id: number;
+        name: string;
+        slug: string | null;
+    } | null;
+}
+interface TakedownsListResult {
+    takedowns: TakedownItem[];
+    next_page: string | null;
+}
+declare const ORGANIZATION_METRICS_INCLUDE_FIELDS: readonly ["reports", "newThreats", "threatsWatchlisted", "takedownsFiled", "takedownsCompleted", "domainThreats", "twitterThreats", "telegramThreats", "otherThreats", "blockedByType", "blockedByDay"];
+type OrganizationMetricsIncludeField = (typeof ORGANIZATION_METRICS_INCLUDE_FIELDS)[number];
+interface OrganizationMetricsServicesFilter {
+    reporting?: {
+        active?: boolean;
+    };
+    reviewing?: {
+        active?: boolean;
+    };
+    protection?: {
+        active?: boolean;
+    };
+    takedowns?: {
+        active?: boolean;
+        automated?: boolean;
+    };
+    detection?: {
+        active?: boolean;
+    };
+    darkWebMonitoring?: {
+        active?: boolean;
+    };
+}
+interface OrganizationMetricsInput {
+    organizationSlug?: string;
+    slugs?: string[];
+    allMyOrgs?: boolean;
+    subscriptionStatus?: string[];
+    services?: OrganizationMetricsServicesFilter;
+    brandSlug?: string;
+    startDate?: string;
+    endDate?: string;
+    include?: OrganizationMetricsIncludeField[];
+}
+interface OrganizationMetricsResultMetrics {
+    reports: number | null;
+    newThreats: number | null;
+    threatsWatchlisted: number | null;
+    takedownsFiled: number | null;
+    takedownsCompleted: number | null;
+    domainThreats: number | null;
+    twitterThreats: number | null;
+    telegramThreats: number | null;
+    otherThreats: number | null;
+}
+interface OrganizationMetricsResult {
+    metrics: OrganizationMetricsResultMetrics;
+    blockedByType: Array<{
+        type: string;
+        count: number;
+    }> | null;
+    blockedByDay: Array<{
+        date: string;
+        count: number;
+    }> | null;
+    averages: {
+        perDay: OrganizationMetricsResultMetrics | null;
+        perOrgPerDay: OrganizationMetricsResultMetrics | null;
+        windowDays: number | null;
+    };
+    perOrg: Record<string, {
+        metrics: OrganizationMetricsResultMetrics;
+        blockedByType: Array<{
+            type: string;
+            count: number;
+        }> | null;
+        blockedByDay: Array<{
+            date: string;
+            count: number;
+        }> | null;
+    }> | null;
+    scope: {
+        mode: "single" | "multi";
+        orgs: string[];
+        resolvedFrom: "api-key" | "organizationSlug" | "slugs" | "allMyOrgs";
+    };
+}
+type HealthcheckCategory = "detection" | "reviewing" | "blocklisting" | "takedowns" | "assets" | "organization";
+type HealthcheckSeverity = "ok" | "warn" | "fail";
+interface HealthcheckFinding {
+    kind: string;
+    ref: string | null;
+    message: string;
+    severity: "warn" | "fail";
+}
+interface HealthcheckResult {
+    id: string;
+    title: string;
+    category: HealthcheckCategory;
+    generatedAt: string;
+    scope: {
+        slug: string | null;
+    };
+    ok: boolean;
+    severity: HealthcheckSeverity;
+    observed: Record<string, number | string | boolean | null>;
+    threshold: Record<string, number | string | boolean | null>;
+    findings: HealthcheckFinding[];
+    suggestedAction: string | null;
+    appUrl: string | null;
+}
+interface HealthcheckRegistryEntry {
+    id: string;
+    title: string;
+    description: string;
+    category: HealthcheckCategory;
+    implemented: boolean;
+    endpoint: string | null;
+    defaultThreshold?: Record<string, number | string>;
+    notImplementedReason?: string;
+}
+interface HealthchecksListResult {
+    checks: HealthcheckRegistryEntry[];
+}
+type UserOrgsSubscriptionStatus = "PROSPECT" | "TRIAL" | "ACTIVE" | "INTEGRATION";
+type PendingApprovalService = "protection" | "takedowns";
+interface PendingServiceApproval {
+    service: PendingApprovalService;
+    automated: boolean;
+    serviceType: string;
+    serviceName: string;
+    requestedAt: string;
+}
+interface UserOrgsServiceFilters {
+    reporting?: {
+        active?: boolean;
+    };
+    reviewing?: {
+        active?: boolean;
+    };
+    protection?: {
+        active?: boolean;
+    };
+    takedowns?: {
+        active?: boolean;
+        automated?: boolean;
+    };
+    detection?: {
+        active?: boolean;
+    };
+    darkWebMonitoring?: {
+        active?: boolean;
+    };
+}
+interface UserOrgsObligatoryAdminApprovalFilter {
+    active?: boolean;
+    assetTypes?: string[];
+}
+interface UserOrgsPendingServiceApprovalFilter {
+    active?: boolean;
+    services?: PendingApprovalService[];
+}
+interface UserOrgsInput {
+    query?: string;
+    subscriptionStatus?: UserOrgsSubscriptionStatus[];
+    services?: UserOrgsServiceFilters;
+    obligatoryAdminApproval?: UserOrgsObligatoryAdminApprovalFilter;
+    pendingServiceApproval?: UserOrgsPendingServiceApprovalFilter;
+}
+interface UserOrg {
+    id: number;
+    name: string;
+    slug: string;
+    avatarUrl: string | null;
+    contactUrl: string | null;
+    subscriptionStatus: "PROSPECT" | "TRIAL" | "ACTIVE" | "INTEGRATION" | "INACTIVE";
+    services: {
+        reporting: {
+            active: boolean;
+        };
+        reviewing: {
+            active: boolean;
+        };
+        protection: {
+            active: boolean;
+        };
+        takedowns: {
+            active: boolean;
+            automated: boolean;
+        };
+        detection: {
+            active: boolean;
+        };
+        darkWebMonitoring: {
+            active: boolean;
+        };
+    };
+    obligatoryAdminApproval: {
+        active: boolean;
+        assetTypes: string[];
+    };
+    pendingServiceApprovals: PendingServiceApproval[];
+}
+interface UserOrgsResult {
+    organizations: UserOrg[];
+}
+interface UserOrgGetInput {
+    slug: string;
+}
+interface UserOrgGetResult {
+    organization: UserOrg;
+}
+
+declare function staticApiKey(key: string): CredentialProvider;
+declare function staticBearerToken(token: string): CredentialProvider;
+declare class ChainPatrolApiClient implements ApiClient {
+    private readonly baseUrl;
+    private readonly credential;
+    private readonly timeoutMs;
+    constructor(options: ChainPatrolApiClientOptions);
+    private buildAuthHeaders;
+    private requestGet;
+    private request;
+    private wrapFetchError;
+    private handleResponse;
+    assetCheck(input: AssetCheckInput): Promise<AssetCheckResult>;
+    assetSearch(input: AssetSearchInput): Promise<AssetSearchResult>;
+    listDetectionConfigs(slug: string): Promise<DetectionSource[]>;
+    updateDetectionConfig(input: DetectionConfigUpdateInput): Promise<DetectionConfigUpdateResult>;
+    runDetectionConfigs(input: DetectionConfigRunInput): Promise<DetectionConfigRunResult>;
+    validateDetectionConfigs(input: DetectionConfigValidateInput): Promise<DetectionConfigValidateResult>;
+    getDetectionDrift(input: DetectionDriftInput): Promise<DetectionDriftResult>;
+    getOperationsQueuesSnapshot(input: OperationsQueuesSnapshotInput): Promise<OperationsQueuesSnapshotResult>;
+    getMetricsSummary(input: MetricsSummaryInput): Promise<MetricsSummaryResult>;
+    getMetricsFound(input: MetricsFoundInput): Promise<MetricsFoundResult>;
+    getMetricsBreakdown(input: MetricsBreakdownInput): Promise<MetricsBreakdownResult>;
+    createReport(input: ReportCreateInput): Promise<ReportCreateResult>;
+    listOrganizationReports(input: OrganizationReportsListInput): Promise<OrganizationReportsListResult>;
+    listTakedowns(input: TakedownsListInput): Promise<TakedownsListResult>;
+    getOrganizationMetrics(input: OrganizationMetricsInput): Promise<OrganizationMetricsResult>;
+    listHealthchecks(): Promise<HealthchecksListResult>;
+    runHealthcheck(endpoint: string, input: Record<string, unknown>): Promise<HealthcheckResult>;
+    getUserOrgs(input: UserOrgsInput): Promise<UserOrgsResult>;
+    getUserOrg(input: UserOrgGetInput): Promise<UserOrgGetResult>;
+    listAssets(input: AssetListInput): Promise<AssetListResult>;
+    listThreats(input: ThreatsListInput): Promise<ThreatsListResult>;
+    listDetections(input: DetectionListInput): Promise<DetectionListResult>;
+    searchReports(input: ReportsSearchInput): Promise<ReportsSearchResult>;
+    listOrganizationAssets(input: OrganizationAssetsListInput): Promise<OrganizationAssetsListResult>;
+    listOrganizationAssetGroups(): Promise<OrganizationAssetGroupsListResult>;
+    listOrganizationBrands(): Promise<OrganizationBrandsListResult>;
+    getCurrentUser(): Promise<UserMeResult>;
+    validateApiKey(): Promise<ValidateApiKeyResult>;
+}
+
+declare function parseIsoDate(value: string | undefined): Date | undefined;
+declare function parseIsoDateString(value: string | undefined): string | undefined;
+
+export { type ApiClient, type ApiCredential, type AssetCheckInput, type AssetCheckResult, type AssetCheckSourceEntry, type AssetCheckStatus, type AssetGroupItem, type AssetListInput, type AssetListItem, type AssetListResult, type AssetSearchInput, type AssetSearchResult, type AssetSearchResultItem, type BrandItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionConfidence, type DetectionConfigRunInput, type DetectionConfigRunResult, type DetectionConfigUpdateInput, type DetectionConfigUpdateResult, type DetectionConfigValidateInput, type DetectionConfigValidateResult, type DetectionDriftInput, type DetectionDriftResult, type DetectionListInput, type DetectionListItem, type DetectionListResult, type DetectionReportStatus, type DetectionReportedFilter, type DetectionSource, type HealthcheckCategory, type HealthcheckFinding, type HealthcheckRegistryEntry, type HealthcheckResult, type HealthcheckSeverity, type HealthchecksListResult, LIVENESS_FILTER_VALUES, LIVENESS_STATUSES, type LivenessFilterValue, type LivenessStatus, type MetricsBreakdownInput, type MetricsBreakdownResult, type MetricsFoundInput, type MetricsFoundResult, type MetricsSummaryInput, type MetricsSummaryResult, ORGANIZATION_METRICS_INCLUDE_FIELDS, type OperationsQueuesSnapshotInput, type OperationsQueuesSnapshotResult, type OrganizationAssetGroupsListResult, type OrganizationAssetItem, type OrganizationAssetsListInput, type OrganizationAssetsListResult, type OrganizationBrandsListResult, type OrganizationMetricsIncludeField, type OrganizationMetricsInput, type OrganizationMetricsResult, type OrganizationMetricsResultMetrics, type OrganizationMetricsServicesFilter, type OrganizationReportsListInput, type OrganizationReportsListResult, type PendingApprovalService, type PendingServiceApproval, REPORT_REVIEW_DECISIONS, REPORT_STATUSES, type ReportAssetInput, type ReportCreateInput, type ReportCreateResult, type ReportReviewDecision, type ReportStatus, type ReportsSearchInput, type ReportsSearchResult, type ReportsSearchResultItem, TAKEDOWN_SORT_KEYS, TAKEDOWN_STATUSES, type TakedownItem, type TakedownSortKey, type TakedownStatus, type TakedownsListInput, type TakedownsListResult, type ThreatItem, type ThreatsListInput, type ThreatsListResult, type UserMeResult, type UserOrg, type UserOrgGetInput, type UserOrgGetResult, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateString, staticApiKey, staticBearerToken };