vanta-auditor-api-sdk 0.4.2 → 0.5.0

package/src/models/components/flaginformationrequestevidenceinput.ts

@@ -0,0 +1,58 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Input for flagging evidence on an information request, indicating issues
+ *
+ * @remarks
+ * that need to be addressed. This changes the request's approvalStatus to
+ * a flagged state and creates an activity log entry.
+ *
+ * The customer will be notified and can resubmit evidence after addressing the issues.
+ */
+export type FlagInformationRequestEvidenceInput = {
+  /**
+   * Email of the auditor flagging the evidence.
+   *
+   * @remarks
+   * Must match an existing Vanta user who belongs to the audit firm making the API request.
+   */
+  auditorEmail: string;
+  /**
+   * Detailed explanation of what issues were found with the evidence.
+   *
+   * @remarks
+   * This reason is visible to the customer and guides them on what to fix.
+   * Must be at least 1 character.
+   */
+  reason: string;
+};
+
+/** @internal */
+export type FlagInformationRequestEvidenceInput$Outbound = {
+  auditorEmail: string;
+  reason: string;
+};
+
+/** @internal */
+export const FlagInformationRequestEvidenceInput$outboundSchema: z.ZodType<
+  FlagInformationRequestEvidenceInput$Outbound,
+  z.ZodTypeDef,
+  FlagInformationRequestEvidenceInput
+> = z.object({
+  auditorEmail: z.string(),
+  reason: z.string(),
+});
+
+export function flagInformationRequestEvidenceInputToJSON(
+  flagInformationRequestEvidenceInput: FlagInformationRequestEvidenceInput,
+): string {
+  return JSON.stringify(
+    FlagInformationRequestEvidenceInput$outboundSchema.parse(
+      flagInformationRequestEvidenceInput,
+    ),
+  );
+}

package/src/models/components/frameworkcodes.ts

@@ -0,0 +1,40 @@
+/*
+ * 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";
+
+/**
+ * Framework codes response resource
+ */
+export type FrameworkCodes = {
+  /**
+   * Array of valid framework codes for the audit's framework (e.g., "CC6.1", "CC6.2").
+   *
+   * @remarks
+   * These represent the different framework sections available for creating information requests.
+   */
+  frameworkCodes: Array<string>;
+};
+
+/** @internal */
+export const FrameworkCodes$inboundSchema: z.ZodType<
+  FrameworkCodes,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  frameworkCodes: z.array(z.string()),
+});
+
+export function frameworkCodesFromJSON(
+  jsonString: string,
+): SafeParseResult<FrameworkCodes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FrameworkCodes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FrameworkCodes' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -2,8 +2,10 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
+export * from "./acceptinformationrequestevidenceinput.js";
 export * from "./addauditorinput.js";
 export * from "./addcommentinput.js";
+export * from "./addinformationrequestcommentinput.js";
 export * from "./audit.js";
 export * from "./auditevidencestate.js";
 export * from "./auditevidencetype.js";
@@ -18,19 +20,58 @@ export * from "./controldomain.js";
 export * from "./controlsource.js";
 export * from "./createcustomcontrolinput.js";
 export * from "./createcustomevidencerequestinput.js";
+export * from "./createinformationrequestinput.js";
 export * from "./customevidencerequest.js";
 export * from "./customfield.js";
+export * from "./deleteinformationrequestcommentinput.js";
 export * from "./evidence.js";
 export * from "./evidencecontrol.js";
 export * from "./evidenceurl.js";
+export * from "./flaginformationrequestevidenceinput.js";
+export * from "./frameworkcodes.js";
 export * from "./frameworkid.js";
 export * from "./frameworksection.js";
