vanta-auditor-api-sdk 0.4.1 → 0.5.0

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);

package/src/models/components/vantatestsnapshotevidence.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The outcome status of the test run.
+ */
+export const TestRunStatus = {
+  Na: "NA",
+  InProgress: "IN_PROGRESS",
+  Pass: "PASS",
+  Fail: "FAIL",
+  Invalid: "INVALID",
+  Disabled: "DISABLED",
+} as const;
+/**
+ * The outcome status of the test run.
+ */
+export type TestRunStatus = ClosedEnum<typeof TestRunStatus>;
+
+/**
+ * Evidence in the form of a Vanta automated test run snapshot.
+ *
+ * @remarks
+ *
+ * Unlike VantaTestEvidence (which represents a single file within a test run's
+ * evidence packet), a snapshot represents the entire test-run bundle. Use the
+ * dedicated snapshot detail endpoint to retrieve the files associated with a
+ * snapshot.
+ */
+export type VantaTestSnapshotEvidence = {
+  /**
+   * 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;
+  /**
+   * The unique identifier for the test in Vanta's system.
+   */
+  testId: string;
+  /**
+   * The unique identifier for the test run this snapshot was captured from.
+   */
+  testRunId: string;
+  /**
+   * The title of the test run as displayed in Vanta.
+   */
+  testRunTitle: string;
+  /**
+   * The outcome status of the test run.
+   */
+  testRunStatus: TestRunStatus;
+  /**
+   * The date and time when the test was executed.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  testRunExecutedAt: Date;
+};
+
+/** @internal */
+export const TestRunStatus$inboundSchema: z.ZodNativeEnum<
+  typeof TestRunStatus
+> = z.nativeEnum(TestRunStatus);
+
+/** @internal */
+export const VantaTestSnapshotEvidence$inboundSchema: z.ZodType<
+  VantaTestSnapshotEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  snapshotId: z.string(),
+  testId: z.string(),
+  testRunId: z.string(),
+  testRunTitle: z.string(),
+  testRunStatus: TestRunStatus$inboundSchema,
+  testRunExecutedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+});
+
+export function vantaTestSnapshotEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotEvidence' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotevidencedetail.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 {
+  VantaTestSnapshotIntegration,
+  VantaTestSnapshotIntegration$inboundSchema,
+} from "./vantatestsnapshotintegration.js";
+import {
+  VantaTestSnapshotRawTestDataRow,
+  VantaTestSnapshotRawTestDataRow$inboundSchema,
+} from "./vantatestsnapshotrawtestdatarow.js";
+
+export type Settings = {
+  numericValue: number;
+  unit: string | null;
+};
+
+/**
+ * SLA remediation policy attached to the test, or null when no SLA is set.
+ */
+export type SlaRemediation = {
+  id: string;
+  settings: Settings | null;
+};
+
+/**
+ * Detail response for a captured automated-test snapshot evidence row.
+ *
+ * @remarks
+ *
+ * Combines the test-level metadata (description, integrations, SLA
+ * remediation) with a uniform raw-data array so external clients see the
+ * same shape regardless of whether the snapshot was structured or
+ * unstructured.
+ */
+export type VantaTestSnapshotEvidenceDetail = {
+  /**
+   * The unique identifier for the test in Vanta's system.
+   */
+  testId: string;
+  /**
+   * The display name of the test.
+   */
+  testName: string;
+  /**
+   * A short description of what the test checks.
+   */
+  description: string;
+  /**
+   * Longer-form, formatted description of the test. Null when unset.
+   */
+  evaluationCriteria: string | null;
+  /**
+   * Integrations whose data feeds the test.
+   */
+  integrations: Array<VantaTestSnapshotIntegration>;
+  /**
+   * SLA remediation policy attached to the test, or null when no SLA is set.
+   */
+  slaRemediation: SlaRemediation | null;
+  /**
+   * Raw test data captured at snapshot time.
+   */
+  rawTestData: Array<VantaTestSnapshotRawTestDataRow>;
+};
+
+/** @internal */
+export const Settings$inboundSchema: z.ZodType<
+  Settings,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  numericValue: z.number(),
+  unit: z.nullable(z.string()),
+});
+
+export function settingsFromJSON(
+  jsonString: string,
+): SafeParseResult<Settings, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Settings$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Settings' from JSON`,
+  );
+}
+
+/** @internal */
+export const SlaRemediation$inboundSchema: z.ZodType<
+  SlaRemediation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  settings: z.nullable(z.lazy(() => Settings$inboundSchema)),
+});
+
+export function slaRemediationFromJSON(
+  jsonString: string,
+): SafeParseResult<SlaRemediation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SlaRemediation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SlaRemediation' from JSON`,
+  );
+}
+
+/** @internal */
+export const VantaTestSnapshotEvidenceDetail$inboundSchema: z.ZodType<
+  VantaTestSnapshotEvidenceDetail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  testId: z.string(),
+  testName: z.string(),
+  description: z.string(),
+  evaluationCriteria: z.nullable(z.string()),
+  integrations: z.array(VantaTestSnapshotIntegration$inboundSchema),
+  slaRemediation: z.nullable(z.lazy(() => SlaRemediation$inboundSchema)),
+  rawTestData: z.array(VantaTestSnapshotRawTestDataRow$inboundSchema),
+});
+
+export function vantaTestSnapshotEvidenceDetailFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotEvidenceDetail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotEvidenceDetail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotEvidenceDetail' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotintegration.ts

