vanta-auditor-api-sdk 0.4.2 → 0.5.0

package/src/models/components/informationrequestcomment.ts

@@ -0,0 +1,105 @@
+/*
+ * 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";
+
+/**
+ * A comment on an information request enables communication between auditors
+ *
+ * @remarks
+ * and customers regarding evidence requirements and submissions.
+ *
+ * These threaded discussions help clarify requests, explain or resolve questions about evidence,
+ * and are always visible to both parties once created.
+ */
+export type InformationRequestComment = {
+  /**
+   * The unique identifier for the comment within Vanta's system.
+   *
+   * @remarks
+   * Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7").
+   */
+  id: string;
+  /**
+   * The comment message content.
+   *
+   * @remarks
+   * Can include explanations, questions, or clarifications about the information request.
+   */
+  text: string;
+  /**
+   * Timestamp when the comment was created.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  creationDate: Date;
+  /**
+   * Timestamp when the comment was last edited.
+   *
+   * @remarks
+   * Null if the comment has never been modified.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  modificationDate: Date | null;
+  /**
+   * Timestamp when the comment was soft-deleted.
+   *
+   * @remarks
+   * Null if the comment has not been deleted.
+   * Soft deletes retain the comment for audit history while hiding it from normal operations.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  deletionDate: Date | null;
+  /**
+   * Email address of the comment author.
+   *
+   * @remarks
+   * This email uniquely identifies users between Vanta and external audit systems.
+   */
+  email: string | null;
+  /**
+   * Human-readable display name of the comment author.
+   *
+   * @remarks
+   * Null if the author's name is not available (e.g., user was deleted).
+   * This enables correct author attribution in integrations where users cannot
+   * be reliably matched across systems by email alone.
+   */
+  authorName: string | null;
+};
+
+/** @internal */
+export const InformationRequestComment$inboundSchema: z.ZodType<
+  InformationRequestComment,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  text: z.string(),
+  creationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  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()),
+  authorName: z.nullable(z.string()),
+});
+
+export function informationRequestCommentFromJSON(
+  jsonString: string,
+): SafeParseResult<InformationRequestComment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InformationRequestComment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InformationRequestComment' from JSON`,
+  );
+}

package/src/models/components/informationrequestevidence.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 { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  InformationRequestEvidenceUnion,
+  InformationRequestEvidenceUnion$inboundSchema,
+} from "./informationrequestevidenceunion.js";
+import {
+  InformationRequestSupportedEvidenceType,
+  InformationRequestSupportedEvidenceType$inboundSchema,
+} from "./informationrequestsupportedevidencetype.js";
+
+export type InformationRequestEvidence = {
+  /**
+   * The unique identifier for the evidence within Vanta's system.
+   *
+   * @remarks
+   * Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7").
+   */
+  id: string;
+  evidenceType: InformationRequestSupportedEvidenceType;
+  /**
+   * Timestamp when the evidence was made visible to the auditor.
+   *
+   * @remarks
+   * Null if the customer has not yet shared this evidence with the auditor.
+   * Evidence must be shared before the auditor can review it.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  visibleToAuditorDate?: Date | null | undefined;
+  /**
+   * Timestamp when the evidence was created/uploaded.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  creationDate: Date;
+  /**
+   * Timestamp when the evidence was last modified.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  modificationDate: Date;
+  /**
+   * Timestamp when the evidence was soft-deleted.
+   *
+   * @remarks
+   * Null if the evidence has not been deleted.
+   * Soft deletes retain evidence in the system for audit history while hiding
+   * it from normal operations.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  deletionDate?: Date | null | undefined;
+  /**
+   * Union type representing the different forms of evidence content.
+   *
+   * @remarks
+   * The specific type is determined by the `evidenceType` field in InformationRequestEvidence.
+   */
+  evidence: InformationRequestEvidenceUnion;
+};
+
+/** @internal */
+export const InformationRequestEvidence$inboundSchema: z.ZodType<
+  InformationRequestEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  evidenceType: InformationRequestSupportedEvidenceType$inboundSchema,
+  visibleToAuditorDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  creationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  modificationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  deletionDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  evidence: InformationRequestEvidenceUnion$inboundSchema,
+});
+
+export function informationRequestEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<InformationRequestEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InformationRequestEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InformationRequestEvidence' from JSON`,
+  );
+}

