@indiciaosint/sdk 1.2.1 → 1.2.2

package/src/models/operations/virus-total-intelligence.ts

@@ -0,0 +1,210 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v4-mini";
+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 types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export const Entity = {
+  Domains: "domains",
+  Files: "files",
+  Ips: "ips",
+  Urls: "urls",
+} as const;
+export type Entity = ClosedEnum<typeof Entity>;
+
+export type VirusTotalIntelligenceRequest = {
+  entity: Entity;
+  query: string;
+};
+
+export type VirusTotalIntelligenceFile = {
+  id: string;
+  cleanCount?: number | undefined;
+  detectionRatio?: string | undefined;
+  fileName?: string | undefined;
+  firstSubmissionDate?: string | undefined;
+  lastAnalysisDate?: string | undefined;
+  maliciousCount?: number | undefined;
+  permalink?: string | undefined;
+  reputation?: string | undefined;
+  sha256?: string | undefined;
+  suspiciousCount?: number | undefined;
+  totalEngines?: number | undefined;
+  undetectedCount?: number | undefined;
+  url?: string | undefined;
+};
+
+export type SearchStats = {
+  clean?: number | undefined;
+  malicious?: number | undefined;
+  suspicious?: number | undefined;
+  total?: number | undefined;
+};
+
+export type VirusTotalIntelligenceData = {
+  entity: string;
+  files: Array<VirusTotalIntelligenceFile>;
+  query: string;
+  totalResults: number;
+  searchStats?: SearchStats | undefined;
+};
+
+/**
+ * Search successful
+ */
+export type VirusTotalIntelligenceResponse = {
+  data: VirusTotalIntelligenceData;
+  success: boolean;
+  error?: string | undefined;
+};
+
+/** @internal */
+export const Entity$outboundSchema: z.ZodMiniEnum<typeof Entity> = z.enum(
+  Entity,
+);
+
+/** @internal */
+export type VirusTotalIntelligenceRequest$Outbound = {
+  entity: string;
+  query: string;
+};
+
+/** @internal */
+export const VirusTotalIntelligenceRequest$outboundSchema: z.ZodMiniType<
+  VirusTotalIntelligenceRequest$Outbound,
+  VirusTotalIntelligenceRequest
+> = z.object({
+  entity: Entity$outboundSchema,
+  query: z.string(),
+});
+
+export function virusTotalIntelligenceRequestToJSON(
+  virusTotalIntelligenceRequest: VirusTotalIntelligenceRequest,
+): string {
+  return JSON.stringify(
+    VirusTotalIntelligenceRequest$outboundSchema.parse(
+      virusTotalIntelligenceRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const VirusTotalIntelligenceFile$inboundSchema: z.ZodMiniType<
+  VirusTotalIntelligenceFile,
+  unknown
+> = z.pipe(
+  z.object({
+    id: types.string(),
+    clean_count: types.optional(types.number()),
+    detection_ratio: types.optional(types.string()),
+    file_name: types.optional(types.string()),
+    first_submission_date: types.optional(types.string()),
+    last_analysis_date: types.optional(types.string()),
+    malicious_count: types.optional(types.number()),
+    permalink: types.optional(types.string()),
+    reputation: types.optional(types.string()),
+    sha256: types.optional(types.string()),
+    suspicious_count: types.optional(types.number()),
+    total_engines: types.optional(types.number()),
+    undetected_count: types.optional(types.number()),
+    url: types.optional(types.string()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "clean_count": "cleanCount",
+      "detection_ratio": "detectionRatio",
+      "file_name": "fileName",
+      "first_submission_date": "firstSubmissionDate",
+      "last_analysis_date": "lastAnalysisDate",
+      "malicious_count": "maliciousCount",
+      "suspicious_count": "suspiciousCount",
+      "total_engines": "totalEngines",
+      "undetected_count": "undetectedCount",
+    });
+  }),
+);
+
+export function virusTotalIntelligenceFileFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalIntelligenceFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalIntelligenceFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalIntelligenceFile' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchStats$inboundSchema: z.ZodMiniType<SearchStats, unknown> = z
+  .object({
+    clean: types.optional(types.number()),
+    malicious: types.optional(types.number()),
+    suspicious: types.optional(types.number()),
+    total: types.optional(types.number()),
+  });
+
+export function searchStatsFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchStats, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchStats$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchStats' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirusTotalIntelligenceData$inboundSchema: z.ZodMiniType<
+  VirusTotalIntelligenceData,
+  unknown
+> = z.pipe(
+  z.object({
+    entity: types.string(),
+    files: z.array(z.lazy(() => VirusTotalIntelligenceFile$inboundSchema)),
+    query: types.string(),
+    total_results: types.number(),
+    search_stats: types.optional(z.lazy(() => SearchStats$inboundSchema)),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "total_results": "totalResults",
+      "search_stats": "searchStats",
+    });
+  }),
+);
+
+export function virusTotalIntelligenceDataFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalIntelligenceData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalIntelligenceData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalIntelligenceData' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirusTotalIntelligenceResponse$inboundSchema: z.ZodMiniType<
+  VirusTotalIntelligenceResponse,
+  unknown
+> = z.object({
+  data: z.lazy(() => VirusTotalIntelligenceData$inboundSchema),
+  success: types.boolean(),
+  error: types.optional(types.string()),
+});
+
+export function virusTotalIntelligenceResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalIntelligenceResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalIntelligenceResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalIntelligenceResponse' from JSON`,
+  );
+}

