@censys/platform-sdk 0.5.0 → 0.6.0

package/src/funcs/globalDataGetCertificates.ts

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.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";
@@ -33,11 +33,11 @@ import { Result } from "../types/fp.js";
  */
 export function globalDataGetCertificates(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetCertificateListRequest,
+  request: operations.V3GlobaldataAssetCertificateListPostRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.V3GlobaldataAssetCertificateListResponse,
+    operations.V3GlobaldataAssetCertificateListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -58,12 +58,12 @@ export function globalDataGetCertificates(
 
 async function $do(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetCertificateListRequest,
+  request: operations.V3GlobaldataAssetCertificateListPostRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.V3GlobaldataAssetCertificateListResponse,
+      operations.V3GlobaldataAssetCertificateListPostResponse,
       | errors.ErrorModel
       | SDKBaseError
       | ResponseValidationError
@@ -80,26 +80,27 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.V3GlobaldataAssetCertificateListRequest$outboundSchema.parse(
-        value,
-      ),
+      operations.V3GlobaldataAssetCertificateListPostRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
+  const body = encodeJSON("body", payload.AssetCertificateListInputBody, {
+    explode: true,
+  });
 
   const path = pathToFunc("/v3/global/asset/certificate")();
 
   const query = encodeFormQuery({
-    "certificate_ids": payload.certificate_ids,
     "organization_id": payload.organization_id
       ?? client._options.organizationId,
   }, { explode: false });
 
   const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
     Accept: "application/vnd.censys.api.v3.certificate.v1+json",
   }));
 
