@indiciaosint/sdk 1.2.0 → 1.2.2

package/src/funcs/intelligence-virus-total-intelligence.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { IndiciaCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { IndiciaError } from "../models/errors/indicia-error.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * VirusTotal File Intelligence
+ *
+ * @remarks
+ * Look up VirusTotal reputation and antivirus detection data for a URL, domain, IP address, or file hash.
+ */
+export function intelligenceVirusTotalIntelligence(
+  client: IndiciaCore,
+  request: operations.VirusTotalIntelligenceRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.VirusTotalIntelligenceResponse,
+    | errors.FailedResponseError
+    | IndiciaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: IndiciaCore,
+  request: operations.VirusTotalIntelligenceRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.VirusTotalIntelligenceResponse,
+      | errors.FailedResponseError
+      | IndiciaError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.VirusTotalIntelligenceRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/search/intelligence/virustotal")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "virusTotalIntelligence",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.VirusTotalIntelligenceResponse,
+    | errors.FailedResponseError
+    | IndiciaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.VirusTotalIntelligenceResponse$inboundSchema),
+    M.jsonErr(402, errors.FailedResponseError$inboundSchema),
+    M.jsonErr(500, errors.FailedResponseError$inboundSchema),
+    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/socials-search-github.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v4-mini";
 import { IndiciaCore } from "../core.js";
 import { encodeJSON } from "../lib/encodings.js";
+import { EventStream } from "../lib/event-streams.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -31,7 +32,7 @@ import { Result } from "../types/fp.js";
  * GitHub Search
  *
  * @remarks
- * Search GitHub profiles, info, and commit emails
+ * Search GitHub profiles, info, and commit emails. Streams progress updates via Server-Sent Events.
  */
 export function socialsSearchGithub(
   client: IndiciaCore,
@@ -39,7 +40,7 @@ export function socialsSearchGithub(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.SearchGithubResponse,
+    EventStream<operations.GithubSearchEvent>,
     | errors.FailedResponseError
     | IndiciaError
     | ResponseValidationError
@@ -65,7 +66,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.SearchGithubResponse,
+      EventStream<operations.GithubSearchEvent>,
       | errors.FailedResponseError
       | IndiciaError
       | ResponseValidationError
@@ -94,7 +95,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json",
+    Accept: "text/event-stream",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -148,7 +149,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.SearchGithubResponse,
+    EventStream<operations.GithubSearchEvent>,
     | errors.FailedResponseError
     | IndiciaError
     | ResponseValidationError
@@ -159,7 +160,21 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.SearchGithubResponse$inboundSchema),
+    M.sse(
+      200,
+      z.pipe(
+        z.custom<ReadableStream<Uint8Array>>(x => x instanceof ReadableStream),
+        z.transform(stream => {
+          return new EventStream(stream, rawEvent => {
+            return {
+              done: false,
+              value: operations.GithubSearchEvent$inboundSchema.parse(rawEvent),
+            };
+          });
+        }),
+      ),
+    ),
+    M.jsonErr([400, 402], errors.FailedResponseError$inboundSchema),
     M.jsonErr(500, errors.FailedResponseError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/socials-search-username.ts

@@ -5,6 +5,7 @@
 import * as z from "zod/v4-mini";
 import { IndiciaCore } from "../core.js";
 import { encodeJSON } from "../lib/encodings.js";
+import { EventStream } from "../lib/event-streams.js";
 import { matchStatusCode } from "../lib/http.js";
 import * as M from "../lib/matchers.js";
 import { compactMap } from "../lib/primitives.js";
@@ -31,7 +32,7 @@ import { Result } from "../types/fp.js";
  * Username Search V2
  *
  * @remarks
- * Search various sites for a specific username
+ * Search various sites for a specific username. Streams progress updates via Server-Sent Events.
  */
 export function socialsSearchUsername(
   client: IndiciaCore,
@@ -39,7 +40,7 @@ export function socialsSearchUsername(
   options?: RequestOptions,
 ): APIPromise<
   Result<
-    operations.SearchUsernameResponse,
+    EventStream<operations.UsernameSearchEvent>,
     | errors.FailedResponseError
     | IndiciaError
     | ResponseValidationError
@@ -65,7 +66,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.SearchUsernameResponse,
+      EventStream<operations.UsernameSearchEvent>,
       | errors.FailedResponseError
       | IndiciaError
       | ResponseValidationError
@@ -94,7 +95,7 @@ async function $do(
 
   const headers = new Headers(compactMap({
     "Content-Type": "application/json",
-    Accept: "application/json",
+    Accept: "text/event-stream",
   }));
 
   const secConfig = await extractSecurity(client._options.apiKey);
@@ -148,7 +149,7 @@ async function $do(
   };
 
   const [result] = await M.match<
-    operations.SearchUsernameResponse,
+    EventStream<operations.UsernameSearchEvent>,
     | errors.FailedResponseError
     | IndiciaError
     | ResponseValidationError
@@ -159,7 +160,23 @@ async function $do(
     | UnexpectedClientError
     | SDKValidationError
   >(
-    M.json(200, operations.SearchUsernameResponse$inboundSchema),
+    M.sse(
+      200,
+      z.pipe(
+        z.custom<ReadableStream<Uint8Array>>(x => x instanceof ReadableStream),
+        z.transform(stream => {
+          return new EventStream(stream, rawEvent => {
+            return {
+              done: false,
+              value: operations.UsernameSearchEvent$inboundSchema.parse(
+                rawEvent,
+              ),
+            };
+          });
+        }),
+      ),
+    ),
+    M.jsonErr([400, 402], errors.FailedResponseError$inboundSchema),
     M.jsonErr(500, errors.FailedResponseError$inboundSchema),
     M.fail("4XX"),
     M.fail("5XX"),

package/src/funcs/tools-download-virus-total-file.ts

@@ -0,0 +1,174 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { IndiciaCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import { matchStatusCode } from "../lib/http.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/http-client-errors.js";
+import * as errors from "../models/errors/index.js";
+import { IndiciaError } from "../models/errors/indicia-error.js";
+import { ResponseValidationError } from "../models/errors/response-validation-error.js";
+import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
+import * as operations from "../models/operations/index.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Download VirusTotal file
+ *
+ * @remarks
+ * Download a file from VirusTotal by its id. The file is returned base64-encoded.
+ */
+export function toolsDownloadVirusTotalFile(
+  client: IndiciaCore,
+  request: operations.DownloadVirusTotalFileRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DownloadVirusTotalFileResponse,
+    | errors.FailedResponseError
+    | IndiciaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: IndiciaCore,
+  request: operations.DownloadVirusTotalFileRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.DownloadVirusTotalFileResponse,
+      | errors.FailedResponseError
+      | IndiciaError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      z.parse(operations.DownloadVirusTotalFileRequest$outboundSchema, value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/tools/virustotal")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKey);
+  const securityInput = secConfig == null ? {} : { apiKey: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "downloadVirusTotalFile",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKey,
+    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,
+    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,
+    isErrorStatusCode: (statusCode: number) =>
+      matchStatusCode({ status: statusCode } as Response, ["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.DownloadVirusTotalFileResponse,
+    | errors.FailedResponseError
+    | IndiciaError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.DownloadVirusTotalFileResponse$inboundSchema),
+    M.jsonErr(402, errors.FailedResponseError$inboundSchema),
+    M.jsonErr(500, errors.FailedResponseError$inboundSchema),
+    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

@@ -58,7 +58,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "1.2.0",
+  sdkVersion: "1.2.2",
   genVersion: "2.912.1",
-  userAgent: "speakeasy-sdk/typescript 1.2.0 2.912.1 1.0.0 @indiciaosint/sdk",
+  userAgent: "speakeasy-sdk/typescript 1.2.2 2.912.1 1.0.0 @indiciaosint/sdk",
 } as const;

package/src/models/operations/download-virus-total-file.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export type DownloadVirusTotalFileRequest = {
+  id: string;
+};
+
+export type DownloadVirusTotalFileData = {
+  content: string;
+  encoding: string;
+  id: string;
+  size: number;
+};
+
+/**
+ * Successful response
+ */
+export type DownloadVirusTotalFileResponse = {
+  success: boolean;
+  data?: DownloadVirusTotalFileData | undefined;
+  error?: string | undefined;
+};
+
+/** @internal */
+export type DownloadVirusTotalFileRequest$Outbound = {
+  id: string;
+};
+
+/** @internal */
+export const DownloadVirusTotalFileRequest$outboundSchema: z.ZodMiniType<
+  DownloadVirusTotalFileRequest$Outbound,
+  DownloadVirusTotalFileRequest
+> = z.object({
+  id: z.string(),
+});
+
+export function downloadVirusTotalFileRequestToJSON(
+  downloadVirusTotalFileRequest: DownloadVirusTotalFileRequest,
+): string {
+  return JSON.stringify(
+    DownloadVirusTotalFileRequest$outboundSchema.parse(
+      downloadVirusTotalFileRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const DownloadVirusTotalFileData$inboundSchema: z.ZodMiniType<
+  DownloadVirusTotalFileData,
+  unknown
+> = z.object({
+  content: types.string(),
+  encoding: types.string(),
+  id: types.string(),
+  size: types.number(),
+});
+
+export function downloadVirusTotalFileDataFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadVirusTotalFileData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DownloadVirusTotalFileData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadVirusTotalFileData' from JSON`,
+  );
+}
+
+/** @internal */
+export const DownloadVirusTotalFileResponse$inboundSchema: z.ZodMiniType<
+  DownloadVirusTotalFileResponse,
+  unknown
+> = z.object({
+  success: types.boolean(),
+  data: types.optional(z.lazy(() => DownloadVirusTotalFileData$inboundSchema)),
+  error: types.optional(types.string()),
+});
+
+export function downloadVirusTotalFileResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<DownloadVirusTotalFileResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DownloadVirusTotalFileResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DownloadVirusTotalFileResponse' from JSON`,
+  );
+}

package/src/models/operations/get-activity.ts

@@ -68,6 +68,9 @@ export const GetActivityType = {
   Username: "username",
   Usernames: "usernames",
   Vehicle: "vehicle",
+  VirustotalContent: "virustotal.content",
+  VirustotalDownload: "virustotal.download",
+  VirustotalIntelligence: "virustotal.intelligence",
   WebDbs: "web-dbs",
   Whois: "whois",
 } as const;

package/src/models/operations/get-info.ts

@@ -79,6 +79,9 @@ export const RestrictedFeatures = {
   Uk: "uk",
   Username: "username",
   Vehicle: "vehicle",
+  VirustotalContent: "virustotal.content",
+  VirustotalDownload: "virustotal.download",
+  VirustotalIntelligence: "virustotal.intelligence",
   WebDbs: "web-dbs",
   Whois: "whois",
 } as const;

package/src/models/operations/index.ts

@@ -5,6 +5,7 @@
 export * from "./bypass-double-counter.js";
 export * from "./delete-activity.js";
 export * from "./download-intelx-file.js";
+export * from "./download-virus-total-file.js";
 export * from "./geolocate-media.js";
 export * from "./get-activity.js";
 export * from "./get-info.js";
@@ -37,3 +38,5 @@ export * from "./search-username.js";
 export * from "./search-web-databases.js";
 export * from "./search-whois.js";
 export * from "./send-organization-credits.js";
+export * from "./virus-total-content.js";
+export * from "./virus-total-intelligence.js";

package/src/models/operations/list-activities.ts

@@ -66,6 +66,9 @@ export const ListActivitiesType = {
   Username: "username",
   Usernames: "usernames",
   Vehicle: "vehicle",
+  VirustotalContent: "virustotal.content",
+  VirustotalDownload: "virustotal.download",
+  VirustotalIntelligence: "virustotal.intelligence",
   WebDbs: "web-dbs",
   Whois: "whois",
 } as const;