@@ -0,0 +1,36 @@
+/*
+ * 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";
+
+/**
+ * Integration metadata for a test, mirroring the Vanta web app.
+ */
+export type VantaTestSnapshotIntegration = {
+  integrationId: string;
+  displayName: string;
+};
+
+/** @internal */
+export const VantaTestSnapshotIntegration$inboundSchema: z.ZodType<
+  VantaTestSnapshotIntegration,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  integrationId: z.string(),
+  displayName: z.string(),
+});
+
+export function vantaTestSnapshotIntegrationFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotIntegration, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotIntegration$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotIntegration' from JSON`,
+  );
+}

package/src/models/components/vantatestsnapshotrawtestdatarow.ts

@@ -0,0 +1,64 @@
+/*
+ * 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";
+
+/**
+ * One row of raw test data attached to a snapshot.
+ *
+ * @remarks
+ *
+ * For structured snapshots, every row carries the resource refs and the raw
+ * JSON for that resource. For unstructured snapshots, a single row is returned
+ * with `resourceId` and `resourceType` set to `null` and `rawJson` containing
+ * the entire test-run JSON blob.
+ */
+export type VantaTestSnapshotRawTestDataRow = {
+  /**
+   * Identifier of the underlying resource the row was captured from. Null for
+   *
+   * @remarks
+   * unstructured snapshots, which do not partition by resource.
+   */
+  resourceId: string | null;
+  /**
+   * Specific resource kind for the row (e.g. `AwsIamUser`). Null for
+   *
+   * @remarks
+   * unstructured snapshots.
+   */
+  resourceType: string | null;
+  /**
+   * Raw JSON payload as emitted by the test runner. Shape varies by
+   *
+   * @remarks
+   * `resourceType` for structured snapshots and matches the full test-run
+   * blob for unstructured snapshots.
+   */
+  rawJson?: any | undefined;
+};
+
+/** @internal */
+export const VantaTestSnapshotRawTestDataRow$inboundSchema: z.ZodType<
+  VantaTestSnapshotRawTestDataRow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  resourceId: z.nullable(z.string()),
+  resourceType: z.nullable(z.string()),
+  rawJson: z.any().optional(),
+});
+
+export function vantaTestSnapshotRawTestDataRowFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaTestSnapshotRawTestDataRow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaTestSnapshotRawTestDataRow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaTestSnapshotRawTestDataRow' from JSON`,
+  );
+}