@censys/platform-sdk 0.4.3 → 0.5.1

package/src/models/operations/v3threathuntingscansget.ts

@@ -0,0 +1,232 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V3ThreathuntingScansGetGlobals = {
+  organizationId?: string | undefined;
+};
+
+export type V3ThreathuntingScansGetRequest = {
+  /**
+   * The ID of a Censys organization to associate the request with. See the [Getting Started docs](https://docs.censys.com/reference/get-started#step-3-set-your-organization-id) for more information.
+   */
+  organizationId?: string | undefined;
+  /**
+   * The unique identifier of the tracked scan
+   */
+  scanId: string;
+};
+
+export type V3ThreathuntingScansGetResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeTrackedScan;
+};
+
+/** @internal */
+export const V3ThreathuntingScansGetGlobals$inboundSchema: z.ZodType<
+  V3ThreathuntingScansGetGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organization_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+  });
+});
+
+/** @internal */
+export type V3ThreathuntingScansGetGlobals$Outbound = {
+  organization_id?: string | undefined;
+};
+
+/** @internal */
+export const V3ThreathuntingScansGetGlobals$outboundSchema: z.ZodType<
+  V3ThreathuntingScansGetGlobals$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansGetGlobals
+> = z.object({
+  organizationId: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V3ThreathuntingScansGetGlobals$ {
+  /** @deprecated use `V3ThreathuntingScansGetGlobals$inboundSchema` instead. */
+  export const inboundSchema = V3ThreathuntingScansGetGlobals$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetGlobals$outboundSchema` instead. */
+  export const outboundSchema = V3ThreathuntingScansGetGlobals$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetGlobals$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansGetGlobals$Outbound;
+}
+
+export function v3ThreathuntingScansGetGlobalsToJSON(
+  v3ThreathuntingScansGetGlobals: V3ThreathuntingScansGetGlobals,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansGetGlobals$outboundSchema.parse(
+      v3ThreathuntingScansGetGlobals,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansGetGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansGetGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V3ThreathuntingScansGetGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansGetGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingScansGetRequest$inboundSchema: z.ZodType<
+  V3ThreathuntingScansGetRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organization_id: z.string().optional(),
+  scan_id: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "scan_id": "scanId",
+  });
+});
+
+/** @internal */
+export type V3ThreathuntingScansGetRequest$Outbound = {
+  organization_id?: string | undefined;
+  scan_id: string;
+};
+
+/** @internal */
+export const V3ThreathuntingScansGetRequest$outboundSchema: z.ZodType<
+  V3ThreathuntingScansGetRequest$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansGetRequest
+> = z.object({
+  organizationId: z.string().optional(),
+  scanId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    scanId: "scan_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V3ThreathuntingScansGetRequest$ {
+  /** @deprecated use `V3ThreathuntingScansGetRequest$inboundSchema` instead. */
+  export const inboundSchema = V3ThreathuntingScansGetRequest$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetRequest$outboundSchema` instead. */
+  export const outboundSchema = V3ThreathuntingScansGetRequest$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetRequest$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansGetRequest$Outbound;
+}
+
+export function v3ThreathuntingScansGetRequestToJSON(
+  v3ThreathuntingScansGetRequest: V3ThreathuntingScansGetRequest,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansGetRequest$outboundSchema.parse(
+      v3ThreathuntingScansGetRequest,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansGetRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansGetRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V3ThreathuntingScansGetRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansGetRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingScansGetResponse$inboundSchema: z.ZodType<
+  V3ThreathuntingScansGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())),
+  Result: components.ResponseEnvelopeTrackedScan$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+/** @internal */
+export type V3ThreathuntingScansGetResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.ResponseEnvelopeTrackedScan$Outbound;
+};
+
+/** @internal */
+export const V3ThreathuntingScansGetResponse$outboundSchema: z.ZodType<
+  V3ThreathuntingScansGetResponse$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansGetResponse
+> = z.object({
+  headers: z.record(z.array(z.string())),
+  result: components.ResponseEnvelopeTrackedScan$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    headers: "Headers",
+    result: "Result",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V3ThreathuntingScansGetResponse$ {
+  /** @deprecated use `V3ThreathuntingScansGetResponse$inboundSchema` instead. */
+  export const inboundSchema = V3ThreathuntingScansGetResponse$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetResponse$outboundSchema` instead. */
+  export const outboundSchema = V3ThreathuntingScansGetResponse$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansGetResponse$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansGetResponse$Outbound;
+}
+
+export function v3ThreathuntingScansGetResponseToJSON(
+  v3ThreathuntingScansGetResponse: V3ThreathuntingScansGetResponse,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansGetResponse$outboundSchema.parse(
+      v3ThreathuntingScansGetResponse,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V3ThreathuntingScansGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansGetResponse' from JSON`,
+  );
+}

package/src/sdk/globaldata.ts

@@ -3,11 +3,14 @@
  */
 
 import { globalDataAggregate } from "../funcs/globalDataAggregate.js";
+import { globalDataCreateTrackedScan } from "../funcs/globalDataCreateTrackedScan.js";
 import { globalDataGetCertificate } from "../funcs/globalDataGetCertificate.js";
 import { globalDataGetCertificates } from "../funcs/globalDataGetCertificates.js";
 import { globalDataGetHost } from "../funcs/globalDataGetHost.js";
 import { globalDataGetHosts } from "../funcs/globalDataGetHosts.js";
 import { globalDataGetHostTimeline } from "../funcs/globalDataGetHostTimeline.js";
+import { globalDataGetTrackedScan } from "../funcs/globalDataGetTrackedScan.js";
+import { globalDataGetTrackedScanThreatHunting } from "../funcs/globalDataGetTrackedScanThreatHunting.js";
 import { globalDataGetWebProperties } from "../funcs/globalDataGetWebProperties.js";
 import { globalDataGetWebProperty } from "../funcs/globalDataGetWebProperty.js";
 import { globalDataSearch } from "../funcs/globalDataSearch.js";
@@ -135,6 +138,41 @@ export class GlobalData extends ClientSDK {
     ));
   }
 