+export * from "./informationrequest.js";
+export * from "./informationrequestactivitylog.js";
+export * from "./informationrequestactivitytype.js";
+export * from "./informationrequestapprovalstatus.js";
+export * from "./informationrequestcadence.js";
+export * from "./informationrequestcomment.js";
+export * from "./informationrequestevidence.js";
+export * from "./informationrequestevidenceunion.js";
+export * from "./informationrequestsupportedevidencetype.js";
+export * from "./informationrequesttype.js";
+export * from "./issuesnapshotitem.js";
+export * from "./issuesnapshotmetadata.js";
+export * from "./issuestatustypeforsnapshot.js";
+export * from "./linkevidence.js";
+export * from "./observationevidence.js";
 export * from "./pageinfo.js";
+export * from "./paginatedissuesnapshotitemsresponse.js";
+export * from "./paginatedissuesnapshotmetadataresponse.js";
 export * from "./paginatedresponseaudit.js";
 export * from "./paginatedresponseauditorcontrol.js";
 export * from "./paginatedresponsecomment.js";
 export * from "./paginatedresponseevidence.js";
 export * from "./paginatedresponseevidenceurl.js";
+export * from "./paginatedresponseinformationrequest.js";
+export * from "./paginatedresponseinformationrequestactivitylog.js";
+export * from "./paginatedresponseinformationrequestcomment.js";
+export * from "./paginatedresponseinformationrequestevidence.js";
+export * from "./partialupdateinformationrequest.js";
 export * from "./recurrenceduration.js";
 export * from "./section.js";
 export * from "./security.js";
+export * from "./updateinformationrequestcommentinput.js";
+export * from "./uploadeddocumentevidence.js";
+export * from "./vantadocumentevidence.js";
+export * from "./vantadocumentlinkevidence.js";
+export * from "./vantadocumentuploadedevidence.js";
+export * from "./vantapolicyevidence.js";
+export * from "./vantatestevidence.js";
+export * from "./vantatestfiletype.js";
+export * from "./vantatestrunstatus.js";
+export * from "./vantatestsnapshotevidence.js";
+export * from "./vantatestsnapshotevidencedetail.js";
+export * from "./vantatestsnapshotintegration.js";
+export * from "./vantatestsnapshotrawtestdatarow.js";

package/src/models/components/informationrequest.ts

