@chainpatrol/sdk 1.1.0 → 1.3.0

package/dist/api/index.d.ts

@@ -14,9 +14,31 @@ interface ChainPatrolApiClientOptions {
 interface ConfigEntry {
     id: number;
     title: string;
+    /**
+     * Human-readable description of what the config does. `null` when unset
+     * — most configs seeded before this field existed do not have one.
+     */
+    description: string | null;
     status: string;
     cron: string | null;
     config: Record<string, unknown>;
+    /**
+     * Optional brand connection. Present only for org-scoped configs when the
+     * config targets a specific brand.
+     */
+    brandId?: number | null;
+    brand?: {
+        id: number;
+        name: string;
+        slug: string;
+    } | null;
+    /** When the config was first created (ISO 8601, UTC). */
+    createdAt: string;
+    /**
+     * When the config was last updated (ISO 8601, UTC). Pair with the drift
+     * healthcheck to spot silent configs untouched in months.
+     */
+    updatedAt: string;
 }
 interface DetectionSource {
     source: string;
@@ -82,6 +104,16 @@ interface AssetSearchResultItem {
         type: string;
         status: string;
         watchStatus: string;
+        /**
+         * Whether the asset is currently reachable (`"ALIVE"`), gone
+         * (`"DEAD"`), or unchecked (`"UNKNOWN"`). Null when never evaluated.
+         */
+        livenessStatus: LivenessStatus | null;
+        /**
+         * When the asset transitioned to BLOCKED (ISO 8601, UTC). Null for
+         * non-blocked assets or blocks predating the field.
+         */
+        blockedAt: string | null;
         createdAt: string;
         updatedAt: string;
     } | null;
@@ -130,10 +162,22 @@ interface AssetListInput {
     nextPage?: string;
 }
 interface AssetListItem {
+    /** Asset ID — reference in follow-up calls (was previously stripped from the response). */
+    id: number;
     content: string;
     type: string;
     status: string;
     watchStatus: string;
+    /**
+     * Whether the asset is currently reachable (`"ALIVE"`), gone
+     * (`"DEAD"`), or unchecked (`"UNKNOWN"`). Null when never evaluated.
+     */
+    livenessStatus: LivenessStatus | null;
+    /**
+     * When the asset transitioned to BLOCKED (ISO 8601, UTC). Null for
+     * non-blocked assets.
+     */
+    blockedAt: string | null;
     updatedAt: string;
 }
 interface AssetListResult {
@@ -421,15 +465,53 @@ interface OrganizationReportsListInput {
     updatedAtStartDate?: string;
     updatedAtEndDate?: string;
 }
+interface OrganizationReportAssetScanEnrichment {
+    id: number;
+    type: string;
+    output: unknown;
+    status: string;
+}
+interface OrganizationReportAssetScan {
+    id: number;
+    status: string;
+    output: unknown;
+    createdAt: string;
+    enrichments: OrganizationReportAssetScanEnrichment[];
+}
+interface OrganizationReportAttachment {
+    id: number;
+    url: string;
+}
 interface OrganizationReportsListResult {
     reports: Array<{
         id: number;
         title: string;
         description: string;
+        /** Whether the report's images render inline or are hidden by default. */
+        imageDisplay: string;
+        /** When the report was starred/favorited (ISO 8601, UTC). Null when not favorited. */
+        favoritedAt: string | null;
         status: string | null;
         reportedByCustomer: boolean;
+        /**
+         * SLA deadline for this report (ISO 8601, UTC). Null when no SLA
+         * applies (e.g. staff-created reports).
+         */
+        slaDueAt: string | null;
+        /**
+         * URL to the original external source of the report when submitted
+         * from a third-party surface (Discord/Twitter link, forwarded webform).
+         * Null for reports created directly in ChainPatrol.
+         */
+        externalSubmissionLink: string | null;
+        /**
+         * ID of the canonical report this one duplicates. Null when the
+         * report is not a duplicate.
+         */
+        duplicateOfId: number | null;
         createdAt: string;
         updatedAt: string;
+        attachments: OrganizationReportAttachment[];
         proposals: Array<{
             reviewStatus: string;
             asset: {
@@ -437,6 +519,12 @@ interface OrganizationReportsListResult {
                 type: string;
                 content: string;
                 status: string;
+                /**
+                 * Per-scan enrichment data. Large (Apple App Store enrichments run
+                 * 50–200 KB each) — the agent42 tool strips these by default when
+                 * relaying results. Present in the raw handler response.
+                 */
+                scans: OrganizationReportAssetScan[];
             };
         }>;
         reporter: {
@@ -482,12 +570,42 @@ interface DetectionListInput {
     countryCodes?: string[];
     onlyDeleted?: boolean;
 }
+interface DetectionBrand {
+    id: number;
+    name: string;
+    slug: string;
+}
 interface DetectionListItem {
     id: number;
     threatContent: string;
     source: string;
     createdAt: string;
     confidence: DetectionConfidence;
+    /**
+     * Raw model score (0–1). `confidence` buckets this into low/medium/high
+     * using the org's thresholds; use `score` when the buckets are too coarse.
+     */
+    score: number;
+    /**
+     * Free-text explanation of why the detection fired (e.g. "matches
+     * brand-name typo squat", "TLS cert issued by known lookalike CA").
+     */
+    reason: string;
+    /**
+     * ID of the `ThreatDetectionConfig` that produced this hit. Pair with
+     * `listDetectionConfigs` to drill back into the config.
+     */
+    configId: number;
+    /**
+     * When the detection was reported (ISO 8601, UTC). Null when the
+     * detection has not been reported yet.
+     */
+    reportedAt: string | null;
+    /**
+     * Brands the detection was associated with. Empty when the detection
+     * was not linked to any brand at classification time.
+     */
+    brands: DetectionBrand[];
     reportStatus: DetectionReportStatus;
     asset: {
         id: number;
@@ -516,6 +634,11 @@ interface ThreatItem {
     id: number;
     content: string;
     type: string;
+    /**
+     * Liveness of the blocked threat. `"ALIVE"` still reachable, `"DEAD"`
+     * gone, `"UNKNOWN"` unchecked. Null when never evaluated.
+     */
+    livenessStatus: LivenessStatus | null;
     blockedAt: string;
 }
 interface ThreatsListResult {
@@ -540,6 +663,16 @@ interface OrganizationAssetItem {
         id: number;
         name: string;
     } | null;
+    /**
+     * Whether the asset is currently reachable (`"ALIVE"`), gone
+     * (`"DEAD"`), or unchecked (`"UNKNOWN"`). Null when never evaluated.
+     */
+    livenessStatus: LivenessStatus | null;
+    /**
+     * When the asset transitioned to BLOCKED (ISO 8601, UTC). Null for
+     * non-blocked assets.
+     */
+    blockedAt: string | null;
     createdAt: string;
     updatedAt: string;
 }
@@ -604,8 +737,14 @@ interface ReportsSearchInput {
 }
 interface ReportsSearchResultItem {
     id: number;
+    /**
+     * Report title. Null for external / anonymous reports without one.
+     */
+    title: string | null;
     status: string;
     reportedByCustomer: boolean;
+    /** When the report was created (ISO 8601, UTC). */
+    createdAt: string;
     assets: string[];
 }
 interface ReportsSearchResult {
@@ -659,6 +798,24 @@ interface TakedownsListInput {
 interface TakedownItem {
     id: number;
     status: TakedownStatus;
+    /**
+     * Provider's own reference for this takedown (e.g. CleanDNS report ID,
+     * registrar ticket). Reconcile with the vendor's dashboard. `null` when
+     * no vendor has picked it up yet.
+     */
+    externalId: string | null;
+    /**
+     * Manually set by staff to exclude the takedown from median-time metrics
+     * when its filing was delayed for reasons unrelated to platform
+     * performance.
+     */
+    hasFilingDelay: boolean;
+    /**
+     * Manually set by staff to exclude the takedown from median-time metrics
+     * when the liveness-check step was delayed for reasons unrelated to
+     * platform performance.
+     */
+    hasLivenessCheckDelay: boolean;
     createdAt: string;
     updatedAt: string;
     asset: {
@@ -666,6 +823,11 @@ interface TakedownItem {
         content: string;
         type: string;
         livenessStatus: LivenessStatus | null;
+        /**
+         * When the asset transitioned to BLOCKED (ISO 8601, UTC). Null if the
+         * asset was never blocked (rare for takedown rows).
+         */
+        blockedAt: string | null;
     };
     assignee: {
         id: number;
@@ -872,6 +1034,45 @@ interface UserOrgTrademarkRegistration {
     certificateFileUrl: string | null;
 }
 type OrganizationPortalVisibility = "PUBLIC" | "PRIVATE" | "DISABLED";
+type OrganizationReportVisibility = "PUBLIC" | "PRIVATE";
+type OrganizationMetricsVisibility = "PUBLIC" | "PRIVATE" | "DISABLED";
+interface UserOrgBrandMetadata {
+    /** Public website URL of the brand (linked from the portal header). */
+    websiteUrl: string | null;
+    /** Public Twitter/X handle of the brand, stored with the leading `@` (e.g. `@acme`). */
+    twitterHandle: string | null;
+    /**
+     * Email address for security correspondence — used by takedown providers
+     * and researchers, distinct from the internal customer POC email.
+     */
+    securityContactEmail: string | null;
+    /** Free-form industry label (e.g. `"DeFi"`, `"CEX"`, `"NFT"`, `"Wallet"`). */
+    industry: string | null;
+}
+interface UserOrgPortalCustomization {
+    /**
+     * When `true`, the portal uses `name` / `slug` / `avatarUrl` from this
+     * object instead of the org's own name / slug / avatar.
+     */
+    useCustomDetails: boolean;
+    /** Custom display name shown on the portal (used only when `useCustomDetails=true`). */
+    name: string | null;
+    /**
+     * Custom URL slug (`chainpatrol.io/<slug>`) — takes precedence over the
+     * org's own slug when set, regardless of `useCustomDetails`.
+     */
+    slug: string | null;
+    /** Custom avatar URL shown on the portal (used only when `useCustomDetails=true`). */
+    avatarUrl: string | null;
+    /** When `true`, the portal renders `bannerContent` as a highlighted banner. */
+    bannerEnabled: boolean;
+    /**
+     * Markdown body of the portal banner. Null (or empty) with
+     * `bannerEnabled=true` means the toggle is on but no content has been
+     * written yet.
+     */
+    bannerContent: string | null;
+}
 interface UserOrg {
     id: number;
     name: string;
@@ -886,6 +1087,29 @@ interface UserOrg {
      *   - `DISABLED` — the portal returns a 404.
      */
     portalVisibility: OrganizationPortalVisibility;
+    /**
+     * Whether the report listings on the public portal are visible to
+     * visitors. `PUBLIC` shows the org's reports; `PRIVATE` hides the report
+     * list even when the portal is discoverable.
+     */
+    reportVisibility: OrganizationReportVisibility;
+    /**
+     * Whether the metrics / threats-blocked stats render on the public portal.
+     *   - `PUBLIC`   — metrics tab is visible.
+     *   - `PRIVATE`  — metrics tab is hidden from anonymous visitors.
+     *   - `DISABLED` — metrics are not computed for this org.
+     */
+    metricsVisibility: OrganizationMetricsVisibility;
+    /**
+     * Public brand-facing metadata (website, twitter, security contact,
+     * industry) shown on the portal and used by staff for outbound.
+     */
+    brandMetadata: UserOrgBrandMetadata;
+    /**
+     * Customer-configurable presentation of the public security portal —
+     * custom name / slug / avatar and the banner content.
+     */
+    portalCustomization: UserOrgPortalCustomization;
     services: {
         reporting: {
             active: boolean;
@@ -971,4 +1195,4 @@ declare class ChainPatrolApiClient implements ApiClient {
 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 BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, 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 OrganizationPortalVisibility, 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 UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateString, staticApiKey, staticBearerToken };
+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 BrandLegalDocument, type BrandLegalDocuments, type BrandTrademarkRegistrationItem, type BrandType, ChainPatrolApiClient, type ChainPatrolApiClientOptions, type ConfigEntry, type CredentialProvider, DETECTION_CONFIDENCE_LEVELS, DETECTION_REPORTED_FILTERS, type DetectionBrand, 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 OrganizationMetricsVisibility, type OrganizationPortalVisibility, type OrganizationReportAssetScan, type OrganizationReportAssetScanEnrichment, type OrganizationReportAttachment, type OrganizationReportVisibility, 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 UserOrgBrandMetadata, type UserOrgGetInput, type UserOrgGetResult, type UserOrgIntegrations, type UserOrgLegalDocument, type UserOrgLegalDocuments, type UserOrgPortalCustomization, type UserOrgTrademarkRegistration, type UserOrgsInput, type UserOrgsObligatoryAdminApprovalFilter, type UserOrgsPendingServiceApprovalFilter, type UserOrgsResult, type UserOrgsServiceFilters, type UserOrgsSubscriptionStatus, type ValidateApiKeyResult, WATCHLIST_FILTER_VALUES, type WatchlistFilterValue, parseIsoDate, parseIsoDateString, staticApiKey, staticBearerToken };