@censys/platform-sdk 0.10.0 → 0.10.2

package/src/models/operations/v3threathuntingcenseyejobsget.ts

@@ -0,0 +1,87 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 V3ThreathuntingCenseyeJobsGetGlobals = {
+  organizationId?: string | undefined;
+};
+
+export type V3ThreathuntingCenseyeJobsGetRequest = {
+  /**
+   * 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-find-and-use-your-organization-id-optional) for more information.
+   */
+  organizationId?: string | undefined;
+  /**
+   * The unique identifier of the CensEye job.
+   */
+  jobId: string;
+};
+
+export type V3ThreathuntingCenseyeJobsGetResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeCenseyeJob;
+};
+
+/** @internal */
+export type V3ThreathuntingCenseyeJobsGetRequest$Outbound = {
+  organization_id?: string | undefined;
+  job_id: string;
+};
+
+/** @internal */
+export const V3ThreathuntingCenseyeJobsGetRequest$outboundSchema: z.ZodType<
+  V3ThreathuntingCenseyeJobsGetRequest$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingCenseyeJobsGetRequest
+> = z.object({
+  organizationId: z.string().optional(),
+  jobId: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    jobId: "job_id",
+  });
+});
+
+export function v3ThreathuntingCenseyeJobsGetRequestToJSON(
+  v3ThreathuntingCenseyeJobsGetRequest: V3ThreathuntingCenseyeJobsGetRequest,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingCenseyeJobsGetRequest$outboundSchema.parse(
+      v3ThreathuntingCenseyeJobsGetRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingCenseyeJobsGetResponse$inboundSchema: z.ZodType<
+  V3ThreathuntingCenseyeJobsGetResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.ResponseEnvelopeCenseyeJob$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function v3ThreathuntingCenseyeJobsGetResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingCenseyeJobsGetResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingCenseyeJobsGetResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingCenseyeJobsGetResponse' from JSON`,
+  );
+}

package/src/sdk/globaldata.ts

@@ -15,6 +15,7 @@ import { globalDataGetHostTimeline } from "../funcs/globalDataGetHostTimeline.js
 import { globalDataGetTrackedScan } from "../funcs/globalDataGetTrackedScan.js";
 import { globalDataGetWebProperties } from "../funcs/globalDataGetWebProperties.js";
 import { globalDataGetWebProperty } from "../funcs/globalDataGetWebProperty.js";
+import { globalDataListServicesOnHost } from "../funcs/globalDataListServicesOnHost.js";
 import { globalDataSearch } from "../funcs/globalDataSearch.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
@@ -123,6 +124,23 @@ export class GlobalData extends ClientSDK {
     ));
   }
 
+  /**
+   * Get service history for a host
+   *
+   * @remarks
+   * Retrieve historical service observations for a host. This endpoint returns time ranges during which services were detected on the host.<br><br>You can define a specific time frame of interest. If you do not specify a time frame, this endpoint will search the historical dataset that is available to your account.<br><br>You can filter by port number, protocol, and transport protocol.
+   */
+  async listServicesOnHost(
+    request: operations.V3GlobaldataServiceOnHostRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3GlobaldataServiceOnHostResponse> {
+    return unwrapAsync(globalDataListServicesOnHost(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get host event history
    *

package/src/sdk/threathunting.ts

@@ -2,7 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+import { threatHuntingCreateCenseyeJob } from "../funcs/threatHuntingCreateCenseyeJob.js";
 import { threatHuntingCreateTrackedScan } from "../funcs/threatHuntingCreateTrackedScan.js";
+import { threatHuntingGetCenseyeJob } from "../funcs/threatHuntingGetCenseyeJob.js";
+import { threatHuntingGetCenseyeJobResults } from "../funcs/threatHuntingGetCenseyeJobResults.js";
 import { threatHuntingGetHostObservationsWithCertificate } from "../funcs/threatHuntingGetHostObservationsWithCertificate.js";
 import { threatHuntingGetTrackedScanThreatHunting } from "../funcs/threatHuntingGetTrackedScanThreatHunting.js";
 import { threatHuntingListThreats } from "../funcs/threatHuntingListThreats.js";
@@ -12,6 +15,57 @@ import * as operations from "../models/operations/index.js";
 import { unwrapAsync } from "../types/fp.js";
 
 export class ThreatHunting extends ClientSDK {
+  /**
+   * CensEye: Create a pivot analysis job
+   *
+   * @remarks
+   * Create an asynchronous CensEye pivot analysis job for a host, web property, or certificate. The job extracts [default pivot fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) from the target asset and counts matching documents for each field-value pair. Poll the job status endpoint to track progress, then retrieve results when complete.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.<br><br>This endpoint costs 44 credits to execute for a host, 28 credits to execute for a web property, and 7 credits to execute for a certificate.
+   */
+  async createCenseyeJob(
+    request: operations.V3ThreathuntingCenseyeJobsCreateRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingCenseyeJobsCreateResponse> {
+    return unwrapAsync(threatHuntingCreateCenseyeJob(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * CensEye: Get job status
+   *
+   * @remarks
+   * Retrieve the current status of a CensEye pivot analysis job. Use this to poll for completion before fetching results.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.
+   */
+  async getCenseyeJob(
+    request: operations.V3ThreathuntingCenseyeJobsGetRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingCenseyeJobsGetResponse> {
+    return unwrapAsync(threatHuntingGetCenseyeJob(
+      this,
+      request,
+      options,
+    ));
+  }
+
+  /**
+   * CensEye: Get job results
+   *
+   * @remarks
+   * Retrieve the results of a completed CensEye pivot analysis job. Each result contains a count and the field-value pairs that were analyzed. Results may be empty if the job is still running.<br><br>Results are paginated. Use the `next_page_token` from the response to fetch subsequent pages.<br><br>To use this endpoint, your organization must have access to the Threat Hunting module.
+   */
+  async getCenseyeJobResults(
+    request: operations.V3ThreathuntingCenseyeJobResultsRequest,
+    options?: RequestOptions,
+  ): Promise<operations.V3ThreathuntingCenseyeJobResultsResponse> {
+    return unwrapAsync(threatHuntingGetCenseyeJobResults(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Get host history for a certificate
    *
@@ -87,7 +141,7 @@ export class ThreatHunting extends ClientSDK {
    * CensEye: Retrieve value counts to discover pivots
    *
    * @remarks
-   * Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country=”United States”` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Threat Hunting Module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
+   * Get counts of web assets for specific field-value pairs and combinations of field-value pairs. This is similar to the [CensEye functionality](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#/) available in the Platform web UI, but it allows you to define specific fields of interest rather than the [default fields](https://docs.censys.com/docs/platform-threat-hunting-use-censeye-to-build-detections#default-pivot-fields) leveraged by the tool in the UI.<br><br>Each array can only target fields within the same nested object and may contain at most 5 field-value pairs. For example, you can combine `host.services.port=80` and `host.services.protocol=SSH` in the same array, but you cannot combine `host.services.port=80` and `host.location.country="United States"` in the same array. You can input multiple arrays of objects in each API call.<br><br>To use this endpoint, your organization must have access to the Threat Hunting Module. This endpoint costs 1 credit per count condition (array of objects) included in the API call.
    */
   async valueCounts(
     request: operations.V3ThreathuntingValueCountsRequest,