vanta-auditor-api-sdk 0.1.1 → 0.3.0

package/src/mcp-server/tools/auditsListComments.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { auditsListComments } from "../../funcs/auditsListComments.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListAuditCommentsRequest$inboundSchema,
+};
+
+export const tool$auditsListComments: ToolDefinition<typeof args> = {
+  name: "audits-list-comments",
+  description: `List audit comments
+
+Returns a paginated list of comments for an audit.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await auditsListComments(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/auditsListControls.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { auditsListControls } from "../../funcs/auditsListControls.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListAuditControlsRequest$inboundSchema,
+};
+
+export const tool$auditsListControls: ToolDefinition<typeof args> = {
+  name: "audits-list-controls",
+  description: `List audit controls
+
+Returns a paginated list of controls for an audit.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await auditsListControls(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/auditsListEvidence.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { auditsListEvidence } from "../../funcs/auditsListEvidence.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.ListAuditEvidenceRequest$inboundSchema,
+};
+
+export const tool$auditsListEvidence: ToolDefinition<typeof args> = {
+  name: "audits-list-evidence",
+  description: `List audit evidence
+
+Returns a paginated list of evidence for an audit.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await auditsListEvidence(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/auditsUpdateEvidence.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { auditsUpdateEvidence } from "../../funcs/auditsUpdateEvidence.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.UpdateAuditEvidenceRequest$inboundSchema,
+};
+
+export const tool$auditsUpdateEvidence: ToolDefinition<typeof args> = {
+  name: "audits-update-evidence",
+  description: `Update audit evidence
+
+Update audit evidence.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await auditsUpdateEvidence(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools.ts

@@ -0,0 +1,129 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { RequestHandlerExtra } from "@modelcontextprotocol/sdk/shared/protocol.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { objectOutputType, ZodRawShape, ZodTypeAny } from "zod";
+import { VantaCore } from "../core.js";
+import { ConsoleLogger } from "./console-logger.js";
+import { MCPScope } from "./scopes.js";
+import { isAsyncIterable, isBinaryData, valueToBase64 } from "./shared.js";
+
+export type ToolDefinition<Args extends undefined | ZodRawShape = undefined> =
+  Args extends ZodRawShape ? {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args: Args;
+      tool: (
+        client: VantaCore,
+        args: objectOutputType<Args, ZodTypeAny>,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    }
+    : {
+      name: string;
+      description: string;
+      scopes?: MCPScope[];
+      args?: undefined;
+      tool: (
+        client: VantaCore,
+        extra: RequestHandlerExtra,
+      ) => CallToolResult | Promise<CallToolResult>;
+    };
+
+// Optional function to assist with formatting tool results
+export async function formatResult(
+  value: unknown,
+  init: { response?: Response | undefined },
+): Promise<CallToolResult> {
+  if (typeof value === "undefined") {
+    return { content: [] };
+  }
+
+  const { response } = init;
+  const contentType = response?.headers.get("content-type") ?? "";
+  let content: CallToolResult["content"] = [];
+
+  if (contentType.search(/\bjson\b/g)) {
+    content = [{ type: "text", text: JSON.stringify(value) }];
+  } else if (
+    contentType.startsWith("text/event-stream")
+    && isAsyncIterable(value)
+  ) {
+    content = await consumeSSE(value);
+  } else if (contentType.startsWith("text/") && typeof value === "string") {
+    content = [{ type: "text", text: value }];
+  } else if (isBinaryData(value) && contentType.startsWith("image/")) {
+    const data = await valueToBase64(value);
+    content = data == null
+      ? []
+      : [{ type: "image", data, mimeType: contentType }];
+  } else {
+    return {
+      content: [{
+        type: "text",
+        text: `Unsupported content type: "${contentType}"`,
+      }],
+      isError: true,
+    };
+  }
+
+  return { content };
+}
+
+async function consumeSSE(
+  value: AsyncIterable<unknown>,
+): Promise<CallToolResult["content"]> {
+  const content: CallToolResult["content"] = [];
+
+  for await (const chunk of value) {
+    if (typeof chunk === "string") {
+      content.push({ type: "text", text: chunk });
+    } else {
+      content.push({ type: "text", text: JSON.stringify(chunk) });
+    }
+  }
+
+  return content;
+}
+
+export function createRegisterTool(
+  logger: ConsoleLogger,
+  server: McpServer,
+  sdk: VantaCore,
+  allowedScopes: Set<MCPScope>,
+  allowedTools?: Set<string>,
+): <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>) => void {
+  return <A extends ZodRawShape | undefined>(tool: ToolDefinition<A>): void => {
+    if (allowedTools && !allowedTools.has(tool.name)) {
+      return;
+    }
+
+    const scopes = tool.scopes ?? [];
+    if (allowedScopes.size > 0 && scopes.length === 0) {
+      return;
+    }
+
+    if (
+      allowedScopes.size > 0
+      && !scopes.every((s: MCPScope) => allowedScopes.has(s))
+    ) {
+      return;
+    }
+
+    if (tool.args) {
+      server.tool(tool.name, tool.description, tool.args, async (args, ctx) => {
+        return tool.tool(sdk, args, ctx);
+      });
+    } else {
+      server.tool(tool.name, tool.description, async (ctx) => {
+        return tool.tool(sdk, ctx);
+      });
+    }
+
+    logger.debug("Registered tool", { name: tool.name });
+  };
+}

package/src/models/components/audit.ts

@@ -6,6 +6,11 @@ import * as z from "zod";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AuditFocus,
+  AuditFocus$inboundSchema,
+  AuditFocus$outboundSchema,
+} from "./auditfocus.js";
 
 export type Audit = {
   /**
@@ -35,7 +40,7 @@ export type Audit = {
   /**
    * Timestamp at which auditors gain access to the audit. Occurs before the audit window begins
    */
-  earlyAccessStartsDate: Date | null;
+  earlyAccessStartsAt: Date | null;
   /**
    * The name of the framework for the audit
    */
@@ -64,6 +69,7 @@ export type Audit = {
    * Timestamp when the audit was marked completed, and report was uploaded
    */
   completionDate: Date | null;
+  auditFocus: AuditFocus;
 };
 
 /** @internal */
@@ -79,7 +85,7 @@ export const Audit$inboundSchema: z.ZodType<Audit, z.ZodTypeDef, unknown> = z
     auditEndDate: z.string().datetime({ offset: true }).transform(v =>
       new Date(v)
     ),
-    earlyAccessStartsDate: z.nullable(
+    earlyAccessStartsAt: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ),
     framework: z.string(),
@@ -97,6 +103,7 @@ export const Audit$inboundSchema: z.ZodType<Audit, z.ZodTypeDef, unknown> = z
     completionDate: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ),
+    auditFocus: AuditFocus$inboundSchema,
   });
 
 /** @internal */
