@censys/platform-sdk 0.9.0 → 0.10.0

package/src/funcs/threatHuntingListThreats.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * List active threats
  *
  * @remarks
- * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).
+ * Retrieve a list of active threats observed by Censys by aggregating threat IDs across hosts and web properties. Threats are active if their fingerprint has been identified on hosts or web properties by Censys scans. This information is also available on the [Explore Threats page in the Platform web UI](https://platform.censys.io/threats).<br><br>This endpoint is available to organizations that have access to the Threat Hunting module.
  */
 export function threatHuntingListThreats(
   client: SDKCore,
@@ -142,7 +142,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "422", "4XX", "5XX"],
+    errorCodes: ["400", "401", "403", "422", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -173,7 +173,10 @@ async function $do(
       key: "Result",
     }),
     M.jsonErr(401, errors.AuthenticationError$inboundSchema),
-    M.jsonErr([403, 422], errors.ErrorModel$inboundSchema, {
+    M.jsonErr([400, 403, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr(500, errors.ErrorModel$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),

package/src/funcs/threatHuntingValueCounts.ts

@@ -144,7 +144,7 @@ async function $do(
 
   const doResult = await client._do(req, {
     context,
-    errorCodes: ["401", "403", "4XX", "5XX"],
+    errorCodes: ["400", "401", "403", "422", "4XX", "500", "5XX"],
     retryConfig: context.retryConfig,
     retryCodes: context.retryCodes,
   });
@@ -175,7 +175,10 @@ async function $do(
       key: "Result",
     }),
     M.jsonErr(401, errors.AuthenticationError$inboundSchema),
-    M.jsonErr(403, errors.ErrorModel$inboundSchema, {
+    M.jsonErr([400, 403, 422], errors.ErrorModel$inboundSchema, {
+      ctype: "application/problem+json",
+    }),
+    M.jsonErr(500, errors.ErrorModel$inboundSchema, {
       ctype: "application/problem+json",
     }),
     M.fail("4XX"),

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.50",
-  sdkVersion: "0.9.0",
-  genVersion: "2.787.2",
+  openapiDocVersion: "1.0.77",
+  sdkVersion: "0.10.0",
+  genVersion: "2.836.5",
   userAgent:
-    "speakeasy-sdk/typescript 0.9.0 2.787.2 1.0.50 @censys/platform-sdk",
+    "speakeasy-sdk/typescript 0.10.0 2.836.5 1.0.77 @censys/platform-sdk",
 } as const;

package/src/lib/sdks.ts

@@ -304,9 +304,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/models/components/alternativequery.ts

@@ -4,7 +4,8 @@
 
 import * as z from "zod/v3";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
@@ -14,7 +15,7 @@ export const Targets = {
   Cert: "cert",
   Unknown: "unknown",
 } as const;
-export type Targets = ClosedEnum<typeof Targets>;
+export type Targets = OpenEnum<typeof Targets>;
 
 export type AlternativeQuery = {
   /**
@@ -28,8 +29,8 @@ export type AlternativeQuery = {
 };
 
 /** @internal */
-export const Targets$inboundSchema: z.ZodNativeEnum<typeof Targets> = z
-  .nativeEnum(Targets);
+export const Targets$inboundSchema: z.ZodType<Targets, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Targets);
 
 /** @internal */
 export const AlternativeQuery$inboundSchema: z.ZodType<

package/src/models/components/attribute.ts

@@ -5,7 +5,8 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import { Cpe, Cpe$inboundSchema } from "./cpe.js";
@@ -18,8 +19,9 @@ export const Source = {
   Recog: "recog",
   Wappalyzer: "wappalyzer",
   ThirdParty: "third_party",
+  HtmlMetaExtractor: "html_meta_extractor",
 } as const;
-export type Source = ClosedEnum<typeof Source>;
+export type Source = OpenEnum<typeof Source>;
 
 export type Attribute = {
   components?: Array<Cpe> | null | undefined;
@@ -38,8 +40,8 @@ export type Attribute = {
 };
 
 /** @internal */
-export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
-  .nativeEnum(Source);
+export const Source$inboundSchema: z.ZodType<Source, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Source);
 
 /** @internal */
 export const Attribute$inboundSchema: z.ZodType<

package/src/models/components/certificate.ts

@@ -5,7 +5,8 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -26,7 +27,7 @@ export const ParseStatus = {
   Fail: "fail",
   Corrupted: "corrupted",
 } as const;
-export type ParseStatus = ClosedEnum<typeof ParseStatus>;
+export type ParseStatus = OpenEnum<typeof ParseStatus>;
 
 /**
  * The extent to which the certificate's issuer validated the identity of the entity requesting the certificate. Options include Domain validated (DV), Organization Validated (OV), or Extended Validation (EV).
@@ -40,7 +41,7 @@ export const ValidationLevel = {
 /**
  * The extent to which the certificate's issuer validated the identity of the entity requesting the certificate. Options include Domain validated (DV), Organization Validated (OV), or Extended Validation (EV).
  */
-export type ValidationLevel = ClosedEnum<typeof ValidationLevel>;
+export type ValidationLevel = OpenEnum<typeof ValidationLevel>;
 
 export type Certificate = {
   /**
@@ -120,13 +121,18 @@ export type Certificate = {
 };
 
 /** @internal */
-export const ParseStatus$inboundSchema: z.ZodNativeEnum<typeof ParseStatus> = z
-  .nativeEnum(ParseStatus);
+export const ParseStatus$inboundSchema: z.ZodType<
+  ParseStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ParseStatus);
 
 /** @internal */
-export const ValidationLevel$inboundSchema: z.ZodNativeEnum<
-  typeof ValidationLevel
-> = z.nativeEnum(ValidationLevel);
+export const ValidationLevel$inboundSchema: z.ZodType<
+  ValidationLevel,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ValidationLevel);
 
 /** @internal */
 export const Certificate$inboundSchema: z.ZodType<

package/src/models/components/certificaterevocationrevocationinfo.ts

@@ -5,7 +5,8 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
@@ -28,7 +29,7 @@ export const Reason = {
 /**
  * An enumerated value indicating the issuer-supplied reason for the revocation.
  */
-export type Reason = ClosedEnum<typeof Reason>;
+export type Reason = OpenEnum<typeof Reason>;
 
 export type CertificateRevocationRevocationInfo = {
   nextUpdate?: string | undefined;
@@ -47,8 +48,8 @@ export type CertificateRevocationRevocationInfo = {
 };
 
 /** @internal */
-export const Reason$inboundSchema: z.ZodNativeEnum<typeof Reason> = z
-  .nativeEnum(Reason);
+export const Reason$inboundSchema: z.ZodType<Reason, z.ZodTypeDef, unknown> =
+  openEnums.inboundSchema(Reason);
 
 /** @internal */
 export const CertificateRevocationRevocationInfo$inboundSchema: z.ZodType<

package/src/models/components/collection.ts

@@ -5,7 +5,8 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
@@ -16,7 +17,7 @@ export const CollectionStatus = {
   Paused: "paused",
   Archived: "archived",
 } as const;
-export type CollectionStatus = ClosedEnum<typeof CollectionStatus>;
+export type CollectionStatus = OpenEnum<typeof CollectionStatus>;
 
 export const StatusReason = {
   Unspecified: "unspecified",
@@ -27,11 +28,15 @@ export const StatusReason = {
   QueryChanged: "query_changed",
   Initial: "initial",
 } as const;
-export type StatusReason = ClosedEnum<typeof StatusReason>;
+export type StatusReason = OpenEnum<typeof StatusReason>;
 
 export type Collection = {
   addedAssets24Hours: number;
   createTime: Date;
+  /**
+   * The ID of a Censys user who created the collection.
+   */
+  createdBy?: string | undefined;
   description: string;
   id: string;
   name: string;
@@ -43,13 +48,18 @@ export type Collection = {
 };
 
 /** @internal */
-export const CollectionStatus$inboundSchema: z.ZodNativeEnum<
-  typeof CollectionStatus
-> = z.nativeEnum(CollectionStatus);
+export const CollectionStatus$inboundSchema: z.ZodType<
+  CollectionStatus,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(CollectionStatus);
 
 /** @internal */
-export const StatusReason$inboundSchema: z.ZodNativeEnum<typeof StatusReason> =
-  z.nativeEnum(StatusReason);
+export const StatusReason$inboundSchema: z.ZodType<
+  StatusReason,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(StatusReason);
 
 /** @internal */
 export const Collection$inboundSchema: z.ZodType<
@@ -61,6 +71,7 @@ export const Collection$inboundSchema: z.ZodType<
   create_time: z.string().datetime({ offset: true }).transform(v =>
     new Date(v)
   ),
+  created_by: z.string().optional(),
   description: z.string(),
   id: z.string(),
   name: z.string(),
@@ -73,6 +84,7 @@ export const Collection$inboundSchema: z.ZodType<
   return remap$(v, {
     "added_assets_24_hours": "addedAssets24Hours",
     "create_time": "createTime",
+    "created_by": "createdBy",
     "removed_assets_24_hours": "removedAssets24Hours",
     "status_reason": "statusReason",
     "total_assets": "totalAssets",

package/src/models/components/creditexpiration.ts

@@ -21,6 +21,10 @@ export type CreditExpiration = {
    * The date and time the credit expiration will expire.
    */
   expiresAt?: Date | undefined;
+  /**
+   * The initial balance of the credit expiration (i.e. how much was purchased).
+   */
+  initialBalance: number;
 };
 
 /** @internal */
@@ -34,10 +38,12 @@ export const CreditExpiration$inboundSchema: z.ZodType<
     .optional(),
   expires_at: z.string().datetime({ offset: true }).transform(v => new Date(v))
     .optional(),
+  initial_balance: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
     "expires_at": "expiresAt",
+    "initial_balance": "initialBalance",
   });
 });
 

package/src/models/components/creditusagereport.ts

@@ -5,45 +5,104 @@
 import * as z from "zod/v3";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CreditUsageReportPeriod,
+  CreditUsageReportPeriod$inboundSchema,
+} from "./creditusagereportperiod.js";
 import {
   SourceUsageBreakdown,
   SourceUsageBreakdown$inboundSchema,
 } from "./sourceusagebreakdown.js";
 
+/**
+ * The granularity of the report.
+ */
+export const Granularity = {
+  Daily: "daily",
+  Monthly: "monthly",
+} as const;
+/**
+ * The granularity of the report.
+ */
+export type Granularity = OpenEnum<typeof Granularity>;
+
 export type CreditUsageReport = {
   /**
-   * The end date of the window for this report.
+   * The breakdown of credits consumed by consumer. This may not be present if the report is generated for a specific user.
+   */
+  creditsConsumedByConsumer?: string | undefined;
+  creditsConsumedBySource: SourceUsageBreakdown;
+  /**
+   * The end time of the window for this report.
+   */
+  endTime: Date;
+  /**
+   * The granularity of the report.
+   */
+  granularity: Granularity;
+  /**
+   * The periods of the report (i.e. time buckets).
    */
-  endDate: Date;
-  sourceBreakdown: SourceUsageBreakdown;
+  periods: Array<CreditUsageReportPeriod> | null;
   /**
-   * The start date of the window for this report.
+   * The start time of the window for this report.
    */
-  startDate: Date;
+  startTime: Date;
+  /**
+   * The total amount of credits added during the report period.
+   */
+  totalAdded: number;
   /**
    * The total amount of credits consumed during the report period.
    */
   totalConsumed: number;
+  /**
+   * The total amount of credits expired during the report period.
+   */
+  totalExpired: number;
+  /**
+   * The total number of transactions during the report period.
+   */
+  transactionCount: number;
 };
 
+/** @internal */
+export const Granularity$inboundSchema: z.ZodType<
+  Granularity,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(Granularity);
+
 /** @internal */
 export const CreditUsageReport$inboundSchema: z.ZodType<
   CreditUsageReport,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  end_date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  source_breakdown: SourceUsageBreakdown$inboundSchema,
-  start_date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  credits_consumed_by_consumer: z.string().optional(),
+  credits_consumed_by_source: SourceUsageBreakdown$inboundSchema,
+  end_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  granularity: Granularity$inboundSchema.default("daily"),
+  periods: z.nullable(z.array(CreditUsageReportPeriod$inboundSchema)),
+  start_time: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  total_added: z.number().int(),
   total_consumed: z.number().int(),
+  total_expired: z.number().int(),
+  transaction_count: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
-    "end_date": "endDate",
-    "source_breakdown": "sourceBreakdown",
-    "start_date": "startDate",
+    "credits_consumed_by_consumer": "creditsConsumedByConsumer",
+    "credits_consumed_by_source": "creditsConsumedBySource",
+    "end_time": "endTime",
+    "start_time": "startTime",
+    "total_added": "totalAdded",
     "total_consumed": "totalConsumed",
+    "total_expired": "totalExpired",
+    "transaction_count": "transactionCount",
   });
 });
 

package/src/models/components/creditusagereportperiod.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type CreditUsageReportPeriod = {
+  /**
+   * The total amount of credits added during the report period.
+   */
+  creditsAdded: number;
+  /**
+   * The total amount of credits consumed during the report period.
+   */
+  creditsConsumed: number;
+  /**
+   * The total amount of credits expired during the report period.
+   */
+  creditsExpired: number;
+  /**
+   * The end date of the window for this report period.
+   */
+  endDate: Date;
+  /**
+   * The start date of the window for this report period.
+   */
+  startDate: Date;
+  /**
+   * The total number of transactions during the report period.
+   */
+  transactionCount: number;
+};
+
+/** @internal */
+export const CreditUsageReportPeriod$inboundSchema: z.ZodType<
+  CreditUsageReportPeriod,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  credits_added: z.number().int(),
+  credits_consumed: z.number().int(),
+  credits_expired: z.number().int(),
+  end_date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  start_date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  transaction_count: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "credits_added": "creditsAdded",
+    "credits_consumed": "creditsConsumed",
+    "credits_expired": "creditsExpired",
+    "end_date": "endDate",
+    "start_date": "startDate",
+    "transaction_count": "transactionCount",
+  });
+});
+
+export function creditUsageReportPeriodFromJSON(
+  jsonString: string,
+): SafeParseResult<CreditUsageReportPeriod, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreditUsageReportPeriod$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreditUsageReportPeriod' from JSON`,
+  );
+}