+  /**
+   * Create a tracked rescan
+   *
+   * @remarks
+   * Create a new tracked rescan for a known service or web property. Rescans are used to update information for previously discovered targets. The scan will be queued. The response will contain a scan ID that you can use with the [get tracked scan details endpoint](https://docs.censys.com/reference/v3-globaldata-scans-get#/) to monitor its status and results.<br><br>This endpoint is available to all Enterprise customers.
+   */
+  async createTrackedScan(
+    request: operations.V3GlobaldataScansRescanRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3GlobaldataScansRescanResponse> {
+    return unwrapAsync(globalDataCreateTrackedScan(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get tracked scan details
+   *
+   * @remarks
+   * Retrieve the current status and results of a tracked scan by its ID.
+   *         This endpoint works for both discovery scans and rescans.
+   */
+  async getTrackedScan(
+    request: operations.V3GlobaldataScansGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3GlobaldataScansGetResponse> {
+    return unwrapAsync(globalDataGetTrackedScan(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Aggregate results for a search query
    *
@@ -168,4 +206,22 @@ export class GlobalData extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Get tracked scan details
+   *
+   * @remarks
+   * Retrieve the current status and results of a tracked scan by its ID.
+   *         This endpoint works for both discovery scans and rescans.
+   */
+  async getTrackedScanThreatHunting(
+    request: operations.V3ThreathuntingScansGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingScansGetResponse> {
+    return unwrapAsync(globalDataGetTrackedScanThreatHunting(
+      this,
+      request,
+      options,
+    ));
+  }
 }

package/src/sdk/threathunting.ts

@@ -2,12 +2,89 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { globalDataGetTrackedScan } from "../funcs/globalDataGetTrackedScan.js";
+import { globalDataGetTrackedScanThreatHunting } from "../funcs/globalDataGetTrackedScanThreatHunting.js";
+import { threatHuntingCreateTrackedScan } from "../funcs/threatHuntingCreateTrackedScan.js";
+import { threatHuntingGetHostObservationsWithCertificate } from "../funcs/threatHuntingGetHostObservationsWithCertificate.js";
 import { threatHuntingValueCounts } from "../funcs/threatHuntingValueCounts.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class ThreatHunting extends ClientSDK {
+  /**
+   * Get tracked scan details
+   *
+   * @remarks
+   * Retrieve the current status and results of a tracked scan by its ID.
+   *         This endpoint works for both discovery scans and rescans.
+   */
+  async getTrackedScan(
+    request: operations.V3GlobaldataScansGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3GlobaldataScansGetResponse> {
+    return unwrapAsync(globalDataGetTrackedScan(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get Host Observations With Certificate
+   *
+   * @remarks
+   * Retrieve historical observations of hosts associated with a certificate fingerprint. Useful for threat hunting, detection engineering, and timeline generation.
+   */
+  async getHostObservationsWithCertificate(
+    request:
+      operations.V3ThreathuntingGetHostObservationsWithCertificateRequest,
+    options?: RequestOptions,
+  ): Promise<
+    operations.V3ThreathuntingGetHostObservationsWithCertificateResponse
+  > {
+    return unwrapAsync(threatHuntingGetHostObservationsWithCertificate(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Create a tracked discovery scan
+   *
+   * @remarks
+   * Create a new tracked discovery scan for a specified target. Discovery scans are used to scan new targets that have not been previously identified. The scan will be queued. The response will contain a scan ID that you can use with the [get tracked scan details endpoint](https://docs.censys.com/reference/v3-globaldata-scans-get#/) to monitor its status and results.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
+   */
+  async createTrackedScan(
+    request: operations.V3ThreathuntingScansDiscoveryRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingScansDiscoveryResponse> {
+    return unwrapAsync(threatHuntingCreateTrackedScan(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * Get tracked scan details
+   *
+   * @remarks
+   * Retrieve the current status and results of a tracked scan by its ID.
+   *         This endpoint works for both discovery scans and rescans.
+   */
+  async getTrackedScanThreatHunting(
+    request: operations.V3ThreathuntingScansGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingScansGetResponse> {
+    return unwrapAsync(globalDataGetTrackedScanThreatHunting(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * CensEye: Retrieve value counts to discover pivots
    *