@@ -0,0 +1,295 @@
+/*
+ * 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";
+import {
+  InformationRequestApprovalStatus,
+  InformationRequestApprovalStatus$inboundSchema,
+} from "./informationrequestapprovalstatus.js";
+import {
+  InformationRequestType,
+  InformationRequestType$inboundSchema,
+} from "./informationrequesttype.js";
+
+/**
+ * How frequently this information request recurs (e.g., annual password
+ *
+ * @remarks
+ * policy reviews). Null for one-time requests.
+ */
+export const Cadence = {
+  Annually: "ANNUALLY",
+  Biannually: "BIANNUALLY",
+  Monthly: "MONTHLY",
+  Quarterly: "QUARTERLY",
+} as const;
+/**
+ * How frequently this information request recurs (e.g., annual password
+ *
+ * @remarks
+ * policy reviews). Null for one-time requests.
+ */
+export type Cadence = ClosedEnum<typeof Cadence>;
+
+export type Two = {
+  displayName: string;
+  id: string;
+  type: "team";
+};
+
+export type One = {
+  displayName: string;
+  id: string;
+  type: "user";
+};
+
+/**
+ * Resource owner (user or team) assigned to this information request.
+ *
+ * @remarks
+ * Returns null if no resource owner is assigned.
+ */
+export type OwnerAssignment = One | Two;
+
+/**
+ * Information Request resource representing a single request for audit evidence from a customer.
+ *
+ * @remarks
+ *
+ * An information request is created by an auditor and shared with the customer organization.
+ * The customer then uploads evidence, which the auditor reviews and either approves or flags
+ * for issues.
+ */
+export type InformationRequest = {
+  /**
+   * The unique identifier for the information request within Vanta's system.
+   *
+   * @remarks
+   * This is the primary identifier used in all API endpoints.
+   * Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7")
+   */
+  id: string;
+  /**
+   * External unique ID to prevent duplicates across different audit systems.
+   *
+   * @remarks
+   * Used for idempotency when syncing data between external audit management
+   * systems and Vanta. Unlike `id`, this value is provided by the external system.
+   */
+  uniqueId: string;
+  /**
+   * Additional control IDs beyond those automatically mapped from framework codes.
+   *
+   * @remarks
+   * Allows manual association with specific controls when automatic mapping
+   * is insufficient. Each ID should reference a valid control in your audit framework.
+   */
+  additionalControlIds: Array<string>;
+  /**
+   * Current approval status of the information request, tracking its lifecycle through the audit process.
+   *
+   * @remarks
+   *
+   * The status progresses through the workflow: initial state → awaiting review → approved or flagged.
+   * Status can move between awaiting review and flagged states as evidence is reviewed and resubmitted.
+   */
+  approvalStatus: InformationRequestApprovalStatus;
+  /**
+   * How frequently this information request recurs (e.g., annual password
+   *
+   * @remarks
+   * policy reviews). Null for one-time requests.
+   */
+  cadence: Cadence | null;
+  /**
+   * The framework codes this request addresses.
+   *
+   * @remarks
+   * Links the request to specific compliance requirements. Can be an empty array
+   * if no framework codes are associated. These codes correspond to standards like SOC 2, ISO 27001, etc.
+   */
+  frameworkCodes: Array<string>;
+  /**
+   * Detailed description explaining what evidence is needed and why.
+   *
+   * @remarks
+   * Should provide clear instructions to help the customer understand what
+   * to submit.
+   */
+  description: string | null;
+  /**
+   * The deadline by which the customer must fulfill this request.
+   *
+   * @remarks
+   * Null if no specific deadline is set. Format: ISO 8601 UTC timestamp.
+   */
+  dueDate: Date | null;
+  /**
+   * The earliest date for which evidence should be captured.
+   *
+   * @remarks
+   * Evidence dated before this date may not be accepted.
+   * Null if not restricted. Format: ISO 8601 UTC timestamp.
+   */
+  evidenceCaptureDate: Date | null;
+  /**
+   * Non-unique external reference ID for this request.
+   *
+   * @remarks
+   * Unlike `uniqueId` which must be unique, `requestId` is for display/reference
+   * purposes only (e.g., "REQ-123"). Null if not provided.
+   */
+  requestId: string | null;
+  /**
+   * 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)
+   */
+  requestType: InformationRequestType;
+  /**
+   * Short, descriptive title summarizing what is being requested.
+   */
+  title: string;
+  /**
+   * Timestamp when the request was created in the system.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  creationDate: Date;
+  /**
+   * Timestamp when the request was last modified.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  modificationDate: Date;
+  /**
+   * Timestamp when the request was soft-deleted. Null if the request has not
+   *
+   * @remarks
+   * been deleted. Soft deletes allow retaining history while hiding the request
+   * from normal operations.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  deletionDate: Date | null;
+  /**
+   * Resource owner (user or team) assigned to this information request.
+   *
+   * @remarks
+   * Returns null if no resource owner is assigned.
+   */
+  ownerAssignment: One | Two | null;
+};
+
+/** @internal */
+export const Cadence$inboundSchema: z.ZodNativeEnum<typeof Cadence> = z
+  .nativeEnum(Cadence);
+
+/** @internal */
+export const Two$inboundSchema: z.ZodType<Two, z.ZodTypeDef, unknown> = z
+  .object({
+    displayName: z.string(),
+    id: z.string(),
+    type: z.literal("team"),
+  });
+
+export function twoFromJSON(
+  jsonString: string,
+): SafeParseResult<Two, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Two$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Two' from JSON`,
+  );
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    displayName: z.string(),
+    id: z.string(),
+    type: z.literal("user"),
+  });
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const OwnerAssignment$inboundSchema: z.ZodType<
+  OwnerAssignment,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]);
+
+export function ownerAssignmentFromJSON(
+  jsonString: string,
+): SafeParseResult<OwnerAssignment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OwnerAssignment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OwnerAssignment' from JSON`,
+  );
+}
+
+/** @internal */
+export const InformationRequest$inboundSchema: z.ZodType<
+  InformationRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  uniqueId: z.string(),
+  additionalControlIds: z.array(z.string()),
+  approvalStatus: InformationRequestApprovalStatus$inboundSchema,
+  cadence: z.nullable(Cadence$inboundSchema),
+  frameworkCodes: z.array(z.string()),
+  description: z.nullable(z.string()),
+  dueDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  evidenceCaptureDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  requestId: z.nullable(z.string()),
+  requestType: InformationRequestType$inboundSchema,
+  title: z.string(),
+  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)),
+  ),
+  ownerAssignment: z.nullable(
+    z.union([z.lazy(() => One$inboundSchema), z.lazy(() => Two$inboundSchema)]),
+  ),
+});
+
+export function informationRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<InformationRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InformationRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InformationRequest' from JSON`,
+  );
+}