@@ -107,7 +114,7 @@ export type Audit$Outbound = {
   customerOrganizationId: string;
   auditStartDate: string;
   auditEndDate: string;
-  earlyAccessStartsDate: string | null;
+  earlyAccessStartsAt: string | null;
   framework: string;
   allowAuditorEmails: Array<string>;
   allowAllAuditors: boolean;
@@ -115,6 +122,7 @@ export type Audit$Outbound = {
   creationDate: string;
   modificationDate: string | null;
   completionDate: string | null;
+  auditFocus: string;
 };
 
 /** @internal */
@@ -129,7 +137,7 @@ export const Audit$outboundSchema: z.ZodType<
   customerOrganizationId: z.string(),
   auditStartDate: z.date().transform(v => v.toISOString()),
   auditEndDate: z.date().transform(v => v.toISOString()),
-  earlyAccessStartsDate: z.nullable(z.date().transform(v => v.toISOString())),
+  earlyAccessStartsAt: z.nullable(z.date().transform(v => v.toISOString())),
   framework: z.string(),
   allowAuditorEmails: z.array(z.string()),
   allowAllAuditors: z.boolean(),
@@ -137,6 +145,7 @@ export const Audit$outboundSchema: z.ZodType<
   creationDate: z.date().transform(v => v.toISOString()),
   modificationDate: z.nullable(z.date().transform(v => v.toISOString())),
   completionDate: z.nullable(z.date().transform(v => v.toISOString())),
+  auditFocus: AuditFocus$outboundSchema,
 });
 
 /**

package/src/models/components/auditfocus.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const AuditFocus = {
+  External: "EXTERNAL",
+  Internal: "INTERNAL",
+} as const;
+export type AuditFocus = ClosedEnum<typeof AuditFocus>;
+
+/** @internal */
+export const AuditFocus$inboundSchema: z.ZodNativeEnum<typeof AuditFocus> = z
+  .nativeEnum(AuditFocus);
+
+/** @internal */
+export const AuditFocus$outboundSchema: z.ZodNativeEnum<typeof AuditFocus> =
+  AuditFocus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AuditFocus$ {
+  /** @deprecated use `AuditFocus$inboundSchema` instead. */
+  export const inboundSchema = AuditFocus$inboundSchema;
+  /** @deprecated use `AuditFocus$outboundSchema` instead. */
+  export const outboundSchema = AuditFocus$outboundSchema;
+}