package/src/models/components/informationrequestevidenceunion.ts

@@ -0,0 +1,73 @@
+/*
+ * 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 { LinkEvidence, LinkEvidence$inboundSchema } from "./linkevidence.js";
+import {
+  ObservationEvidence,
+  ObservationEvidence$inboundSchema,
+} from "./observationevidence.js";
+import {
+  UploadedDocumentEvidence,
+  UploadedDocumentEvidence$inboundSchema,
+} from "./uploadeddocumentevidence.js";
+import {
+  VantaDocumentEvidence,
+  VantaDocumentEvidence$inboundSchema,
+} from "./vantadocumentevidence.js";
+import {
+  VantaPolicyEvidence,
+  VantaPolicyEvidence$inboundSchema,
+} from "./vantapolicyevidence.js";
+import {
+  VantaTestEvidence,
+  VantaTestEvidence$inboundSchema,
+} from "./vantatestevidence.js";
+import {
+  VantaTestSnapshotEvidence,
+  VantaTestSnapshotEvidence$inboundSchema,
+} from "./vantatestsnapshotevidence.js";
+
+/**
+ * Union type representing the different forms of evidence content.
+ *
+ * @remarks
+ * The specific type is determined by the `evidenceType` field in InformationRequestEvidence.
+ */
+export type InformationRequestEvidenceUnion =
+  | VantaTestEvidence
+  | VantaTestSnapshotEvidence
+  | VantaPolicyEvidence
+  | UploadedDocumentEvidence
+  | VantaDocumentEvidence
+  | LinkEvidence
+  | ObservationEvidence;
+
+/** @internal */
+export const InformationRequestEvidenceUnion$inboundSchema: z.ZodType<
+  InformationRequestEvidenceUnion,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  VantaTestEvidence$inboundSchema,
+  VantaTestSnapshotEvidence$inboundSchema,
+  VantaPolicyEvidence$inboundSchema,
+  UploadedDocumentEvidence$inboundSchema,
+  VantaDocumentEvidence$inboundSchema,
+  LinkEvidence$inboundSchema,
+  ObservationEvidence$inboundSchema,
+]);
+
+export function informationRequestEvidenceUnionFromJSON(
+  jsonString: string,
+): SafeParseResult<InformationRequestEvidenceUnion, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InformationRequestEvidenceUnion$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InformationRequestEvidenceUnion' from JSON`,
+  );
+}

package/src/models/components/informationrequestsupportedevidencetype.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const InformationRequestSupportedEvidenceType = {
+  UploadedDocument: "UPLOADED_DOCUMENT",
+  Observation: "OBSERVATION",
+  Link: "LINK",
+  VantaDocument: "VANTA_DOCUMENT",
+  VantaPolicy: "VANTA_POLICY",
+  VantaTest: "VANTA_TEST",
+  VantaTestSnapshot: "VANTA_TEST_SNAPSHOT",
+} as const;
+export type InformationRequestSupportedEvidenceType = ClosedEnum<
+  typeof InformationRequestSupportedEvidenceType
+>;
+
+/** @internal */
+export const InformationRequestSupportedEvidenceType$inboundSchema:
+  z.ZodNativeEnum<typeof InformationRequestSupportedEvidenceType> = z
+    .nativeEnum(InformationRequestSupportedEvidenceType);
+/** @internal */
+export const InformationRequestSupportedEvidenceType$outboundSchema:
+  z.ZodNativeEnum<typeof InformationRequestSupportedEvidenceType> =
+    InformationRequestSupportedEvidenceType$inboundSchema;