package/src/models/components/informationrequestactivitylog.ts

@@ -0,0 +1,146 @@
+/*
+ * 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";
+import {
+  InformationRequestActivityType,
+  InformationRequestActivityType$inboundSchema,
+} from "./informationrequestactivitytype.js";
+
+/**
+ * Previous approval status before the status change.
+ *
+ * @remarks
+ * Only populated for status change activities. Null for all other activity types.
+ */
+export const OldStatus = {
+  ReadyForAudit: "READY_FOR_AUDIT",
+  NeedsEvidence: "NEEDS_EVIDENCE",
+  AuditorApproved: "AUDITOR_APPROVED",
+  AuditorFlagged: "AUDITOR_FLAGGED",
+  ReadyForInternalReview: "READY_FOR_INTERNAL_REVIEW",
+} as const;
+/**
+ * Previous approval status before the status change.
+ *
+ * @remarks
+ * Only populated for status change activities. Null for all other activity types.
+ */
+export type OldStatus = ClosedEnum<typeof OldStatus>;
+
+/**
+ * New approval status after the status change.
+ *
+ * @remarks
+ * Only populated for status change activities. Null for all other activity types.
+ */
+export const NewStatus = {
+  ReadyForAudit: "READY_FOR_AUDIT",
+  NeedsEvidence: "NEEDS_EVIDENCE",
+  AuditorApproved: "AUDITOR_APPROVED",
+  AuditorFlagged: "AUDITOR_FLAGGED",
+  ReadyForInternalReview: "READY_FOR_INTERNAL_REVIEW",
+} as const;
+/**
+ * New approval status after the status change.
+ *
+ * @remarks
+ * Only populated for status change activities. Null for all other activity types.
+ */
+export type NewStatus = ClosedEnum<typeof NewStatus>;
+
+/**
+ * Activity log entry tracking changes and actions on an information request.
+ *
+ * @remarks
+ *
+ * The activity log provides a complete audit trail of all operations performed
+ * on an information request, including status changes, evidence uploads, edits,
+ * and evidence sharing. This enables tracking compliance activities and understanding
+ * the request's history.
+ */
+export type InformationRequestActivityLog = {
+  /**
+   * The unique identifier for the activity log entry within Vanta's system.
+   *
+   * @remarks
+   * Format: ObjectId as a string (e.g., "6890e473dce1da5d8406f5e7").
+   */
+  id: string;
+  activityType: InformationRequestActivityType;
+  /**
+   * Timestamp when the activity occurred.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  timestamp: Date;
+  /**
+   * Email address of the user who performed the activity.
+   *
+   * @remarks
+   * Null for system-generated activities (rare, such as automated status changes).
+   * This email uniquely identifies users across systems.
+   */
+  userEmail: string | null;
+  /**
+   * Previous approval status before the status change.
+   *
+   * @remarks
+   * Only populated for status change activities. Null for all other activity types.
+   */
+  oldStatus: OldStatus | null;
+  /**
+   * New approval status after the status change.
+   *
+   * @remarks
+   * Only populated for status change activities. Null for all other activity types.
+   */
+  newStatus: NewStatus | null;
+  /**
+   * Optional explanation for the status change.
+   *
+   * @remarks
+   * Only populated for status change activities when a reason is provided
+   * (e.g., when flagging evidence). Null for all other cases.
+   */
+  reason: string | null;
+};
+
+/** @internal */
+export const OldStatus$inboundSchema: z.ZodNativeEnum<typeof OldStatus> = z
+  .nativeEnum(OldStatus);
+
+/** @internal */
+export const NewStatus$inboundSchema: z.ZodNativeEnum<typeof NewStatus> = z
+  .nativeEnum(NewStatus);
+
+/** @internal */
+export const InformationRequestActivityLog$inboundSchema: z.ZodType<
+  InformationRequestActivityLog,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  activityType: InformationRequestActivityType$inboundSchema,
+  timestamp: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  userEmail: z.nullable(z.string()),
+  oldStatus: z.nullable(OldStatus$inboundSchema),
+  newStatus: z.nullable(NewStatus$inboundSchema),
+  reason: z.nullable(z.string()),
+});
+
+export function informationRequestActivityLogFromJSON(
+  jsonString: string,
+): SafeParseResult<InformationRequestActivityLog, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InformationRequestActivityLog$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InformationRequestActivityLog' from JSON`,
+  );
+}

