@censys/platform-sdk 0.9.1 → 0.10.1

package/src/models/operations/v3collectionscrudlist.ts

@@ -5,6 +5,7 @@
 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 { Result as SafeParseResult } from "../../types/fp.js";
 import * as components from "../components/index.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
@@ -13,6 +14,14 @@ export type V3CollectionsCrudListGlobals = {
   organizationId?: string | undefined;
 };
 
+export const CollectionStatuses = {
+  Populating: "populating",
+  Active: "active",
+  Paused: "paused",
+  Archived: "archived",
+} as const;
+export type CollectionStatuses = ClosedEnum<typeof CollectionStatuses>;
+
 export type V3CollectionsCrudListRequest = {
   /**
    * 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.
@@ -26,6 +35,10 @@ export type V3CollectionsCrudListRequest = {
    * amount of results to return per page
    */
   pageSize?: number | undefined;
+  /**
+   * statuses of collection for results to be filtered on.
+   */
+  collectionStatuses?: Array<CollectionStatuses> | null | undefined;
 };
 
 export type V3CollectionsCrudListResponse = {
@@ -33,11 +46,17 @@ export type V3CollectionsCrudListResponse = {
   result: components.ResponseEnvelopeListCollectionsResponseV1;
 };
 
+/** @internal */
+export const CollectionStatuses$outboundSchema: z.ZodNativeEnum<
+  typeof CollectionStatuses
+> = z.nativeEnum(CollectionStatuses);
+
 /** @internal */
 export type V3CollectionsCrudListRequest$Outbound = {
   organization_id?: string | undefined;
   page_token?: string | undefined;
   page_size?: number | undefined;
+  collection_statuses?: Array<string> | null | undefined;
 };
 
 /** @internal */
@@ -49,11 +68,14 @@ export const V3CollectionsCrudListRequest$outboundSchema: z.ZodType<
   organizationId: z.string().optional(),
   pageToken: z.string().optional(),
   pageSize: z.number().int().optional(),
+  collectionStatuses: z.nullable(z.array(CollectionStatuses$outboundSchema))
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     organizationId: "organization_id",
     pageToken: "page_token",
     pageSize: "page_size",
+    collectionStatuses: "collection_statuses",
   });
 });
 

package/src/models/operations/v3globaldataserviceonhost.ts

@@ -0,0 +1,173 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as components from "../components/index.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type V3GlobaldataServiceOnHostGlobals = {
+  organizationId?: string | undefined;
+};
+
+/**
+ * Filter by transport protocol
+ */
+export const TransportProtocol = {
+  Tcp: "tcp",
+  Udp: "udp",
+  Quic: "quic",
+} as const;
+/**
+ * Filter by transport protocol
+ */
+export type TransportProtocol = ClosedEnum<typeof TransportProtocol>;
+
+export const OrderBy = {
+  PortASC: "port ASC",
+  PortDESC: "port DESC",
+  ProtocolASC: "protocol ASC",
+  ProtocolDESC: "protocol DESC",
+  TransportProtocolASC: "transport_protocol ASC",
+  TransportProtocolDESC: "transport_protocol DESC",
+} as const;
+export type OrderBy = ClosedEnum<typeof OrderBy>;
+
+export type V3GlobaldataServiceOnHostRequest = {
+  /**
+   * 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;
+  /**
+   * Start of date range (RFC3339 format, e.g., 2024-01-01T00:00:00Z). If not specified, defaults to the maximum query window back from the end time.
+   */
+  startTime?: string | undefined;
+  /**
+   * End of date range (RFC3339 format, e.g., 2024-01-31T23:59:59Z). If not specified, defaults to now. Cannot be in the future.
+   */
+  endTime?: string | undefined;
+  /**
+   * Number of results per page (max 100)
+   */
+  pageSize?: number | undefined;
+  /**
+   * Pagination token from previous response
+   */
+  pageToken?: string | undefined;
+  /**
+   * Filter by port number
+   */
+  port?: number | undefined;
+  /**
+   * Filter by application protocol
+   */
+  protocol?: string | undefined;
+  /**
+   * Filter by transport protocol
+   */
+  transportProtocol?: TransportProtocol | undefined;
+  /**
+   * The IP address of a host.
+   */
+  hostId: string;
+  /**
+   * Order observations by these fields. Multiple values can be provided to sort by multiple fields (e.g., ['port DESC', 'protocol ASC']).
+   */
+  orderBy?: Array<OrderBy> | null | undefined;
+};
+
+export type V3GlobaldataServiceOnHostResponse = {
+  headers: { [k: string]: Array<string> };
+  result: components.ResponseEnvelopeServicesOnHostResponse;
+};
+
+/** @internal */
+export const TransportProtocol$outboundSchema: z.ZodNativeEnum<
+  typeof TransportProtocol
+> = z.nativeEnum(TransportProtocol);
+
+/** @internal */
+export const OrderBy$outboundSchema: z.ZodNativeEnum<typeof OrderBy> = z
+  .nativeEnum(OrderBy);
+
+/** @internal */
+export type V3GlobaldataServiceOnHostRequest$Outbound = {
+  organization_id?: string | undefined;
+  start_time?: string | undefined;
+  end_time?: string | undefined;
+  page_size: number;
+  page_token?: string | undefined;
+  port?: number | undefined;
+  protocol?: string | undefined;
+  transport_protocol?: string | undefined;
+  host_id: string;
+  order_by?: Array<string> | null | undefined;
+};
+
+/** @internal */
+export const V3GlobaldataServiceOnHostRequest$outboundSchema: z.ZodType<
+  V3GlobaldataServiceOnHostRequest$Outbound,
+  z.ZodTypeDef,
+  V3GlobaldataServiceOnHostRequest
+> = z.object({
+  organizationId: z.string().optional(),
+  startTime: z.string().optional(),
+  endTime: z.string().optional(),
+  pageSize: z.number().int().default(100),
+  pageToken: z.string().optional(),
+  port: z.number().int().optional(),
+  protocol: z.string().optional(),
+  transportProtocol: TransportProtocol$outboundSchema.optional(),
+  hostId: z.string(),
+  orderBy: z.nullable(z.array(OrderBy$outboundSchema)).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    organizationId: "organization_id",
+    startTime: "start_time",
+    endTime: "end_time",
+    pageSize: "page_size",
+    pageToken: "page_token",
+    transportProtocol: "transport_protocol",
+    hostId: "host_id",
+    orderBy: "order_by",
+  });
+});
+
+export function v3GlobaldataServiceOnHostRequestToJSON(
+  v3GlobaldataServiceOnHostRequest: V3GlobaldataServiceOnHostRequest,
+): string {
+  return JSON.stringify(
+    V3GlobaldataServiceOnHostRequest$outboundSchema.parse(
+      v3GlobaldataServiceOnHostRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const V3GlobaldataServiceOnHostResponse$inboundSchema: z.ZodType<
+  V3GlobaldataServiceOnHostResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  Headers: z.record(z.array(z.string())).default({}),
+  Result: components.ResponseEnvelopeServicesOnHostResponse$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "Headers": "headers",
+    "Result": "result",
+  });
+});
+
+export function v3GlobaldataServiceOnHostResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<V3GlobaldataServiceOnHostResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => V3GlobaldataServiceOnHostResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'V3GlobaldataServiceOnHostResponse' 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
    *