@censys/platform-sdk 0.4.3 → 0.5.1

package/src/models/operations/v3threathuntinggethostobservationswithcertificate.ts

@@ -0,0 +1,315 @@
+/*
+ * 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 V3ThreathuntingGetHostObservationsWithCertificateGlobals = {
+  organizationId?: string | undefined;
+};
+
+export type V3ThreathuntingGetHostObservationsWithCertificateRequest = {
+  /**
+   * 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;
+  /**
+   * SHA-256 hash of the certificate
+   */
+  certificateId: string;
+  /**
+   * Only show ranges ending at or after this time (ISO 8601)
+   */
+  startTime?: string | undefined;
+  /**
+   * Only show ranges starting at or before this time (ISO 8601)
+   */
+  endTime?: string | undefined;
+  /**
+   * The port to filter by
+   */
+  port?: number | undefined;
+  /**
+   * The transport protocol to filter by
+   */
+  protocol?: string | undefined;
+  /**
+   * Pagination token from previous response to retrieve next page of results
+   */
+  pageToken?: string | undefined;
+  /**
+   * Number of results per page. Maximum 100, defaults to 100 if not specified
+   */
+  pageSize?: number | undefined;
+};
+
+export type V3ThreathuntingGetHostObservationsWithCertificateResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeHostObservationResponse;
+};
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateGlobals$inboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    organization_id: z.string().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+    });
+  });
+
+/** @internal */
+export type V3ThreathuntingGetHostObservationsWithCertificateGlobals$Outbound =
+  {
+    organization_id?: string | undefined;
+  };
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateGlobals$outboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals$Outbound,
+    z.ZodTypeDef,
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals
+  > = 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 V3ThreathuntingGetHostObservationsWithCertificateGlobals$ {
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateGlobals$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals$inboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateGlobals$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals$outboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateGlobals$Outbound` instead. */
+  export type Outbound =
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals$Outbound;
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateGlobalsToJSON(
+  v3ThreathuntingGetHostObservationsWithCertificateGlobals:
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingGetHostObservationsWithCertificateGlobals$outboundSchema
+      .parse(v3ThreathuntingGetHostObservationsWithCertificateGlobals),
+  );
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  V3ThreathuntingGetHostObservationsWithCertificateGlobals,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingGetHostObservationsWithCertificateGlobals$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingGetHostObservationsWithCertificateGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateRequest$inboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateRequest,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    organization_id: z.string().optional(),
+    certificate_id: z.string(),
+    start_time: z.string().optional(),
+    end_time: z.string().optional(),
+    port: z.number().int().optional(),
+    protocol: z.string().optional(),
+    page_token: z.string().optional(),
+    page_size: z.number().int().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      "organization_id": "organizationId",
+      "certificate_id": "certificateId",
+      "start_time": "startTime",
+      "end_time": "endTime",
+      "page_token": "pageToken",
+      "page_size": "pageSize",
+    });
+  });
+
+/** @internal */
+export type V3ThreathuntingGetHostObservationsWithCertificateRequest$Outbound =
+  {
+    organization_id?: string | undefined;
+    certificate_id: string;
+    start_time?: string | undefined;
+    end_time?: string | undefined;
+    port?: number | undefined;
+    protocol?: string | undefined;
+    page_token?: string | undefined;
+    page_size?: number | undefined;
+  };
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateRequest$outboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateRequest$Outbound,
+    z.ZodTypeDef,
+    V3ThreathuntingGetHostObservationsWithCertificateRequest
+  > = z.object({
+    organizationId: z.string().optional(),
+    certificateId: z.string(),
+    startTime: z.string().optional(),
+    endTime: z.string().optional(),
+    port: z.number().int().optional(),
+    protocol: z.string().optional(),
+    pageToken: z.string().optional(),
+    pageSize: z.number().int().optional(),
+  }).transform((v) => {
+    return remap$(v, {
+      organizationId: "organization_id",
+      certificateId: "certificate_id",
+      startTime: "start_time",
+      endTime: "end_time",
+      pageToken: "page_token",
+      pageSize: "page_size",
+    });
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V3ThreathuntingGetHostObservationsWithCertificateRequest$ {
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateRequest$inboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateRequest$outboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateRequest$Outbound` instead. */
+  export type Outbound =
+    V3ThreathuntingGetHostObservationsWithCertificateRequest$Outbound;
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateRequestToJSON(
+  v3ThreathuntingGetHostObservationsWithCertificateRequest:
+    V3ThreathuntingGetHostObservationsWithCertificateRequest,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingGetHostObservationsWithCertificateRequest$outboundSchema
+      .parse(v3ThreathuntingGetHostObservationsWithCertificateRequest),
+  );
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  V3ThreathuntingGetHostObservationsWithCertificateRequest,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingGetHostObservationsWithCertificateRequest$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingGetHostObservationsWithCertificateRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateResponse$inboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateResponse,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    Headers: z.record(z.array(z.string())),
+    Result: components.ResponseEnvelopeHostObservationResponse$inboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      "Headers": "headers",
+      "Result": "result",
+    });
+  });
+
+/** @internal */
+export type V3ThreathuntingGetHostObservationsWithCertificateResponse$Outbound =
+  {
+    Headers: { [k: string]: Array<string> };
+    Result: components.ResponseEnvelopeHostObservationResponse$Outbound;
+  };
+
+/** @internal */
+export const V3ThreathuntingGetHostObservationsWithCertificateResponse$outboundSchema:
+  z.ZodType<
+    V3ThreathuntingGetHostObservationsWithCertificateResponse$Outbound,
+    z.ZodTypeDef,
+    V3ThreathuntingGetHostObservationsWithCertificateResponse
+  > = z.object({
+    headers: z.record(z.array(z.string())),
+    result: components.ResponseEnvelopeHostObservationResponse$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 V3ThreathuntingGetHostObservationsWithCertificateResponse$ {
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateResponse$inboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingGetHostObservationsWithCertificateResponse$outboundSchema;
+  /** @deprecated use `V3ThreathuntingGetHostObservationsWithCertificateResponse$Outbound` instead. */
+  export type Outbound =
+    V3ThreathuntingGetHostObservationsWithCertificateResponse$Outbound;
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateResponseToJSON(
+  v3ThreathuntingGetHostObservationsWithCertificateResponse:
+    V3ThreathuntingGetHostObservationsWithCertificateResponse,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingGetHostObservationsWithCertificateResponse$outboundSchema
+      .parse(v3ThreathuntingGetHostObservationsWithCertificateResponse),
+  );
+}
+
+export function v3ThreathuntingGetHostObservationsWithCertificateResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  V3ThreathuntingGetHostObservationsWithCertificateResponse,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingGetHostObservationsWithCertificateResponse$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingGetHostObservationsWithCertificateResponse' from JSON`,
+  );
+}