package/src/models/components/informationrequestactivitytype.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const InformationRequestActivityType = {
+  ChangeStatus: "CHANGE_STATUS",
+  EditRequest: "EDIT_REQUEST",
+  RemoveEvidence: "REMOVE_EVIDENCE",
+  ShareEvidenceWithAuditor: "SHARE_EVIDENCE_WITH_AUDITOR",
+  UploadEvidence: "UPLOAD_EVIDENCE",
+} as const;
+export type InformationRequestActivityType = ClosedEnum<
+  typeof InformationRequestActivityType
+>;
+
+/** @internal */
+export const InformationRequestActivityType$inboundSchema: z.ZodNativeEnum<
+  typeof InformationRequestActivityType
+> = z.nativeEnum(InformationRequestActivityType);

package/src/models/components/informationrequestapprovalstatus.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Current approval status of the information request, tracking its lifecycle through the audit process.
+ *
+ * @remarks
+ *
+ * The status progresses through the workflow: initial state → awaiting review → approved or flagged.
+ * Status can move between awaiting review and flagged states as evidence is reviewed and resubmitted.
+ */
+export const InformationRequestApprovalStatus = {
+  NeedsEvidence: "NEEDS_EVIDENCE",
+  ReadyForAudit: "READY_FOR_AUDIT",
+  AuditorApproved: "AUDITOR_APPROVED",
+  AuditorFlagged: "AUDITOR_FLAGGED",
+} as const;
+/**
+ * Current approval status of the information request, tracking its lifecycle through the audit process.
+ *
+ * @remarks
+ *
+ * The status progresses through the workflow: initial state → awaiting review → approved or flagged.
+ * Status can move between awaiting review and flagged states as evidence is reviewed and resubmitted.
+ */
+export type InformationRequestApprovalStatus = ClosedEnum<
+  typeof InformationRequestApprovalStatus
+>;
+
+/** @internal */
+export const InformationRequestApprovalStatus$inboundSchema: z.ZodNativeEnum<
+  typeof InformationRequestApprovalStatus
+> = z.nativeEnum(InformationRequestApprovalStatus);

package/src/models/components/informationrequestcadence.ts

@@ -0,0 +1,27 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Frequency cadence for the information request, indicating how often it recurs.
+ */
+export const InformationRequestCadence = {
+  Annually: "ANNUALLY",
+  Biannually: "BIANNUALLY",
+  Monthly: "MONTHLY",
+  Quarterly: "QUARTERLY",
+} as const;
+/**
+ * Frequency cadence for the information request, indicating how often it recurs.
+ */
+export type InformationRequestCadence = ClosedEnum<
+  typeof InformationRequestCadence
+>;
+
+/** @internal */
+export const InformationRequestCadence$outboundSchema: z.ZodNativeEnum<
+  typeof InformationRequestCadence
+> = z.nativeEnum(InformationRequestCadence);