package/src/sdk/infrastructure.ts

@@ -8,6 +8,7 @@ import { infrastructureSearchDns } from "../funcs/infrastructure-search-dns.js";
 import { infrastructureSearchIpInfo } from "../funcs/infrastructure-search-ip-info.js";
 import { infrastructureSearchShodan } from "../funcs/infrastructure-search-shodan.js";
 import { infrastructureSearchWhois } from "../funcs/infrastructure-search-whois.js";
+import { infrastructureVirusTotalContent } from "../funcs/infrastructure-virus-total-content.js";
 import { EventStream } from "../lib/event-streams.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
@@ -65,6 +66,23 @@ export class Infrastructure extends ClientSDK {
     ));
   }
 
+  /**
+   * VirusTotal Content Search
+   *
+   * @remarks
+   * Search VirusTotal for files whose content matches a given string.
+   */
+  async virusTotalContent(
+    request: operations.VirusTotalContentRequest,
+    options?: RequestOptions,
+  ): Promise<operations.VirusTotalContentResponse> {
+    return unwrapAsync(infrastructureVirusTotalContent(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Whois
    *

package/src/sdk/intelligence.ts

@@ -12,6 +12,7 @@ import { intelligenceSearchPerson } from "../funcs/intelligence-search-person.js
 import { intelligenceSearchPhone } from "../funcs/intelligence-search-phone.js";
 import { intelligenceSearchSeon } from "../funcs/intelligence-search-seon.js";
 import { intelligenceSearchWebDatabases } from "../funcs/intelligence-search-web-databases.js";
+import { intelligenceVirusTotalIntelligence } from "../funcs/intelligence-virus-total-intelligence.js";
 import { EventStream } from "../lib/event-streams.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
@@ -134,6 +135,23 @@ export class Intelligence extends ClientSDK {
     ));
   }
 
+  /**
+   * VirusTotal File Intelligence
+   *
+   * @remarks
+   * Look up VirusTotal reputation and antivirus detection data for a URL, domain, IP address, or file hash.
+   */
+  async virusTotalIntelligence(
+    request: operations.VirusTotalIntelligenceRequest,
+    options?: RequestOptions,
+  ): Promise<operations.VirusTotalIntelligenceResponse> {
+    return unwrapAsync(intelligenceVirusTotalIntelligence(
+      this,
+      request,
+      options,
+    ));
+  }
+
   /**
    * Web Databases
    *

package/src/sdk/tools.ts

@@ -4,6 +4,7 @@
 
 import { toolsBypassDoubleCounter } from "../funcs/tools-bypass-double-counter.js";
 import { toolsDownloadIntelxFile } from "../funcs/tools-download-intelx-file.js";
+import { toolsDownloadVirusTotalFile } from "../funcs/tools-download-virus-total-file.js";
 import { toolsLookupDiscordAlt } from "../funcs/tools-lookup-discord-alt.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as operations from "../models/operations/index.js";
@@ -60,4 +61,21 @@ export class Tools extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Download VirusTotal file
+   *
+   * @remarks
+   * Download a file from VirusTotal by its id. The file is returned base64-encoded.
+   */
+  async downloadVirusTotalFile(
+    request: operations.DownloadVirusTotalFileRequest,
+    options?: RequestOptions,
+  ): Promise<operations.DownloadVirusTotalFileResponse> {
+    return unwrapAsync(toolsDownloadVirusTotalFile(
+      this,
+      request,
+      options,
+    ));
+  }
 }