vanta-auditor-api-sdk 0.4.2 → 0.5.0

package/src/models/components/vantadocumentevidence.ts

@@ -0,0 +1,145 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VantaDocumentLinkEvidence,
+  VantaDocumentLinkEvidence$inboundSchema,
+} from "./vantadocumentlinkevidence.js";
+import {
+  VantaDocumentUploadedEvidence,
+  VantaDocumentUploadedEvidence$inboundSchema,
+} from "./vantadocumentuploadedevidence.js";
+
+/**
+ * Information about the user who added this file version to the document.
+ *
+ * @remarks
+ * Undefined if the user information is not available.
+ */
+export type AddedBy = {
+  email: string;
+  name: string;
+};
+
+/**
+ * The file or link associated with this document version.
+ *
+ * @remarks
+ * Use the `type` discriminator to determine whether it's an uploaded file
+ * or an external link.
+ */
+export type FileT = VantaDocumentUploadedEvidence | VantaDocumentLinkEvidence;
+
+/**
+ * Evidence in the form of a Vanta Document.
+ *
+ * @remarks
+ * Vanta Documents are managed documents with metadata like expiration dates
+ * and versioning. They can either be uploaded files stored in Vanta or
+ * links to external documentation.
+ */
+export type VantaDocumentEvidence = {
+  /**
+   * The title of the document as displayed in Vanta.
+   */
+  title: string;
+  /**
+   * Optional description providing additional context about the document.
+   */
+  description?: string | undefined;
+  /**
+   * The date when the document version expires and should be renewed.
+   *
+   * @remarks
+   * Undefined if no expiration is set.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  expirationDate?: Date | undefined;
+  /**
+   * Information about the user who added this file version to the document.
+   *
+   * @remarks
+   * Undefined if the user information is not available.
+   */
+  addedBy?: AddedBy | undefined;
+  /**
+   * The unique identifier of the document version submitted as evidence.
+   */
+  documentVersionId: string;
+  /**
+   * The file or link associated with this document version.
+   *
+   * @remarks
+   * Use the `type` discriminator to determine whether it's an uploaded file
+   * or an external link.
+   */
+  file: VantaDocumentUploadedEvidence | VantaDocumentLinkEvidence;
+};
+
+/** @internal */
+export const AddedBy$inboundSchema: z.ZodType<AddedBy, z.ZodTypeDef, unknown> =
+  z.object({
+    email: z.string(),
+    name: z.string(),
+  });
+
+export function addedByFromJSON(
+  jsonString: string,
+): SafeParseResult<AddedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AddedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AddedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const FileT$inboundSchema: z.ZodType<FileT, z.ZodTypeDef, unknown> = z
+  .union([
+    VantaDocumentUploadedEvidence$inboundSchema,
+    VantaDocumentLinkEvidence$inboundSchema,
+  ]);
+
+export function fileFromJSON(
+  jsonString: string,
+): SafeParseResult<FileT, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FileT$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FileT' from JSON`,
+  );
+}
+
+/** @internal */
+export const VantaDocumentEvidence$inboundSchema: z.ZodType<
+  VantaDocumentEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  description: z.string().optional(),
+  expirationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  addedBy: z.lazy(() => AddedBy$inboundSchema).optional(),
+  documentVersionId: z.string(),
+  file: z.union([
+    VantaDocumentUploadedEvidence$inboundSchema,
+    VantaDocumentLinkEvidence$inboundSchema,
+  ]),
+});
+
+export function vantaDocumentEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaDocumentEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaDocumentEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaDocumentEvidence' from JSON`,
+  );
+}

package/src/models/components/vantadocumentlinkevidence.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Represents an external link in a Vanta Document.
+ *
+ * @remarks
+ * The link points to documentation hosted outside of Vanta's system.
+ */
+export type VantaDocumentLinkEvidence = {
+  /**
+   * Discriminator to identify this as an external link.
+   */
+  type: "link";
+  /**
+   * The unique identifier for the file version in Vanta's system.
+   */
+  id: string;
+  /**
+   * The URL pointing to the external documentation or resource.
+   */
+  url: string;
+};
+
+/** @internal */
+export const VantaDocumentLinkEvidence$inboundSchema: z.ZodType<
+  VantaDocumentLinkEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("link"),
+  id: z.string(),
+  url: z.string(),
+});
+
+export function vantaDocumentLinkEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaDocumentLinkEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaDocumentLinkEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaDocumentLinkEvidence' from JSON`,
+  );
+}

