@chainpatrol/sdk 1.1.0 → 1.3.0

package/dist/index.mjs

@@ -7014,6 +7014,15 @@ var OrganizationPortalVisibility = {
   PRIVATE: "PRIVATE",
   DISABLED: "DISABLED"
 };
+var MetricsVisibility = {
+  PUBLIC: "PUBLIC",
+  PRIVATE: "PRIVATE",
+  DISABLED: "DISABLED"
+};
+var ReportVisibility = {
+  PUBLIC: "PUBLIC",
+  PRIVATE: "PRIVATE"
+};
 var AssetType = {
   URL: "URL",
   PAGE: "PAGE",
@@ -7317,10 +7326,17 @@ z.object({
   /** An array of assets with their content, type, status, and update timestamp. */
   assets: z.array(
     z.object({
+      id: z.number().describe("Asset ID \u2014 use to reference the asset in follow-up calls"),
       content: z.string().describe("Asset content"),
       type: z.nativeEnum(AssetType).describe("Asset type"),
       status: z.nativeEnum(AssetStatus).describe("The result of the asset status check"),
       watchStatus: z.nativeEnum(WatchStatus).describe("The watch status of the asset"),
+      livenessStatus: z.nativeEnum(LivenessStatus).nullable().describe(
+        "Whether the asset is currently reachable (`ALIVE`), gone (`DEAD`), or hasn't been checked (`UNKNOWN`). `null` when liveness has never been evaluated."
+      ),
+      blockedAt: z.date().nullable().describe(
+        "When the asset transitioned to BLOCKED status. `null` for non-blocked assets or blocks predating the field. Distinct from `updatedAt`, which changes on any mutation."
+      ),
       updatedAt: z.date()
     })
   ),
@@ -7750,6 +7766,12 @@ var organizationAssetItemSchema = z.object({
     id: z.number().describe("Group ID"),
     name: z.string().describe("Group name")
   }).nullable().describe("Asset group information"),
+  livenessStatus: z.nativeEnum(LivenessStatus).nullable().describe(
+    "Whether the asset is currently reachable (`ALIVE`), gone (`DEAD`), or hasn't been checked (`UNKNOWN`). `null` when liveness has never been evaluated."
+  ),
+  blockedAt: z.date().nullable().describe(
+    "When the asset transitioned to BLOCKED status. `null` for non-blocked assets. Distinct from `updatedAt`."
+  ),
   createdAt: z.date().describe("When the asset was created"),
   updatedAt: z.date().describe("When the asset was last updated")
 });
@@ -8018,6 +8040,36 @@ var UserOrgTrademarkRegistrationSchema = z.object({
     "Direct URL to view or download the certificate PDF (null when no certificate is attached)"
   )
 });