package/src/models/components/auditorcontrol.ts

@@ -11,6 +11,18 @@ import {
   ControlSource$inboundSchema,
   ControlSource$outboundSchema,
 } from "./controlsource.js";
+import {
+  CustomField,
+  CustomField$inboundSchema,
+  CustomField$Outbound,
+  CustomField$outboundSchema,
+} from "./customfield.js";
+import {
+  Section,
+  Section$inboundSchema,
+  Section$Outbound,
+  Section$outboundSchema,
+} from "./section.js";
 
 /**
  * The control's owner.
@@ -59,11 +71,19 @@ export type AuditorControl = {
   /**
    * The control's GDPR role, if the control is a GDPR control.
    */
-  role?: string | undefined;
+  role?: string | null | undefined;
+  /**
+   * The control's custom field values, if control custom fields is included in your Vanta instance.
+   */
+  customFields: Array<CustomField>;
   /**
    * The report standard framework fulfilled by the control.
    */
   framework: string;
+  /**
+   * Sections of a framework that this control satisfies
+   */
+  sections: Array<Section>;
 };
 
 /** @internal */
@@ -132,8 +152,10 @@ export const AuditorControl$inboundSchema: z.ZodType<
   source: ControlSource$inboundSchema,
   domains: z.array(z.string()),
   owner: z.nullable(z.lazy(() => Owner$inboundSchema)),
-  role: z.string().optional(),
+  role: z.nullable(z.string()).optional(),
+  customFields: z.array(CustomField$inboundSchema),
   framework: z.string(),
+  sections: z.array(Section$inboundSchema),
 });
 
 /** @internal */
@@ -145,8 +167,10 @@ export type AuditorControl$Outbound = {
   source: string;
   domains: Array<string>;
   owner: Owner$Outbound | null;
-  role?: string | undefined;
+  role?: string | null | undefined;
+  customFields: Array<CustomField$Outbound>;
   framework: string;
+  sections: Array<Section$Outbound>;
 };
 
 /** @internal */
@@ -162,8 +186,10 @@ export const AuditorControl$outboundSchema: z.ZodType<
   source: ControlSource$outboundSchema,
   domains: z.array(z.string()),
   owner: z.nullable(z.lazy(() => Owner$outboundSchema)),
-  role: z.string().optional(),
+  role: z.nullable(z.string()).optional(),
+  customFields: z.array(CustomField$outboundSchema),
   framework: z.string(),
+  sections: z.array(Section$outboundSchema),
 });
 
 /**

package/src/models/components/auditorenabledstatetransition.ts

@@ -10,6 +10,7 @@ export const AuditorEnabledStateTransition = {
   MarkApplicable: "MARK_APPLICABLE",
   Flag: "FLAG",
   MarkNa: "MARK_NA",
+  ReadyForAudit: "READY_FOR_AUDIT",
 } as const;
 export type AuditorEnabledStateTransition = ClosedEnum<
   typeof AuditorEnabledStateTransition

package/src/models/components/comment.ts

@@ -28,6 +28,10 @@ export type Comment = {
    * When the comment was updated
    */
   modificationDate: Date | null;
+  /**
+   * When the comment was deleted
+   */
+  deletionDate: Date | null;
   /**
    * The email of the comment author. This acts as a unique identifier to map users between Vanta and external systems.
    */