package/src/models/components/vantadocumentuploadedevidence.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Represents an uploaded file in a Vanta Document.
+ *
+ * @remarks
+ * The file is stored in Vanta's system and accessed via a presigned URL.
+ */
+export type VantaDocumentUploadedEvidence = {
+  /**
+   * Discriminator to identify this as an uploaded file.
+   */
+  type: "uploaded";
+  /**
+   * The unique identifier for the file version in Vanta's system.
+   */
+  id: string;
+  /**
+   * The original filename of the uploaded document.
+   *
+   * @remarks
+   * Undefined if the filename was not captured during upload.
+   */
+  filename?: string | undefined;
+  /**
+   * The MIME type of the document indicating its file format.
+   *
+   * @remarks
+   * Common types: "application/pdf", "image/png", "image/jpeg", "text/plain"
+   */
+  mimeType: string;
+  /**
+   * A presigned URL for downloading the document.
+   *
+   * @remarks
+   * This URL is temporary and expires after a limited time.
+   * Request a new evidence list to get a fresh URL if expired.
+   */
+  url: string;
+};
+
+/** @internal */
+export const VantaDocumentUploadedEvidence$inboundSchema: z.ZodType<
+  VantaDocumentUploadedEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("uploaded"),
+  id: z.string(),
+  filename: z.string().optional(),
+  mimeType: z.string(),
+  url: z.string(),
+});
+
+export function vantaDocumentUploadedEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaDocumentUploadedEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaDocumentUploadedEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaDocumentUploadedEvidence' from JSON`,
+  );
+}

package/src/models/components/vantapolicyevidence.ts

@@ -0,0 +1,198 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Information about the user who last edited this policy version.
+ *
+ * @remarks
+ * Undefined if the user information is not available.
+ */
+export type LastEditedBy = {
+  email: string;
+  name: string;
+};
+
+/**
+ * The uploaded policy file for this version.
+ */
+export type VantaPolicyEvidenceFile = {
+  /**
+   * The date when this policy version became effective, or when it was created.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  effectiveOrCreationDate: Date;
+  /**
+   * The locale/language of the policy document.
+   *
+   * @remarks
+   * Examples: "EN" for English, "ES" for Spanish, "FR" for French
+   */
+  locale: string;
+  /**
+   * A presigned URL for downloading the policy document.
+   *
+   * @remarks
+   * This URL is temporary and expires after a limited time.
+   * Request a new evidence list to get a fresh URL if expired.
+   */
+  url: string;
+  /**
+   * The MIME type of the policy document indicating its file format.
+   *
+   * @remarks
+   * Common types: "application/pdf", "application/msword"
+   */
+  mimeType: string;
+  /**
+   * The original filename of the uploaded policy document.
+   *
+   * @remarks
+   * Undefined if the filename was not captured during upload.
+   */
+  filename?: string | undefined;
+  /**
+   * The unique identifier for the uploaded policy file in Vanta's system.
+   */
+  id: string;
+};
+
+/**
+ * Evidence in the form of a Vanta Policy.
+ *
+ * @remarks
+ * Vanta Policies are compliance policies with metadata like locale,
+ * effective dates, and versioning. Policies are always uploaded files
+ * stored in Vanta's system.
+ */
+export type VantaPolicyEvidence = {
+  /**
+   * The title of the policy as displayed in Vanta.
+   */
+  title: string;
+  /**
+   * Optional description providing additional context about the policy.
+   */
+  description?: string | undefined;
+  /**
+   * The date when the policy version expires and should be renewed.
+   *
+   * @remarks
+   * Undefined if no expiration is set.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  expirationDate?: Date | undefined;
+  /**
+   * Information about the user who last edited this policy version.
+   *
+   * @remarks
+   * Undefined if the user information is not available.
+   */
+  lastEditedBy?: LastEditedBy | undefined;
+  /**
+   * The policy type this evidence belongs to (e.g. "information-security-policy-bsi").
+   *
+   * @remarks
+   * Policies prefixed with "custom-" are customer-defined; others are Vanta-provided templates.
+   */
+  policyId: string;
+  /**
+   * The identifier of the approved policy version that was submitted as evidence.
+   *
+   * @remarks
+   * A new version is created each time a policy is updated and approved.
+   */
+  policyVersionId: string;
+  /**
+   * The identifier of the locale-specific file within the policy version.
+   *
+   * @remarks
+   * Each policy version may contain multiple files, one per supported language.
+   */
+  policyVersionFileId: string;
+  /**
+   * The uploaded policy file for this version.
+   */
+  file: VantaPolicyEvidenceFile;
+};
+
+/** @internal */
+export const LastEditedBy$inboundSchema: z.ZodType<
+  LastEditedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: z.string(),
+  name: z.string(),
+});
+
+export function lastEditedByFromJSON(
+  jsonString: string,
+): SafeParseResult<LastEditedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LastEditedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LastEditedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const VantaPolicyEvidenceFile$inboundSchema: z.ZodType<
+  VantaPolicyEvidenceFile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  effectiveOrCreationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  locale: z.string(),
+  url: z.string(),
+  mimeType: z.string(),
+  filename: z.string().optional(),
+  id: z.string(),
+});
+
+export function vantaPolicyEvidenceFileFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaPolicyEvidenceFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaPolicyEvidenceFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaPolicyEvidenceFile' from JSON`,
+  );
+}
+
+/** @internal */
+export const VantaPolicyEvidence$inboundSchema: z.ZodType<
+  VantaPolicyEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  description: z.string().optional(),
+  expirationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  lastEditedBy: z.lazy(() => LastEditedBy$inboundSchema).optional(),
+  policyId: z.string(),
+  policyVersionId: z.string(),
+  policyVersionFileId: z.string(),
+  file: z.lazy(() => VantaPolicyEvidenceFile$inboundSchema),
+});
+
+export function vantaPolicyEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaPolicyEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaPolicyEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaPolicyEvidence' from JSON`,
+  );
+}

