@censys/platform-sdk 0.5.0 → 0.6.0

package/src/funcs/threatHuntingGetHostObservationsWithCertificate.ts

@@ -0,0 +1,201 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get host history for a certificate
+ *
+ * @remarks
+ * Retrieve the historical observations of hosts associated with a certificate. This is useful for threat hunting, detection engineering, and timeline generation. Certificate history is also visible to Threat Hunting users in the Platform UI on the [certificate timeline](https://docs.censys.com/docs/platform-threat-hunting-use-cert-history-to-build-better-detections#/).<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. You may also filter results by port and transport protocol.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 5 credits per page of results.
+ */
+export function threatHuntingGetHostObservationsWithCertificate(
+  client: SDKCore,
+  request: operations.V3ThreathuntingGetHostObservationsWithCertificateRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.V3ThreathuntingGetHostObservationsWithCertificateResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.V3ThreathuntingGetHostObservationsWithCertificateRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.V3ThreathuntingGetHostObservationsWithCertificateResponse,
+      | errors.ErrorModel
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations
+        .V3ThreathuntingGetHostObservationsWithCertificateRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    certificate_id: encodeSimple("certificate_id", payload.certificate_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc(
+    "/v3/threat-hunting/certificate/{certificate_id}/observations/hosts",
+  )(pathParams);
+
+  const query = encodeFormQuery({
+    "end_time": payload.end_time,
+    "organization_id": payload.organization_id
+      ?? client._options.organizationId,
+    "page_size": payload.page_size,
+    "page_token": payload.page_token,
+    "port": payload.port,
+    "protocol": payload.protocol,
+    "start_time": payload.start_time,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.personalAccessToken);
+  const securityInput = secConfig == null
+    ? {}
+    : { personalAccessToken: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "v3-threathunting-get-host-observations-with-certificate",
+    oAuth2Scopes: [],
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.personalAccessToken,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "4XX", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.V3ThreathuntingGetHostObservationsWithCertificateResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations
+        .V3ThreathuntingGetHostObservationsWithCertificateResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr([401, 403], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/{globalDataGetTrackedScanThreatHunting.ts → threatHuntingGetTrackedScanThreatHunting.ts}

@@ -26,13 +26,12 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Get tracked scan details
+ * Get scan status
  *
  * @remarks
- * Retrieve the current status and results of a tracked scan by its ID.
- *         This endpoint works for both discovery scans and rescans.
+ * Retrieve the current status of a scan by its ID. This endpoint works for both [Live Discovery scans](https://docs.censys.com/reference/v3-threathunting-scans-discovery#/) and [Live Rescans](https://docs.censys.com/reference/v3-globaldata-scans-rescan#/).<br><br>If the scan was successful, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to all Enterprise customers. This endpoint does not cost any credits to execute.
  */
-export function globalDataGetTrackedScanThreatHunting(
+export function threatHuntingGetTrackedScanThreatHunting(
   client: SDKCore,
   request: operations.V3ThreathuntingScansGetRequest,
   options?: RequestOptions,

package/src/lib/config.ts

@@ -65,9 +65,9 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 
 export const SDK_METADATA = {
   language: "typescript",
-  openapiDocVersion: "1.0.24",
-  sdkVersion: "0.5.0",
-  genVersion: "2.671.2",
+  openapiDocVersion: "1.0.35",
+  sdkVersion: "0.6.0",
+  genVersion: "2.690.1",
   userAgent:
-    "speakeasy-sdk/typescript 0.5.0 2.671.2 1.0.24 @censys/platform-sdk",
+    "speakeasy-sdk/typescript 0.6.0 2.690.1 1.0.35 @censys/platform-sdk",
 } as const;

package/src/lib/security.ts

@@ -83,7 +83,10 @@ type SecurityInputOAuth2 = {
 type SecurityInputOAuth2ClientCredentials = {
   type: "oauth2:client_credentials";
   value:
-    | { clientID?: string | undefined; clientSecret?: string | undefined }
+    | {
+      clientID?: string | undefined;
+      clientSecret?: string | undefined;
+    }
     | null
     | string
     | undefined;

package/src/models/components/alternativequery.ts

@@ -0,0 +1,104 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export const Targets = {
+  Host: "host",
+  Web: "web",
+  Cert: "cert",
+  Unknown: "unknown",
+} as const;
+export type Targets = ClosedEnum<typeof Targets>;
+
+export type AlternativeQuery = {
+  /**
+   * An alternative query that may be used.
+   */
+  query: string;
+  /**
+   * The types of Platform data records (host, cert, and web) that can be targeted by the alternative query.
+   */
+  targets: Array<Targets> | null;
+};
+
+/** @internal */
+export const Targets$inboundSchema: z.ZodNativeEnum<typeof Targets> = z
+  .nativeEnum(Targets);
+
+/** @internal */
+export const Targets$outboundSchema: z.ZodNativeEnum<typeof Targets> =
+  Targets$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Targets$ {
+  /** @deprecated use `Targets$inboundSchema` instead. */
+  export const inboundSchema = Targets$inboundSchema;
+  /** @deprecated use `Targets$outboundSchema` instead. */
+  export const outboundSchema = Targets$outboundSchema;
+}
+
+/** @internal */
+export const AlternativeQuery$inboundSchema: z.ZodType<
+  AlternativeQuery,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  query: z.string(),
+  targets: z.nullable(z.array(Targets$inboundSchema)),
+});
+
+/** @internal */
+export type AlternativeQuery$Outbound = {
+  query: string;
+  targets: Array<string> | null;
+};
+
+/** @internal */
+export const AlternativeQuery$outboundSchema: z.ZodType<
+  AlternativeQuery$Outbound,
+  z.ZodTypeDef,
+  AlternativeQuery
+> = z.object({
+  query: z.string(),
+  targets: z.nullable(z.array(Targets$outboundSchema)),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AlternativeQuery$ {
+  /** @deprecated use `AlternativeQuery$inboundSchema` instead. */
+  export const inboundSchema = AlternativeQuery$inboundSchema;
+  /** @deprecated use `AlternativeQuery$outboundSchema` instead. */
+  export const outboundSchema = AlternativeQuery$outboundSchema;
+  /** @deprecated use `AlternativeQuery$Outbound` instead. */
+  export type Outbound = AlternativeQuery$Outbound;
+}
+
+export function alternativeQueryToJSON(
+  alternativeQuery: AlternativeQuery,
+): string {
+  return JSON.stringify(
+    AlternativeQuery$outboundSchema.parse(alternativeQuery),
+  );
+}
+
+export function alternativeQueryFromJSON(
+  jsonString: string,
+): SafeParseResult<AlternativeQuery, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AlternativeQuery$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AlternativeQuery' from JSON`,
+  );
+}

package/src/models/components/assetcertificatelistinputbody.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssetCertificateListInputBody = {
+  /**
+   * A list of SHA-256 certificate fingerprints.
+   */
+  certificateIds: Array<string> | null;
+};
+
+/** @internal */
+export const AssetCertificateListInputBody$inboundSchema: z.ZodType<
+  AssetCertificateListInputBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  certificate_ids: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    "certificate_ids": "certificateIds",
+  });
+});
+
+/** @internal */
+export type AssetCertificateListInputBody$Outbound = {
+  certificate_ids: Array<string> | null;
+};
+
+/** @internal */
+export const AssetCertificateListInputBody$outboundSchema: z.ZodType<
+  AssetCertificateListInputBody$Outbound,
+  z.ZodTypeDef,
+  AssetCertificateListInputBody
+> = z.object({
+  certificateIds: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    certificateIds: "certificate_ids",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssetCertificateListInputBody$ {
+  /** @deprecated use `AssetCertificateListInputBody$inboundSchema` instead. */
+  export const inboundSchema = AssetCertificateListInputBody$inboundSchema;
+  /** @deprecated use `AssetCertificateListInputBody$outboundSchema` instead. */
+  export const outboundSchema = AssetCertificateListInputBody$outboundSchema;
+  /** @deprecated use `AssetCertificateListInputBody$Outbound` instead. */
+  export type Outbound = AssetCertificateListInputBody$Outbound;
+}
+
+export function assetCertificateListInputBodyToJSON(
+  assetCertificateListInputBody: AssetCertificateListInputBody,
+): string {
+  return JSON.stringify(
+    AssetCertificateListInputBody$outboundSchema.parse(
+      assetCertificateListInputBody,
+    ),
+  );
+}
+
+export function assetCertificateListInputBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AssetCertificateListInputBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssetCertificateListInputBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssetCertificateListInputBody' from JSON`,
+  );
+}

package/src/models/components/assethostlistinputbody.ts

@@ -0,0 +1,78 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssetHostListInputBody = {
+  /**
+   * A list of host IP addresses.
+   */
+  hostIds: Array<string> | null;
+};
+
+/** @internal */
+export const AssetHostListInputBody$inboundSchema: z.ZodType<
+  AssetHostListInputBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  host_ids: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    "host_ids": "hostIds",
+  });
+});
+
+/** @internal */
+export type AssetHostListInputBody$Outbound = {
+  host_ids: Array<string> | null;
+};
+
+/** @internal */
+export const AssetHostListInputBody$outboundSchema: z.ZodType<
+  AssetHostListInputBody$Outbound,
+  z.ZodTypeDef,
+  AssetHostListInputBody
+> = z.object({
+  hostIds: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    hostIds: "host_ids",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssetHostListInputBody$ {
+  /** @deprecated use `AssetHostListInputBody$inboundSchema` instead. */
+  export const inboundSchema = AssetHostListInputBody$inboundSchema;
+  /** @deprecated use `AssetHostListInputBody$outboundSchema` instead. */
+  export const outboundSchema = AssetHostListInputBody$outboundSchema;
+  /** @deprecated use `AssetHostListInputBody$Outbound` instead. */
+  export type Outbound = AssetHostListInputBody$Outbound;
+}
+
+export function assetHostListInputBodyToJSON(
+  assetHostListInputBody: AssetHostListInputBody,
+): string {
+  return JSON.stringify(
+    AssetHostListInputBody$outboundSchema.parse(assetHostListInputBody),
+  );
+}
+
+export function assetHostListInputBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AssetHostListInputBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssetHostListInputBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssetHostListInputBody' from JSON`,
+  );
+}

package/src/models/components/assetwebpropertylistinputbody.ts

@@ -0,0 +1,80 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AssetWebpropertyListInputBody = {
+  /**
+   * A list of web property identifiers.
+   */
+  webpropertyIds: Array<string> | null;
+};
+
+/** @internal */
+export const AssetWebpropertyListInputBody$inboundSchema: z.ZodType<
+  AssetWebpropertyListInputBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  webproperty_ids: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    "webproperty_ids": "webpropertyIds",
+  });
+});
+
+/** @internal */
+export type AssetWebpropertyListInputBody$Outbound = {
+  webproperty_ids: Array<string> | null;
+};
+
+/** @internal */
+export const AssetWebpropertyListInputBody$outboundSchema: z.ZodType<
+  AssetWebpropertyListInputBody$Outbound,
+  z.ZodTypeDef,
+  AssetWebpropertyListInputBody
+> = z.object({
+  webpropertyIds: z.nullable(z.array(z.string())),
+}).transform((v) => {
+  return remap$(v, {
+    webpropertyIds: "webproperty_ids",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AssetWebpropertyListInputBody$ {
+  /** @deprecated use `AssetWebpropertyListInputBody$inboundSchema` instead. */
+  export const inboundSchema = AssetWebpropertyListInputBody$inboundSchema;
+  /** @deprecated use `AssetWebpropertyListInputBody$outboundSchema` instead. */
+  export const outboundSchema = AssetWebpropertyListInputBody$outboundSchema;
+  /** @deprecated use `AssetWebpropertyListInputBody$Outbound` instead. */
+  export type Outbound = AssetWebpropertyListInputBody$Outbound;
+}
+
+export function assetWebpropertyListInputBodyToJSON(
+  assetWebpropertyListInputBody: AssetWebpropertyListInputBody,
+): string {
+  return JSON.stringify(
+    AssetWebpropertyListInputBody$outboundSchema.parse(
+      assetWebpropertyListInputBody,
+    ),
+  );
+}
+
+export function assetWebpropertyListInputBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<AssetWebpropertyListInputBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AssetWebpropertyListInputBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AssetWebpropertyListInputBody' from JSON`,
+  );
+}

package/src/models/components/asteriskmanagerinterface.ts

@@ -0,0 +1,66 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type AsteriskManagerInterface = {
+  version?: string | undefined;
+};
+
+/** @internal */
+export const AsteriskManagerInterface$inboundSchema: z.ZodType<
+  AsteriskManagerInterface,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  version: z.string().optional(),
+});
+
+/** @internal */
+export type AsteriskManagerInterface$Outbound = {
+  version?: string | undefined;
+};
+
+/** @internal */
+export const AsteriskManagerInterface$outboundSchema: z.ZodType<
+  AsteriskManagerInterface$Outbound,
+  z.ZodTypeDef,
+  AsteriskManagerInterface
+> = z.object({
+  version: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AsteriskManagerInterface$ {
+  /** @deprecated use `AsteriskManagerInterface$inboundSchema` instead. */
+  export const inboundSchema = AsteriskManagerInterface$inboundSchema;
+  /** @deprecated use `AsteriskManagerInterface$outboundSchema` instead. */
+  export const outboundSchema = AsteriskManagerInterface$outboundSchema;
+  /** @deprecated use `AsteriskManagerInterface$Outbound` instead. */
+  export type Outbound = AsteriskManagerInterface$Outbound;
+}
+
+export function asteriskManagerInterfaceToJSON(
+  asteriskManagerInterface: AsteriskManagerInterface,
+): string {
+  return JSON.stringify(
+    AsteriskManagerInterface$outboundSchema.parse(asteriskManagerInterface),
+  );
+}
+
+export function asteriskManagerInterfaceFromJSON(
+  jsonString: string,
+): SafeParseResult<AsteriskManagerInterface, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AsteriskManagerInterface$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AsteriskManagerInterface' from JSON`,
+  );
+}