package/src/models/operations/v3threathuntingscansdiscovery.ts

@@ -0,0 +1,238 @@
+/*
+ * 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 V3ThreathuntingScansDiscoveryGlobals = {
+  organizationId?: string | undefined;
+};
+
+export type V3ThreathuntingScansDiscoveryRequest = {
+  /**
+   * 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;
+  scansDiscoveryInputBody: components.ScansDiscoveryInputBody;
+};
+
+export type V3ThreathuntingScansDiscoveryResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeTrackedScan;
+};
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryGlobals$inboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryGlobals,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organization_id: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+  });
+});
+
+/** @internal */
+export type V3ThreathuntingScansDiscoveryGlobals$Outbound = {
+  organization_id?: string | undefined;
+};
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryGlobals$outboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryGlobals$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansDiscoveryGlobals
+> = 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 V3ThreathuntingScansDiscoveryGlobals$ {
+  /** @deprecated use `V3ThreathuntingScansDiscoveryGlobals$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingScansDiscoveryGlobals$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryGlobals$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingScansDiscoveryGlobals$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryGlobals$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansDiscoveryGlobals$Outbound;
+}
+
+export function v3ThreathuntingScansDiscoveryGlobalsToJSON(
+  v3ThreathuntingScansDiscoveryGlobals: V3ThreathuntingScansDiscoveryGlobals,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansDiscoveryGlobals$outboundSchema.parse(
+      v3ThreathuntingScansDiscoveryGlobals,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansDiscoveryGlobalsFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansDiscoveryGlobals, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingScansDiscoveryGlobals$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansDiscoveryGlobals' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryRequest$inboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  organization_id: z.string().optional(),
+  ScansDiscoveryInputBody: components.ScansDiscoveryInputBody$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "organization_id": "organizationId",
+    "ScansDiscoveryInputBody": "scansDiscoveryInputBody",
+  });
+});
+
+/** @internal */
+export type V3ThreathuntingScansDiscoveryRequest$Outbound = {
+  organization_id?: string | undefined;
+  ScansDiscoveryInputBody: components.ScansDiscoveryInputBody$Outbound;
+};
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryRequest$outboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryRequest$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansDiscoveryRequest
+> = z.object({
+  organizationId: z.string().optional(),
+  scansDiscoveryInputBody: components.ScansDiscoveryInputBody$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    scansDiscoveryInputBody: "ScansDiscoveryInputBody",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace V3ThreathuntingScansDiscoveryRequest$ {
+  /** @deprecated use `V3ThreathuntingScansDiscoveryRequest$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingScansDiscoveryRequest$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryRequest$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingScansDiscoveryRequest$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryRequest$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansDiscoveryRequest$Outbound;
+}
+
+export function v3ThreathuntingScansDiscoveryRequestToJSON(
+  v3ThreathuntingScansDiscoveryRequest: V3ThreathuntingScansDiscoveryRequest,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansDiscoveryRequest$outboundSchema.parse(
+      v3ThreathuntingScansDiscoveryRequest,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansDiscoveryRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansDiscoveryRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingScansDiscoveryRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansDiscoveryRequest' from JSON`,
+  );
+}
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryResponse$inboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryResponse,
+  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 V3ThreathuntingScansDiscoveryResponse$Outbound = {
+  Headers: { [k: string]: Array<string> };
+  Result: components.ResponseEnvelopeTrackedScan$Outbound;
+};
+
+/** @internal */
+export const V3ThreathuntingScansDiscoveryResponse$outboundSchema: z.ZodType<
+  V3ThreathuntingScansDiscoveryResponse$Outbound,
+  z.ZodTypeDef,
+  V3ThreathuntingScansDiscoveryResponse
+> = 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 V3ThreathuntingScansDiscoveryResponse$ {
+  /** @deprecated use `V3ThreathuntingScansDiscoveryResponse$inboundSchema` instead. */
+  export const inboundSchema =
+    V3ThreathuntingScansDiscoveryResponse$inboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryResponse$outboundSchema` instead. */
+  export const outboundSchema =
+    V3ThreathuntingScansDiscoveryResponse$outboundSchema;
+  /** @deprecated use `V3ThreathuntingScansDiscoveryResponse$Outbound` instead. */
+  export type Outbound = V3ThreathuntingScansDiscoveryResponse$Outbound;
+}
+
+export function v3ThreathuntingScansDiscoveryResponseToJSON(
+  v3ThreathuntingScansDiscoveryResponse: V3ThreathuntingScansDiscoveryResponse,
+): string {
+  return JSON.stringify(
+    V3ThreathuntingScansDiscoveryResponse$outboundSchema.parse(
+      v3ThreathuntingScansDiscoveryResponse,
+    ),
+  );
+}
+
+export function v3ThreathuntingScansDiscoveryResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V3ThreathuntingScansDiscoveryResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      V3ThreathuntingScansDiscoveryResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3ThreathuntingScansDiscoveryResponse' from JSON`,
+  );
+}