package/src/models/components/vantatestevidence.ts

@@ -0,0 +1,122 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  VantaTestFileType,
+  VantaTestFileType$inboundSchema,
+} from "./vantatestfiletype.js";
+import {
+  VantaTestRunStatus,
+  VantaTestRunStatus$inboundSchema,
+} from "./vantatestrunstatus.js";
+
+/**
+ * The evidence file for this test run.
+ */
+export type VantaTestEvidenceFile = {
+  /**
+   * The MIME type of the evidence file.
+   *
+   * @remarks
+   * Common types: "application/pdf" for workpapers, "text/csv" for raw data
+   */
+  mimeType: string;
+  /**
+   * A presigned URL for downloading the evidence file.
+   *
+   * @remarks
+   * This URL is temporary and expires after a limited time.
+   * Request a new evidence list to get a fresh URL if expired.
+   */
+  url: string;
+};
+
+/**
+ * Evidence in the form of a Vanta automated test run.
+ *
+ * @remarks
+ * Vanta Tests are automated compliance tests with metadata like test status,
+ * execution time, and file type. Tests generate evidence files that can be
+ * workpapers, raw data, or API request logs.
+ */
+export type VantaTestEvidence = {
+  /**
+   * The title of the test run as displayed in Vanta.
+   */
+  title: string;
+  /**
+   * The unique identifier for the test in Vanta's system.
+   */
+  testId: string;
+  /**
+   * The unique identifier for the point-in-time capture of this test run's evidence.
+   *
+   * @remarks
+   * A snapshot is an immutable record of all files (workpapers, raw data, etc.)
+   * generated during a single test execution.
+   */
+  snapshotId: string;
+  testRunStatus: VantaTestRunStatus;
+  /**
+   * The date and time when the test was executed.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  executedAt: Date;
+  fileType: VantaTestFileType;
+  /**
+   * The evidence file for this test run.
+   */
+  file: VantaTestEvidenceFile;
+};
+
+/** @internal */
+export const VantaTestEvidenceFile$inboundSchema: z.ZodType<
+  VantaTestEvidenceFile,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mimeType: z.string(),
+  url: z.string(),
+});
+
+export function vantaTestEvidenceFileFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestEvidenceFile, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestEvidenceFile$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestEvidenceFile' from JSON`,
+  );
+}
+
+/** @internal */
+export const VantaTestEvidence$inboundSchema: z.ZodType<
+  VantaTestEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  testId: z.string(),
+  snapshotId: z.string(),
+  testRunStatus: VantaTestRunStatus$inboundSchema,
+  executedAt: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  fileType: VantaTestFileType$inboundSchema,
+  file: z.lazy(() => VantaTestEvidenceFile$inboundSchema),
+});
+
+export function vantaTestEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestEvidence' from JSON`,
+  );
+}

package/src/models/components/vantatestfiletype.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const VantaTestFileType = {
+  TestEvidenceWorkpaper: "TEST_EVIDENCE_WORKPAPER",
+  TestRawData: "TEST_RAW_DATA",
+  OutOfScopeResources: "OUT_OF_SCOPE_RESOURCES",
+  ApiRequests: "API_REQUESTS",
+} as const;
+export type VantaTestFileType = ClosedEnum<typeof VantaTestFileType>;
+
+/** @internal */
+export const VantaTestFileType$inboundSchema: z.ZodNativeEnum<
+  typeof VantaTestFileType
+> = z.nativeEnum(VantaTestFileType);

package/src/models/components/vantatestrunstatus.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const VantaTestRunStatus = {
+  Na: "NA",
+  InProgress: "IN_PROGRESS",
+  Pass: "PASS",
+  Fail: "FAIL",
+  Invalid: "INVALID",
+  Disabled: "DISABLED",
+} as const;
+export type VantaTestRunStatus = ClosedEnum<typeof VantaTestRunStatus>;
+
+/** @internal */
+export const VantaTestRunStatus$inboundSchema: z.ZodNativeEnum<
+  typeof VantaTestRunStatus
+> = z.nativeEnum(VantaTestRunStatus);