+var UserOrgBrandMetadataSchema = z.object({
+  websiteUrl: z.string().nullable().describe("Public website URL of the brand (linked from the portal header)"),
+  twitterHandle: z.string().nullable().describe(
+    "Public Twitter/X handle of the brand, stored with the leading `@` (e.g. `@acme`)"
+  ),
+  securityContactEmail: z.string().nullable().describe(
+    "Email address for security correspondence \u2014 used by takedown providers and researchers, distinct from the internal customer POC email"
+  ),
+  industry: z.string().nullable().describe('Free-form industry label (e.g. "DeFi", "CEX", "NFT", "Wallet")')
+});
+var UserOrgPortalCustomizationSchema = z.object({
+  useCustomDetails: z.boolean().describe(
+    "When true, the portal uses `name`/`slug`/`avatarUrl` from this object instead of the org's own name/slug/avatar"
+  ),
+  name: z.string().nullable().describe(
+    "Custom display name shown on the portal (used only when `useCustomDetails=true`)"
+  ),
+  slug: z.string().nullable().describe(
+    "Custom URL slug (`chainpatrol.io/<slug>`) \u2014 takes precedence over the org's own slug when set, regardless of `useCustomDetails`"
+  ),
+  avatarUrl: z.string().nullable().describe(
+    "Custom avatar URL shown on the portal (used only when `useCustomDetails=true`)"
+  ),
+  bannerEnabled: z.boolean().describe(
+    "When true, the portal renders `bannerContent` as a highlighted banner at the top of the page"
+  ),
+  bannerContent: z.string().nullable().describe(
+    "Markdown body of the portal banner. Null (or empty) with `bannerEnabled=true` means the toggle is on but no content has been written yet"
+  )
+});
 var UserOrgSchema = z.object({
   id: z.number(),
   name: z.string(),
@@ -8028,6 +8080,18 @@ var UserOrgSchema = z.object({
   portalVisibility: z.nativeEnum(OrganizationPortalVisibility).describe(
     "Visibility of the org's public security portal (chainpatrol.io/<slug>). `PUBLIC` is discoverable; `PRIVATE` renders only the report form (no metrics or listings); `DISABLED` returns a 404."
   ),
+  reportVisibility: z.nativeEnum(ReportVisibility).describe(
+    "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."
+  ),
+  metricsVisibility: z.nativeEnum(MetricsVisibility).describe(
+    "Whether the metrics/threats-blocked stats render on the public portal. `PUBLIC` shows the metrics tab; `PRIVATE` hides it from anonymous visitors; `DISABLED` doesn't compute metrics at all."
+  ),
+  brandMetadata: UserOrgBrandMetadataSchema.describe(
+    "Public brand-facing metadata (website, twitter, security contact, industry) shown on the portal and used by staff for outbound"
+  ),
+  portalCustomization: UserOrgPortalCustomizationSchema.describe(
+    "Customer-configurable presentation of the public security portal \u2014 custom name/slug/avatar and the banner content"
+  ),
   services: z.object({
     reporting: singleServiceSchema,
     reviewing: singleServiceSchema,
@@ -11920,13 +11984,25 @@ for parsing the dates.`
 var takedownItemSchema = z.object({
   id: z.number().describe("Takedown ID"),
   status: z.nativeEnum(TakedownStatus).describe("Takedown status"),
+  externalId: z.string().nullable().describe(
+    "Provider's own reference for this takedown (e.g. CleanDNS report ID, registrar ticket number). Use this to reconcile a takedown against the vendor's dashboard. `null` when no vendor has picked it up yet."
+  ),
+  hasFilingDelay: z.boolean().describe(
+    "Manually set by staff to exclude the takedown from median-time metrics when its filing was delayed for reasons unrelated to platform performance. Useful for explaining a stuck-looking takedown."
+  ),
+  hasLivenessCheckDelay: z.boolean().describe(
+    "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."
+  ),
   createdAt: z.date().describe("When the takedown was created"),
   updatedAt: z.date().describe("When the takedown was last updated"),
   asset: z.object({
     id: z.number().describe("Asset ID"),
     content: z.string().describe("Asset content (URL, handle, etc.)"),
     type: z.nativeEnum(AssetType).describe("Asset type"),
-    livenessStatus: z.nativeEnum(LivenessStatus).nullable().describe("Asset liveness status")
+    livenessStatus: z.nativeEnum(LivenessStatus).nullable().describe("Asset liveness status"),
+    blockedAt: z.date().nullable().describe(
+      "When the asset was blocked (transitioned to BLOCKED status). `null` if the asset was never blocked (rare for takedown rows). Distinct from `updatedAt`, which changes on any mutation."
+    )
   }).describe("Associated asset information"),
   assignee: z.object({
     id: z.number().describe("Assignee user ID"),
@@ -12028,6 +12104,9 @@ z.object({
       id: z.number().describe("Threat ID"),
       content: z.string().describe("Threat content"),
       type: z.nativeEnum(AssetType).describe("Asset type"),
+      livenessStatus: z.nativeEnum(LivenessStatus).nullable().describe(
+        "Whether the blocked threat is currently reachable (`ALIVE`), gone (`DEAD`), or unchecked (`UNKNOWN`). Use to filter out dead threats without a second call."
+      ),
       blockedAt: z.date().describe("When the asset was blocked")
     })
   ),