@censys/platform-sdk 0.4.3 → 0.5.0

package/src/funcs/globalDataGetTrackedScanThreatHunting.ts

@@ -0,0 +1,191 @@
+/*
+ * 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 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.
+ */
+export function globalDataGetTrackedScanThreatHunting(
+  client: SDKCore,
+  request: operations.V3ThreathuntingScansGetRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.V3ThreathuntingScansGetResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.V3ThreathuntingScansGetRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.V3ThreathuntingScansGetResponse,
+      | errors.ErrorModel
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V3ThreathuntingScansGetRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    scan_id: encodeSimple("scan_id", payload.scan_id, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v3/threat-hunting/scans/{scan_id}")(pathParams);
+
+  const query = encodeFormQuery({
+    "organization_id": payload.organization_id
+      ?? client._options.organizationId,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/vnd.censys.api.v3.trackedscan.v1+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-scans-get",
+    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.V3ThreathuntingScansGetResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.V3ThreathuntingScansGetResponse$inboundSchema, {
+      ctype: "application/vnd.censys.api.v3.trackedscan.v1+json",
+      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/threatHuntingCreateTrackedScan.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery, encodeJSON } 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";
+
+/**
+ * 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.
+ */
+export function threatHuntingCreateTrackedScan(
+  client: SDKCore,
+  request: operations.V3ThreathuntingScansDiscoveryRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.V3ThreathuntingScansDiscoveryResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.V3ThreathuntingScansDiscoveryRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.V3ThreathuntingScansDiscoveryResponse,
+      | errors.ErrorModel
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V3ThreathuntingScansDiscoveryRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.ScansDiscoveryInputBody, {
+    explode: true,
+  });
+
+  const path = pathToFunc("/v3/threat-hunting/scans/discovery")();
+
+  const query = encodeFormQuery({
+    "organization_id": payload.organization_id
+      ?? client._options.organizationId,
+  }, { explode: false });
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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-scans-discovery",
+    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: "POST",
+    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.V3ThreathuntingScansDiscoveryResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.V3ThreathuntingScansDiscoveryResponse$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/lib/config.ts

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

package/src/models/components/elasticsearch.ts

@@ -7,6 +7,12 @@ 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";
+import {
+  ElasticSearchErrorMessage,
+  ElasticSearchErrorMessage$inboundSchema,
+  ElasticSearchErrorMessage$Outbound,
+  ElasticSearchErrorMessage$outboundSchema,
+} from "./elasticsearcherrormessage.js";
 import {
   ElasticSearchResultsNodeInfo,
   ElasticSearchResultsNodeInfo$inboundSchema,
@@ -21,6 +27,7 @@ import {
 } from "./elasticsearchsysteminfo.js";
 
 export type ElasticSearch = {
+  errorMessage?: ElasticSearchErrorMessage | undefined;
   resultsNodeInfo?: ElasticSearchResultsNodeInfo | undefined;
   systemInfo?: ElasticSearchSystemInfo | undefined;
 };
@@ -31,10 +38,12 @@ export const ElasticSearch$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  error_message: ElasticSearchErrorMessage$inboundSchema.optional(),
   results_node_info: ElasticSearchResultsNodeInfo$inboundSchema.optional(),
   system_info: ElasticSearchSystemInfo$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
+    "error_message": "errorMessage",
     "results_node_info": "resultsNodeInfo",
     "system_info": "systemInfo",
   });
@@ -42,6 +51,7 @@ export const ElasticSearch$inboundSchema: z.ZodType<
 
 /** @internal */
 export type ElasticSearch$Outbound = {
+  error_message?: ElasticSearchErrorMessage$Outbound | undefined;
   results_node_info?: ElasticSearchResultsNodeInfo$Outbound | undefined;
   system_info?: ElasticSearchSystemInfo$Outbound | undefined;
 };
@@ -52,10 +62,12 @@ export const ElasticSearch$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ElasticSearch
 > = z.object({
+  errorMessage: ElasticSearchErrorMessage$outboundSchema.optional(),
   resultsNodeInfo: ElasticSearchResultsNodeInfo$outboundSchema.optional(),
   systemInfo: ElasticSearchSystemInfo$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
+    errorMessage: "error_message",
     resultsNodeInfo: "results_node_info",
     systemInfo: "system_info",
   });

package/src/models/components/elasticsearcherrormessage.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 ElasticSearchErrorMessage = {
+  header?: string | undefined;
+  reason?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const ElasticSearchErrorMessage$inboundSchema: z.ZodType<
+  ElasticSearchErrorMessage,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  header: z.string().optional(),
+  reason: z.string().optional(),
+  type: z.string().optional(),
+});
+
+/** @internal */
+export type ElasticSearchErrorMessage$Outbound = {
+  header?: string | undefined;
+  reason?: string | undefined;
+  type?: string | undefined;
+};
+
+/** @internal */
+export const ElasticSearchErrorMessage$outboundSchema: z.ZodType<
+  ElasticSearchErrorMessage$Outbound,
+  z.ZodTypeDef,
+  ElasticSearchErrorMessage
+> = z.object({
+  header: z.string().optional(),
+  reason: z.string().optional(),
+  type: 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 ElasticSearchErrorMessage$ {
+  /** @deprecated use `ElasticSearchErrorMessage$inboundSchema` instead. */
+  export const inboundSchema = ElasticSearchErrorMessage$inboundSchema;
+  /** @deprecated use `ElasticSearchErrorMessage$outboundSchema` instead. */
+  export const outboundSchema = ElasticSearchErrorMessage$outboundSchema;
+  /** @deprecated use `ElasticSearchErrorMessage$Outbound` instead. */
+  export type Outbound = ElasticSearchErrorMessage$Outbound;
+}
+
+export function elasticSearchErrorMessageToJSON(
+  elasticSearchErrorMessage: ElasticSearchErrorMessage,
+): string {
+  return JSON.stringify(
+    ElasticSearchErrorMessage$outboundSchema.parse(elasticSearchErrorMessage),
+  );
+}
+
+export function elasticSearchErrorMessageFromJSON(
+  jsonString: string,
+): SafeParseResult<ElasticSearchErrorMessage, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ElasticSearchErrorMessage$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ElasticSearchErrorMessage' from JSON`,
+  );
+}

package/src/models/components/hostobservationrange.ts

@@ -0,0 +1,99 @@
+/*
+ * 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 HostObservationRange = {
+  endTime: Date;
+  ip: string;
+  port: number;
+  protocols: Array<string> | null;
+  startTime: Date;
+  transportProtocol: string;
+};
+
+/** @internal */
+export const HostObservationRange$inboundSchema: z.ZodType<
+  HostObservationRange,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  end_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ip: z.string(),
+  port: z.number().int(),
+  protocols: z.nullable(z.array(z.string())),
+  start_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  transport_protocol: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "end_time": "endTime",
+    "start_time": "startTime",
+    "transport_protocol": "transportProtocol",
+  });
+});
+
+/** @internal */
+export type HostObservationRange$Outbound = {
+  end_time: string;
+  ip: string;
+  port: number;
+  protocols: Array<string> | null;
+  start_time: string;
+  transport_protocol: string;
+};
+
+/** @internal */
+export const HostObservationRange$outboundSchema: z.ZodType<
+  HostObservationRange$Outbound,
+  z.ZodTypeDef,
+  HostObservationRange
+> = z.object({
+  endTime: z.date().transform(v => v.toISOString()),
+  ip: z.string(),
+  port: z.number().int(),
+  protocols: z.nullable(z.array(z.string())),
+  startTime: z.date().transform(v => v.toISOString()),
+  transportProtocol: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    endTime: "end_time",
+    startTime: "start_time",
+    transportProtocol: "transport_protocol",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace HostObservationRange$ {
+  /** @deprecated use `HostObservationRange$inboundSchema` instead. */
+  export const inboundSchema = HostObservationRange$inboundSchema;
+  /** @deprecated use `HostObservationRange$outboundSchema` instead. */
+  export const outboundSchema = HostObservationRange$outboundSchema;
+  /** @deprecated use `HostObservationRange$Outbound` instead. */
+  export type Outbound = HostObservationRange$Outbound;
+}
+
+export function hostObservationRangeToJSON(
+  hostObservationRange: HostObservationRange,
+): string {
+  return JSON.stringify(
+    HostObservationRange$outboundSchema.parse(hostObservationRange),
+  );
+}
+
+export function hostObservationRangeFromJSON(
+  jsonString: string,
+): SafeParseResult<HostObservationRange, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => HostObservationRange$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'HostObservationRange' from JSON`,
+  );
+}