@chainpatrol/sdk 1.2.0 → 1.4.0

package/dist/api/index.d.ts

@@ -14,9 +14,37 @@ 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;
+    /**
+     * When the most recent `ThreatDetectionResult` for this config was created
+     * (ISO 8601, UTC). Null when the config has never produced a hit. A config
+     * with no recent `lastResultAt` is going silent regardless of `updatedAt`.
+     */
+    lastResultAt: string | null;
 }
 interface DetectionSource {
     source: string;
@@ -82,6 +110,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 +168,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 {
@@ -401,6 +451,8 @@ declare const REPORT_REVIEW_DECISIONS: readonly ["APPROVE", "REJECT", "SKIP", "E
 type ReportReviewDecision = (typeof REPORT_REVIEW_DECISIONS)[number];
 declare const REPORT_STATUSES: readonly ["TODO", "IN_PROGRESS", "CLOSED"];
 type ReportStatus = (typeof REPORT_STATUSES)[number];
+declare const ACTOR_KINDS: readonly ["human", "automation"];
+type ActorKind = (typeof ACTOR_KINDS)[number];
 interface OrganizationReportsListInput {
     slug: string;
     limit?: number;
@@ -409,7 +461,12 @@ interface OrganizationReportsListInput {
     searchQuery?: string;
     reporterQuery?: string;
     reportedByCustomer?: boolean;
+    /** @deprecated Prefer `reporterKind: "human"`. */
     excludeAutomation?: boolean;
+    /** Filter by whether the report was submitted by a human or automation. */
+    reporterKind?: ActorKind;
+    /** Filter by whether the report was approved by a human or automation. */
+    reviewerKind?: ActorKind;
     onlyRejected?: boolean;
     reviewStatuses?: ReportReviewDecision[];
     assetTypes?: string[];
@@ -420,16 +477,69 @@ interface OrganizationReportsListInput {
     endDate?: string;
     updatedAtStartDate?: string;
     updatedAtEndDate?: string;
+    /**
+     * Filter to reports waiting on the organization's own approval — the reports
+     * a customer admin still has to sign off on before the assets in them can be
+     * blocked. `true` returns only those reports; `false` returns only reports
+     * that are not waiting on them.
+     *
+     * When "Obligatory Organization Admin Approval" is on for the organization,
+     * that means every report with a pending proposal whose asset type is in the
+     * approval scope (all asset types when the scope has not been narrowed), plus
+     * anything ChainPatrol staff escalated to the organization. When the setting
+     * is off, only reports staff escalated to the organization are returned.
+     * Reports the organization submitted itself are never included — staff can
+     * action those without customer sign-off.
+     */
+    needsCustomerReview?: boolean;
+}
+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 +547,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 +598,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 +662,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 +691,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;
 }
@@ -600,16 +761,39 @@ interface OrganizationBrandsListResult {
 }
 interface ReportsSearchInput {
     assetContents: string[];
+    /**
+     * Organization slug. Optional for organization-scoped API keys, which resolve
+     * the organization from the key itself. Required when your credentials can
+     * reach more than one organization — including the bearer token issued by
+     * `chainpatrol login`.
+     */
+    slug?: string;
     reportedByCustomer?: boolean;
+    /**
+     * Maximum number of reports to return, newest first. Defaults to 50, maximum
+     * 100. Compare with `totalCount` to tell whether results were truncated.
+     */
+    limit?: number;
 }
 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 {
     reports: ReportsSearchResultItem[];
+    /**
+     * Total number of reports matching the search, ignoring `limit`. Greater than
+     * `reports.length` means the results were truncated.
+     */
+    totalCount: number;
 }
 interface UserMeResult {
     user: {
@@ -659,6 +843,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 +868,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;
@@ -676,6 +883,26 @@ interface TakedownItem {
         name: string;
         slug: string | null;
     } | null;
+    /**
+     * Domain registrar assigned to this takedown (e.g. Namecheap, GoDaddy).
+     * Null when unresolved. Distinct from per-task `takedownProvider` — this
+     * is the takedown-level assignment for the domain itself.
+     */
+    domainRegistrar: TakedownProviderRef | null;
+    /**
+     * Hosting provider assigned to this takedown (e.g. Cloudflare, AWS).
+     * Answers "who hosts this?" without a follow-up call. Null when unresolved.
+     */
+    hostingProvider: TakedownProviderRef | null;
+    /**
+     * Top-level-domain registrar assigned to this takedown (e.g. Verisign).
+     * Null when unresolved.
+     */
+    tldRegistrar: TakedownProviderRef | null;
+}
+interface TakedownProviderRef {
+    id: number;
+    name: string;
 }
 interface TakedownsListResult {
     takedowns: TakedownItem[];
@@ -1033,4 +1260,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 OrganizationMetricsVisibility, type OrganizationPortalVisibility, 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 };
+export { ACTOR_KINDS, type ActorKind, 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 TakedownProviderRef, 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 };

package/dist/api/index.js

@@ -43,6 +43,7 @@ var __async = (__this, __arguments, generator) => {
 // src/api/types.ts
 var REPORT_REVIEW_DECISIONS = ["APPROVE", "REJECT", "SKIP", "ESCALATE"];
 var REPORT_STATUSES = ["TODO", "IN_PROGRESS", "CLOSED"];
+var ACTOR_KINDS = ["human", "automation"];
 var DETECTION_CONFIDENCE_LEVELS = ["none", "low", "medium", "high"];
 var DETECTION_REPORTED_FILTERS = ["reported", "not_reported"];
 var LIVENESS_FILTER_VALUES = ["ALIVE", "DEAD", "UNKNOWN"];
@@ -111,6 +112,12 @@ var DEFAULT_TIMEOUT_MS = 3e4;
 function trimTrailingSlashes(url) {
   return url.replace(/\/+$/, "");
 }
+function optionalBooleanParam(value) {
+  return value === void 0 ? void 0 : String(value);
+}
+function optionalNumberParam(value) {
+  return value === void 0 ? void 0 : String(value);
+}
 function staticApiKey(key) {
   return () => ({ kind: "api-key", value: key });
 }
@@ -286,25 +293,28 @@ var ChainPatrolApiClient = class {
   }
   listOrganizationReports(input) {
     var _a, _b, _c, _d, _e;
-    return this.request("/public/getOrganizationReports", {
+    return this.requestGet("/organization/reports", {
       slug: input.slug,
-      limit: (_a = input.limit) != null ? _a : 10,
-      cursor: input.cursor,
+      limit: String((_a = input.limit) != null ? _a : 10),
+      cursor: optionalNumberParam(input.cursor),
       status: input.status,
       searchQuery: input.searchQuery,
       reporterQuery: input.reporterQuery,
-      reportedByCustomer: input.reportedByCustomer,
-      excludeAutomation: input.excludeAutomation,
-      onlyRejected: input.onlyRejected,
+      reportedByCustomer: optionalBooleanParam(input.reportedByCustomer),
+      excludeAutomation: optionalBooleanParam(input.excludeAutomation),
+      reporterKind: input.reporterKind,
+      reviewerKind: input.reviewerKind,
+      onlyRejected: optionalBooleanParam(input.onlyRejected),
       reviewStatuses: ((_b = input.reviewStatuses) == null ? void 0 : _b.length) ? input.reviewStatuses : void 0,
       assetTypes: ((_c = input.assetTypes) == null ? void 0 : _c.length) ? input.assetTypes : void 0,
-      brandIds: ((_d = input.brandIds) == null ? void 0 : _d.length) ? input.brandIds : void 0,
+      brandIds: ((_d = input.brandIds) == null ? void 0 : _d.length) ? input.brandIds.map(String) : void 0,
       countryCodes: ((_e = input.countryCodes) == null ? void 0 : _e.length) ? input.countryCodes : void 0,
-      reviewedByUserId: input.reviewedByUserId,
+      reviewedByUserId: optionalNumberParam(input.reviewedByUserId),
       startDate: parseIsoDateString(input.startDate),
       endDate: parseIsoDateString(input.endDate),
       updatedAtStartDate: parseIsoDateString(input.updatedAtStartDate),
-      updatedAtEndDate: parseIsoDateString(input.updatedAtEndDate)
+      updatedAtEndDate: parseIsoDateString(input.updatedAtEndDate),
+      needsCustomerReview: optionalBooleanParam(input.needsCustomerReview)
     });
   }
   listTakedowns(input) {
@@ -457,6 +467,7 @@ var ChainPatrolApiClient = class {
   }
 };
 
+exports.ACTOR_KINDS = ACTOR_KINDS;
 exports.ChainPatrolApiClient = ChainPatrolApiClient;
 exports.DETECTION_CONFIDENCE_LEVELS = DETECTION_CONFIDENCE_LEVELS;
 exports.DETECTION_REPORTED_FILTERS = DETECTION_REPORTED_FILTERS;