@@ -112,7 +113,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v3-globaldata-asset-certificate-list",
+    operationID: "v3-globaldata-asset-certificate-list-post",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -126,7 +127,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -156,7 +157,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.V3GlobaldataAssetCertificateListResponse,
+    operations.V3GlobaldataAssetCertificateListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -169,7 +170,7 @@ async function $do(
   >(
     M.json(
       200,
-      operations.V3GlobaldataAssetCertificateListResponse$inboundSchema,
+      operations.V3GlobaldataAssetCertificateListPostResponse$inboundSchema,
       {
         ctype: "application/vnd.censys.api.v3.certificate.v1+json",
         hdrs: true,

package/src/funcs/globalDataGetCertificatesRaw.ts

@@ -0,0 +1,187 @@
+/*
+ * 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";
+
+/**
+ * Get multiple certificates in PEM format
+ *
+ * @remarks
+ * Retrieve the raw PEM-encoded format for multiple certificates. A certificate ID is its SHA-256 fingerprint in the Censys dataset.
+ */
+export function globalDataGetCertificatesRaw(
+  client: SDKCore,
+  request: operations.V3GlobaldataAssetCertificateListRawPostRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.V3GlobaldataAssetCertificateListRawPostResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.V3GlobaldataAssetCertificateListRawPostRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.V3GlobaldataAssetCertificateListRawPostResponse,
+      | errors.ErrorModel
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.V3GlobaldataAssetCertificateListRawPostRequest$outboundSchema
+        .parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload.AssetCertificateListInputBody, {
+    explode: true,
+  });
+
+  const path = pathToFunc("/v3/global/asset/certificate/raw")();
+
+  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-globaldata-asset-certificate-list-raw-post",
+    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", "404", "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.V3GlobaldataAssetCertificateListRawPostResponse,
+    | errors.ErrorModel
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.V3GlobaldataAssetCertificateListRawPostResponse$inboundSchema,
+      { hdrs: true, key: "Result" },
+    ),
+    M.jsonErr([401, 404], 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/globalDataGetHostTimeline.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Get host event history
  *
  * @remarks
- * Retrieve event history for a host. A host ID is its IP address.
+ * Retrieve event history for a host. A host ID is its IP address.<br><br>Note that when a service protocol changes after a new scan (for example, from `UNKNOWN` to `NETBIOS`), this information will only be reflected in the `scan` object. It will not be shown in the `service_scanned diff` object.
  */
 export function globalDataGetHostTimeline(
   client: SDKCore,

package/src/funcs/globalDataGetHosts.ts

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.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";
@@ -33,11 +33,11 @@ import { Result } from "../types/fp.js";
  */
 export function globalDataGetHosts(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetHostListRequest,
+  request: operations.V3GlobaldataAssetHostListPostRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.V3GlobaldataAssetHostListResponse,
+    operations.V3GlobaldataAssetHostListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -58,12 +58,12 @@ export function globalDataGetHosts(
 
 async function $do(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetHostListRequest,
+  request: operations.V3GlobaldataAssetHostListPostRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.V3GlobaldataAssetHostListResponse,
+      operations.V3GlobaldataAssetHostListPostResponse,
       | errors.ErrorModel
       | SDKBaseError
       | ResponseValidationError
@@ -80,24 +80,28 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.V3GlobaldataAssetHostListRequest$outboundSchema.parse(value),
+      operations.V3GlobaldataAssetHostListPostRequest$outboundSchema.parse(
+        value,
+      ),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
+  const body = encodeJSON("body", payload.AssetHostListInputBody, {
+    explode: true,
+  });
 
   const path = pathToFunc("/v3/global/asset/host")();
 
   const query = encodeFormQuery({
-    "host_ids": payload.host_ids,
     "organization_id": payload.organization_id
       ?? client._options.organizationId,
   }, { explode: false });
 
   const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
     Accept: "application/vnd.censys.api.v3.host.v1+json",
   }));
 
@@ -110,7 +114,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v3-globaldata-asset-host-list",
+    operationID: "v3-globaldata-asset-host-list-post",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -124,7 +128,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -154,7 +158,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.V3GlobaldataAssetHostListResponse,
+    operations.V3GlobaldataAssetHostListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -165,11 +169,15 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.V3GlobaldataAssetHostListResponse$inboundSchema, {
-      ctype: "application/vnd.censys.api.v3.host.v1+json",
-      hdrs: true,
-      key: "Result",
-    }),
+    M.json(
+      200,
+      operations.V3GlobaldataAssetHostListPostResponse$inboundSchema,
+      {
+        ctype: "application/vnd.censys.api.v3.host.v1+json",
+        hdrs: true,
+        key: "Result",
+      },
+    ),
     M.jsonErr([401, 403], errors.ErrorModel$inboundSchema, {
       ctype: "application/problem+json",
     }),

package/src/funcs/globalDataGetTrackedScan.ts

@@ -26,11 +26,10 @@ 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 globalDataGetTrackedScan(
   client: SDKCore,

package/src/funcs/globalDataGetWebProperties.ts

@@ -3,7 +3,7 @@
  */
 
 import { SDKCore } from "../core.js";
-import { encodeFormQuery } from "../lib/encodings.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";
@@ -33,11 +33,11 @@ import { Result } from "../types/fp.js";
  */
 export function globalDataGetWebProperties(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetWebpropertyListRequest,
+  request: operations.V3GlobaldataAssetWebpropertyListPostRequest,
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.V3GlobaldataAssetWebpropertyListResponse,
+    operations.V3GlobaldataAssetWebpropertyListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -58,12 +58,12 @@ export function globalDataGetWebProperties(
 
 async function $do(
   client: SDKCore,
-  request: operations.V3GlobaldataAssetWebpropertyListRequest,
+  request: operations.V3GlobaldataAssetWebpropertyListPostRequest,
   options?: RequestOptions,
 ): Promise<
   [
     Result<
-      operations.V3GlobaldataAssetWebpropertyListResponse,
+      operations.V3GlobaldataAssetWebpropertyListPostResponse,
       | errors.ErrorModel
       | SDKBaseError
       | ResponseValidationError
@@ -80,26 +80,27 @@ async function $do(
   const parsed = safeParse(
     request,
     (value) =>
-      operations.V3GlobaldataAssetWebpropertyListRequest$outboundSchema.parse(
-        value,
-      ),
+      operations.V3GlobaldataAssetWebpropertyListPostRequest$outboundSchema
+        .parse(value),
     "Input validation failed",
   );
   if (!parsed.ok) {
     return [parsed, { status: "invalid" }];
   }
   const payload = parsed.value;
-  const body = null;
+  const body = encodeJSON("body", payload.AssetWebpropertyListInputBody, {
+    explode: true,
+  });
 
   const path = pathToFunc("/v3/global/asset/webproperty")();
 
   const query = encodeFormQuery({
     "organization_id": payload.organization_id
       ?? client._options.organizationId,
-    "webproperty_ids": payload.webproperty_ids,
   }, { explode: false });
 
   const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
     Accept: "application/vnd.censys.api.v3.webproperty.v1+json",
   }));
 
@@ -112,7 +113,7 @@ async function $do(
   const context = {
     options: client._options,
     baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v3-globaldata-asset-webproperty-list",
+    operationID: "v3-globaldata-asset-webproperty-list-post",
     oAuth2Scopes: [],
 
     resolvedSecurity: requestSecurity,
@@ -126,7 +127,7 @@ async function $do(
 
   const requestRes = client._createRequest(context, {
     security: requestSecurity,
-    method: "GET",
+    method: "POST",
     baseURL: options?.serverURL,
     path: path,
     headers: headers,
@@ -156,7 +157,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.V3GlobaldataAssetWebpropertyListResponse,
+    operations.V3GlobaldataAssetWebpropertyListPostResponse,
     | errors.ErrorModel
     | SDKBaseError
     | ResponseValidationError
@@ -169,7 +170,7 @@ async function $do(
   >(
     M.json(
       200,
-      operations.V3GlobaldataAssetWebpropertyListResponse$inboundSchema,
+      operations.V3GlobaldataAssetWebpropertyListPostResponse$inboundSchema,
       {
         ctype: "application/vnd.censys.api.v3.webproperty.v1+json",
         hdrs: true,

package/src/funcs/threatHuntingCreateTrackedScan.ts

@@ -26,10 +26,10 @@ import { APICall, APIPromise } from "../types/async.js";
 import { Result } from "../types/fp.js";
 
 /**
- * Create a tracked discovery scan
+ * Live Discovery: Initiate a new 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.
+ * Initiate a scan to look for a currently unobserved service at a specific IP and port (`ip:port`) or hostname and port (`hostname:port`). This is equivalent to the [Live Discovery](https://docs.censys.com/docs/platform-threat-hunting-use-live-scan-and-rescan-to-validate-infrastructure#/) feature available in the UI, but you can also target web properties in addition to hosts.<br><br>The scan may take several minutes to complete. The response will contain a scan ID that you can use to [monitor the scan's status](https://docs.censys.com/reference/v3-threathunting-scans-get#/). After the scan completes, perform a lookup on the target asset to retrieve detailed scan information.<br><br>This endpoint is available to organizations that have access to the Threat Hunting module. It costs 15 credits to execute this endpoint.
  */
 export function threatHuntingCreateTrackedScan(
   client: SDKCore,