@indiciaosint/sdk 1.2.1 → 1.2.2

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.1",
+  sdkVersion: "1.2.2",
   genVersion: "2.912.1",
-  userAgent: "speakeasy-sdk/typescript 1.2.1 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;

package/src/models/operations/search-web-databases.ts

@@ -26,13 +26,13 @@ export type SearchWebDatabasesService = ClosedEnum<
 >;
 
 export const CloudsintType = {
+  Any: "any",
+  Domain: "domain",
   Email: "email",
   Ip: "ip",
   Name: "name",
   Password: "password",
   Phone: "phone",
-  Steamid: "steamid",
-  Url: "url",
   Username: "username",
 } as const;
 export type CloudsintType = ClosedEnum<typeof CloudsintType>;

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

@@ -0,0 +1,190 @@
+/*
+ * 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 { Result as SafeParseResult } from "../../types/fp.js";
+import * as types from "../../types/primitives.js";
+import { SDKValidationError } from "../errors/sdk-validation-error.js";
+
+export type VirusTotalContentRequest = {
+  content: string;
+};
+
+export type VirusTotalContentFile = {
+  id: string;
+  cleanCount?: number | undefined;
+  contentSnippet?: string | undefined;
+  detectionRatio?: string | undefined;
+  fileName?: string | undefined;
+  fileNames?: Array<string> | undefined;
+  fileSize?: number | undefined;
+  fileType?: string | undefined;
+  firstSubmissionDate?: string | undefined;
+  lastAnalysisDate?: string | undefined;
+  maliciousCount?: number | undefined;
+  md5?: string | undefined;
+  permalink?: string | undefined;
+  reputation?: string | undefined;
+  sha1?: string | undefined;
+  sha256?: string | undefined;
+  suspiciousCount?: number | undefined;
+  threatNames?: Array<string> | undefined;
+  totalEngines?: number | undefined;
+  undetectedCount?: number | undefined;
+};
+
+export type VirusTotalContentData = {
+  files: Array<VirusTotalContentFile>;
+  searchQuery: string;
+  totalResults: number;
+  cleanFiles?: number | undefined;
+  contentType?: string | undefined;
+  maliciousFiles?: number | undefined;
+  suspiciousFiles?: number | undefined;
+};
+
+/**
+ * Search successful
+ */
+export type VirusTotalContentResponse = {
+  data: VirusTotalContentData;
+  success: boolean;
+  error?: string | undefined;
+};
+
+/** @internal */
+export type VirusTotalContentRequest$Outbound = {
+  content: string;
+};
+
+/** @internal */
+export const VirusTotalContentRequest$outboundSchema: z.ZodMiniType<
+  VirusTotalContentRequest$Outbound,
+  VirusTotalContentRequest
+> = z.object({
+  content: z.string(),
+});
+
+export function virusTotalContentRequestToJSON(
+  virusTotalContentRequest: VirusTotalContentRequest,
+): string {
+  return JSON.stringify(
+    VirusTotalContentRequest$outboundSchema.parse(virusTotalContentRequest),
+  );
+}
+
+/** @internal */
+export const VirusTotalContentFile$inboundSchema: z.ZodMiniType<
+  VirusTotalContentFile,
+  unknown
+> = z.pipe(
+  z.object({
+    id: types.string(),
+    clean_count: types.optional(types.number()),
+    content_snippet: types.optional(types.string()),
+    detection_ratio: types.optional(types.string()),
+    file_name: types.optional(types.string()),
+    file_names: types.optional(z.array(types.string())),
+    file_size: types.optional(types.number()),
+    file_type: types.optional(types.string()),
+    first_submission_date: types.optional(types.string()),
+    last_analysis_date: types.optional(types.string()),
+    malicious_count: types.optional(types.number()),
+    md5: types.optional(types.string()),
+    permalink: types.optional(types.string()),
+    reputation: types.optional(types.string()),
+    sha1: types.optional(types.string()),
+    sha256: types.optional(types.string()),
+    suspicious_count: types.optional(types.number()),
+    threat_names: types.optional(z.array(types.string())),
+    total_engines: types.optional(types.number()),
+    undetected_count: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "clean_count": "cleanCount",
+      "content_snippet": "contentSnippet",
+      "detection_ratio": "detectionRatio",
+      "file_name": "fileName",
+      "file_names": "fileNames",
+      "file_size": "fileSize",
+      "file_type": "fileType",
+      "first_submission_date": "firstSubmissionDate",
+      "last_analysis_date": "lastAnalysisDate",
+      "malicious_count": "maliciousCount",
+      "suspicious_count": "suspiciousCount",
+      "threat_names": "threatNames",
+      "total_engines": "totalEngines",
+      "undetected_count": "undetectedCount",
+    });
+  }),
+);
+
+export function virusTotalContentFileFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalContentFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalContentFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalContentFile' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirusTotalContentData$inboundSchema: z.ZodMiniType<
+  VirusTotalContentData,
+  unknown
+> = z.pipe(
+  z.object({
+    files: z.array(z.lazy(() => VirusTotalContentFile$inboundSchema)),
+    search_query: types.string(),
+    total_results: types.number(),
+    clean_files: types.optional(types.number()),
+    content_type: types.optional(types.string()),
+    malicious_files: types.optional(types.number()),
+    suspicious_files: types.optional(types.number()),
+  }),
+  z.transform((v) => {
+    return remap$(v, {
+      "search_query": "searchQuery",
+      "total_results": "totalResults",
+      "clean_files": "cleanFiles",
+      "content_type": "contentType",
+      "malicious_files": "maliciousFiles",
+      "suspicious_files": "suspiciousFiles",
+    });
+  }),
+);
+
+export function virusTotalContentDataFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalContentData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalContentData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalContentData' from JSON`,
+  );
+}
+
+/** @internal */
+export const VirusTotalContentResponse$inboundSchema: z.ZodMiniType<
+  VirusTotalContentResponse,
+  unknown
+> = z.object({
+  data: z.lazy(() => VirusTotalContentData$inboundSchema),
+  success: types.boolean(),
+  error: types.optional(types.string()),
+});
+
+export function virusTotalContentResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<VirusTotalContentResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VirusTotalContentResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VirusTotalContentResponse' from JSON`,
+  );
+}