@@ -46,6 +50,9 @@ export const Comment$inboundSchema: z.ZodType<Comment, z.ZodTypeDef, unknown> =
     modificationDate: z.nullable(
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ),
+    deletionDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ),
     email: z.nullable(z.string()),
   });
 
@@ -56,6 +63,7 @@ export type Comment$Outbound = {
   text: string;
   creationDate: string;
   modificationDate: string | null;
+  deletionDate: string | null;
   email: string | null;
 };
 
@@ -70,6 +78,7 @@ export const Comment$outboundSchema: z.ZodType<
   text: z.string(),
   creationDate: z.date().transform(v => v.toISOString()),
   modificationDate: z.nullable(z.date().transform(v => v.toISOString())),
+  deletionDate: z.nullable(z.date().transform(v => v.toISOString())),
   email: z.nullable(z.string()),
 });
 

package/src/models/components/control.ts

@@ -11,6 +11,12 @@ import {
   ControlSource$inboundSchema,
   ControlSource$outboundSchema,
 } from "./controlsource.js";
+import {
+  CustomField,
+  CustomField$inboundSchema,
+  CustomField$Outbound,
+  CustomField$outboundSchema,
+} from "./customfield.js";
 
 /**
  * The control's owner.
@@ -59,7 +65,11 @@ export type Control = {
   /**
    * The control's GDPR role, if the control is a GDPR control.
    */
-  role?: string | undefined;
+  role?: string | null | undefined;
+  /**
+   * The control's custom field values, if control custom fields is included in your Vanta instance.
+   */
+  customFields: Array<CustomField>;
 };
 
 /** @internal */
@@ -128,7 +138,8 @@ export const Control$inboundSchema: z.ZodType<Control, z.ZodTypeDef, unknown> =
     source: ControlSource$inboundSchema,
     domains: z.array(z.string()),
     owner: z.nullable(z.lazy(() => ControlOwner$inboundSchema)),
-    role: z.string().optional(),
+    role: z.nullable(z.string()).optional(),
+    customFields: z.array(CustomField$inboundSchema),
   });
 
 /** @internal */
@@ -140,7 +151,8 @@ export type Control$Outbound = {
   source: string;
   domains: Array<string>;
   owner: ControlOwner$Outbound | null;
-  role?: string | undefined;
+  role?: string | null | undefined;
+  customFields: Array<CustomField$Outbound>;
 };
 
 /** @internal */
@@ -156,7 +168,8 @@ export const Control$outboundSchema: z.ZodType<
   source: ControlSource$outboundSchema,
   domains: z.array(z.string()),
   owner: z.nullable(z.lazy(() => ControlOwner$outboundSchema)),
-  role: z.string().optional(),
+  role: z.nullable(z.string()).optional(),
+  customFields: z.array(CustomField$outboundSchema),
 });
 
 /**

package/src/models/components/createcustomevidencerequestinput.ts

@@ -31,6 +31,10 @@ export type CreateCustomEvidenceRequestInput = {
    * Whether this document contains sensitive data and needs more restrictive read access
    */
   isRestricted: boolean;
+  /**
+   * Email of the auditor who created the custom evidence request.
+   */
+  auditorEmail: string;
 };
 
 /** @internal */
@@ -45,6 +49,7 @@ export const CreateCustomEvidenceRequestInput$inboundSchema: z.ZodType<
   cadence: RecurrenceDuration$inboundSchema,
   reminderWindow: RecurrenceDuration$inboundSchema,
   isRestricted: z.boolean(),
+  auditorEmail: z.string(),
 });
 
 /** @internal */
@@ -55,6 +60,7 @@ export type CreateCustomEvidenceRequestInput$Outbound = {
   cadence: string;
   reminderWindow: string;
   isRestricted: boolean;
+  auditorEmail: string;
 };
 
 /** @internal */
@@ -69,6 +75,7 @@ export const CreateCustomEvidenceRequestInput$outboundSchema: z.ZodType<
   cadence: RecurrenceDuration$outboundSchema,
   reminderWindow: RecurrenceDuration$outboundSchema,
   isRestricted: z.boolean(),
+  auditorEmail: z.string(),
 });
 
 /**