package/src/models/components/informationrequesttype.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of information request, defining what scope of evidence is needed.
+ *
+ * @remarks
+ *
+ * - POINT_IN_TIME: Evidence for a specific moment (e.g., current state of a policy)
+ * - POPULATION: Evidence covering all items in a category (e.g., all employees)
+ * - SAMPLE: Evidence for a representative sample (e.g., 10 random customer records)
+ */
+export const InformationRequestType = {
+  PointInTime: "POINT_IN_TIME",
+  Population: "POPULATION",
+  Sample: "SAMPLE",
+} as const;
+/**
+ * Type of information request, defining what scope of evidence is needed.
+ *
+ * @remarks
+ *
+ * - POINT_IN_TIME: Evidence for a specific moment (e.g., current state of a policy)
+ * - POPULATION: Evidence covering all items in a category (e.g., all employees)
+ * - SAMPLE: Evidence for a representative sample (e.g., 10 random customer records)
+ */
+export type InformationRequestType = ClosedEnum<typeof InformationRequestType>;
+
+/** @internal */
+export const InformationRequestType$inboundSchema: z.ZodNativeEnum<
+  typeof InformationRequestType
+> = z.nativeEnum(InformationRequestType);
+/** @internal */
+export const InformationRequestType$outboundSchema: z.ZodNativeEnum<
+  typeof InformationRequestType
+> = InformationRequestType$inboundSchema;

package/src/models/components/issuesnapshotitem.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 {
+  IssueStatusTypeForSnapshot,
+  IssueStatusTypeForSnapshot$inboundSchema,
+} from "./issuestatustypeforsnapshot.js";
+
+export type IssueSnapshotItem = {
+  /**
+   * The unique identifier for the snapshot of an issue.
+   *
+   * @remarks
+   *
+   * This is distinct from the issueId, which identifies the underlying issue across snapshots.
+   * The snapshot item ID is unique to this specific snapshot of the issue.
+   */
+  id: string;
+  /**
+   * The issue title
+   */
+  title?: string | undefined;
+  /**
+   * The issue description
+   */
+  description?: string | undefined;
+  /**
+   * The human-readable identifier for the issue.
+   *
+   * @remarks
+   *
+   * This field is unique per-domain, and can be used to correlate
+   * this issue snapshot item to the underlying issue across different snapshots.
+   */
+  readableIssueId: string;
+  /**
+   * The globally unique identifier for the underlying issue across snapshots.
+   *
+   * @remarks
+   *
+   * This field can be used to correlate this snapshot item to the underlying issue across different snapshots.
+   */
+  issueId: string;
+  /**
+   * The identifier for the snapshot this issue item belongs to.
+   */
+  snapshotId: string;
+  /**
+   * The due date for the issue.
+   */
+  dueDate?: Date | null | undefined;
+  status?: IssueStatusTypeForSnapshot | undefined;
+  /**
+   * The date and time when the issue was last modified.
+   */
+  lastModifiedAt?: Date | undefined;
+  /**
+   * The date and time when the issue was created.
+   */
+  createdAt?: Date | undefined;
+  /**
+   * The date and time when the issue was detected.
+   */
+  detectedAt?: Date | undefined;
+};
+
+/** @internal */
+export const IssueSnapshotItem$inboundSchema: z.ZodType<
+  IssueSnapshotItem,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  readableIssueId: z.string(),
+  issueId: z.string(),
+  snapshotId: z.string(),
+  dueDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  status: IssueStatusTypeForSnapshot$inboundSchema.optional(),
+  lastModifiedAt: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ).optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+  detectedAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+});
+
+export function issueSnapshotItemFromJSON(
+  jsonString: string,
+): SafeParseResult<IssueSnapshotItem, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IssueSnapshotItem$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IssueSnapshotItem' from JSON`,
+  );
+}

package/src/models/components/issuesnapshotmetadata.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";
+
+export type IssueSnapshotMetadata = {
+  /**
+   * The unique identifier for the issue snapshot.
+   */
+  id: string;
+  /**
+   * The title of the snapshot
+   */
+  title?: string | undefined;
+  /**
+   * The description of the snapshot
+   */
+  description?: string | undefined;
+  /**
+   * The date and time when the snapshot was created.
+   */
+  createdAt?: Date | undefined;
+};
+
+/** @internal */
+export const IssueSnapshotMetadata$inboundSchema: z.ZodType<
+  IssueSnapshotMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  title: z.string().optional(),
+  description: z.string().optional(),
+  createdAt: z.string().datetime({ offset: true }).transform(v => new Date(v))
+    .optional(),
+});
+
+export function issueSnapshotMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<IssueSnapshotMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IssueSnapshotMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IssueSnapshotMetadata' from JSON`,
+  );
+}

package/src/models/components/issuestatustypeforsnapshot.ts

@@ -0,0 +1,20 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const IssueStatusTypeForSnapshot = {
+  InProgress: "IN_PROGRESS",
+  NotStarted: "NOT_STARTED",
+  Closed: "CLOSED",
+} as const;
+export type IssueStatusTypeForSnapshot = ClosedEnum<
+  typeof IssueStatusTypeForSnapshot
+>;
+
+/** @internal */
+export const IssueStatusTypeForSnapshot$inboundSchema: z.ZodNativeEnum<
+  typeof IssueStatusTypeForSnapshot
+> = z.nativeEnum(IssueStatusTypeForSnapshot);

package/src/models/components/linkevidence.ts

@@ -0,0 +1,47 @@
+/*
+ * 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";
+
+/**
+ * Evidence in the form of a link to external documentation or resources.
+ */
+export type LinkEvidence = {
+  /**
+   * The title or descriptive name for the link.
+   */
+  title: string;
+  /**
+   * Optional description providing additional context about the link.
+   */
+  description?: string | undefined;
+  /**
+   * The URL pointing to the external documentation or resource.
+   */
+  url: string;
+};
+
+/** @internal */
+export const LinkEvidence$inboundSchema: z.ZodType<
+  LinkEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  description: z.string().optional(),
+  url: z.string(),
+});
+
+export function linkEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<LinkEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LinkEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LinkEvidence' from JSON`,
+  );
+}

package/src/models/components/observationevidence.ts

@@ -0,0 +1,37 @@
+/*
+ * 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";
+
+/**
+ * Evidence in the form of a text observation or note.
+ */
+export type ObservationEvidence = {
+  /**
+   * The text content of the observation.
+   */
+  observationDetails: string;
+};
+
+/** @internal */
+export const ObservationEvidence$inboundSchema: z.ZodType<
+  ObservationEvidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  observationDetails: z.string(),
+});
+
+export function observationEvidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<ObservationEvidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ObservationEvidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ObservationEvidence' from JSON`,
+  );
+}

package/src/models/components/paginatedissuesnapshotitemsresponse.ts

@@ -0,0 +1,71 @@
+/*
+ * 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 {
+  IssueSnapshotItem,
+  IssueSnapshotItem$inboundSchema,
+} from "./issuesnapshotitem.js";
+import { PageInfo, PageInfo$inboundSchema } from "./pageinfo.js";
+
+export type PaginatedIssueSnapshotItemsResponseResults = {
+  data: Array<IssueSnapshotItem>;
+  /**
+   * Provides information about the pagination of a dataset.
+   */
+  pageInfo: PageInfo;
+};
+
+export type PaginatedIssueSnapshotItemsResponse = {
+  results: PaginatedIssueSnapshotItemsResponseResults;
+};
+
+/** @internal */
+export const PaginatedIssueSnapshotItemsResponseResults$inboundSchema:
+  z.ZodType<PaginatedIssueSnapshotItemsResponseResults, z.ZodTypeDef, unknown> =
+    z.object({
+      data: z.array(IssueSnapshotItem$inboundSchema),
+      pageInfo: PageInfo$inboundSchema,
+    });
+
+export function paginatedIssueSnapshotItemsResponseResultsFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  PaginatedIssueSnapshotItemsResponseResults,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedIssueSnapshotItemsResponseResults$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'PaginatedIssueSnapshotItemsResponseResults' from JSON`,
+  );
+}
+
+/** @internal */
+export const PaginatedIssueSnapshotItemsResponse$inboundSchema: z.ZodType<
+  PaginatedIssueSnapshotItemsResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  results: z.lazy(() =>
+    PaginatedIssueSnapshotItemsResponseResults$inboundSchema
+  ),
+});
+
+export function paginatedIssueSnapshotItemsResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<PaginatedIssueSnapshotItemsResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      PaginatedIssueSnapshotItemsResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PaginatedIssueSnapshotItemsResponse' from JSON`,
+  );
+}