vanta-auditor-api-sdk 0.4.2 → 0.5.0

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`,
+  );
+}

package/src/models/operations/acceptinformationrequestevidence.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type AcceptInformationRequestEvidenceRequest = {
+  auditId: string;
+  requestId: string;
+  acceptInformationRequestEvidenceInput:
+    components.AcceptInformationRequestEvidenceInput;
+};
+
+/** @internal */
+export type AcceptInformationRequestEvidenceRequest$Outbound = {
+  auditId: string;
+  requestId: string;
+  AcceptInformationRequestEvidenceInput:
+    components.AcceptInformationRequestEvidenceInput$Outbound;
+};
+
+/** @internal */
+export const AcceptInformationRequestEvidenceRequest$outboundSchema: z.ZodType<
+  AcceptInformationRequestEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  AcceptInformationRequestEvidenceRequest
+> = z.object({
+  auditId: z.string(),
+  requestId: z.string(),
+  acceptInformationRequestEvidenceInput:
+    components.AcceptInformationRequestEvidenceInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    acceptInformationRequestEvidenceInput:
+      "AcceptInformationRequestEvidenceInput",
+  });
+});
+
+export function acceptInformationRequestEvidenceRequestToJSON(
+  acceptInformationRequestEvidenceRequest:
+    AcceptInformationRequestEvidenceRequest,
+): string {
+  return JSON.stringify(
+    AcceptInformationRequestEvidenceRequest$outboundSchema.parse(
+      acceptInformationRequestEvidenceRequest,
+    ),
+  );
+}

package/src/models/operations/createcommentforinformationrequest.ts

@@ -0,0 +1,50 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type CreateCommentForInformationRequestRequest = {
+  auditId: string;
+  requestId: string;
+  addInformationRequestCommentInput:
+    components.AddInformationRequestCommentInput;
+};
+
+/** @internal */
+export type CreateCommentForInformationRequestRequest$Outbound = {
+  auditId: string;
+  requestId: string;
+  AddInformationRequestCommentInput:
+    components.AddInformationRequestCommentInput$Outbound;
+};
+
+/** @internal */
+export const CreateCommentForInformationRequestRequest$outboundSchema:
+  z.ZodType<
+    CreateCommentForInformationRequestRequest$Outbound,
+    z.ZodTypeDef,
+    CreateCommentForInformationRequestRequest
+  > = z.object({
+    auditId: z.string(),
+    requestId: z.string(),
+    addInformationRequestCommentInput:
+      components.AddInformationRequestCommentInput$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      addInformationRequestCommentInput: "AddInformationRequestCommentInput",
+    });
+  });
+
+export function createCommentForInformationRequestRequestToJSON(
+  createCommentForInformationRequestRequest:
+    CreateCommentForInformationRequestRequest,
+): string {
+  return JSON.stringify(
+    CreateCommentForInformationRequestRequest$outboundSchema.parse(
+      createCommentForInformationRequestRequest,
+    ),
+  );
+}

package/src/models/operations/createinformationrequest.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type CreateInformationRequestRequest = {
+  auditId: string;
+  createInformationRequestInput: components.CreateInformationRequestInput;
+};
+
+/** @internal */
+export type CreateInformationRequestRequest$Outbound = {
+  auditId: string;
+  CreateInformationRequestInput:
+    components.CreateInformationRequestInput$Outbound;
+};
+
+/** @internal */
+export const CreateInformationRequestRequest$outboundSchema: z.ZodType<
+  CreateInformationRequestRequest$Outbound,
+  z.ZodTypeDef,
+  CreateInformationRequestRequest
+> = z.object({
+  auditId: z.string(),
+  createInformationRequestInput:
+    components.CreateInformationRequestInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    createInformationRequestInput: "CreateInformationRequestInput",
+  });
+});
+
+export function createInformationRequestRequestToJSON(
+  createInformationRequestRequest: CreateInformationRequestRequest,
+): string {
+  return JSON.stringify(
+    CreateInformationRequestRequest$outboundSchema.parse(
+      createInformationRequestRequest,
+    ),
+  );
+}

package/src/models/operations/deletecommentforinformationrequest.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type DeleteCommentForInformationRequestRequest = {
+  auditId: string;
+  requestId: string;
+  commentId: string;
+  deleteInformationRequestCommentInput:
+    components.DeleteInformationRequestCommentInput;
+};
+
+/** @internal */
+export type DeleteCommentForInformationRequestRequest$Outbound = {
+  auditId: string;
+  requestId: string;
+  commentId: string;
+  DeleteInformationRequestCommentInput:
+    components.DeleteInformationRequestCommentInput$Outbound;
+};
+
+/** @internal */
+export const DeleteCommentForInformationRequestRequest$outboundSchema:
+  z.ZodType<
+    DeleteCommentForInformationRequestRequest$Outbound,
+    z.ZodTypeDef,
+    DeleteCommentForInformationRequestRequest
+  > = z.object({
+    auditId: z.string(),
+    requestId: z.string(),
+    commentId: z.string(),
+    deleteInformationRequestCommentInput:
+      components.DeleteInformationRequestCommentInput$outboundSchema,
+  }).transform((v) => {
+    return remap$(v, {
+      deleteInformationRequestCommentInput:
+        "DeleteInformationRequestCommentInput",
+    });
+  });
+
+export function deleteCommentForInformationRequestRequestToJSON(
+  deleteCommentForInformationRequestRequest:
+    DeleteCommentForInformationRequestRequest,
+): string {
+  return JSON.stringify(
+    DeleteCommentForInformationRequestRequest$outboundSchema.parse(
+      deleteCommentForInformationRequestRequest,
+    ),
+  );
+}

package/src/models/operations/deleteinformationrequest.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type DeleteInformationRequestRequest = {
+  auditId: string;
+  requestId: string;
+};
+
+/** @internal */
+export type DeleteInformationRequestRequest$Outbound = {
+  auditId: string;
+  requestId: string;
+};
+
+/** @internal */
+export const DeleteInformationRequestRequest$outboundSchema: z.ZodType<
+  DeleteInformationRequestRequest$Outbound,
+  z.ZodTypeDef,
+  DeleteInformationRequestRequest
+> = z.object({
+  auditId: z.string(),
+  requestId: z.string(),
+});
+
+export function deleteInformationRequestRequestToJSON(
+  deleteInformationRequestRequest: DeleteInformationRequestRequest,
+): string {
+  return JSON.stringify(
+    DeleteInformationRequestRequest$outboundSchema.parse(
+      deleteInformationRequestRequest,
+    ),
+  );
+}

package/src/models/operations/flaginformationrequestevidence.ts

@@ -0,0 +1,48 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import * as components from "../components/index.js";
+
+export type FlagInformationRequestEvidenceRequest = {
+  auditId: string;
+  requestId: string;
+  flagInformationRequestEvidenceInput:
+    components.FlagInformationRequestEvidenceInput;
+};
+
+/** @internal */
+export type FlagInformationRequestEvidenceRequest$Outbound = {
+  auditId: string;
+  requestId: string;
+  FlagInformationRequestEvidenceInput:
+    components.FlagInformationRequestEvidenceInput$Outbound;
+};
+
+/** @internal */
+export const FlagInformationRequestEvidenceRequest$outboundSchema: z.ZodType<
+  FlagInformationRequestEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  FlagInformationRequestEvidenceRequest
+> = z.object({
+  auditId: z.string(),
+  requestId: z.string(),
+  flagInformationRequestEvidenceInput:
+    components.FlagInformationRequestEvidenceInput$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    flagInformationRequestEvidenceInput: "FlagInformationRequestEvidenceInput",
+  });
+});
+
+export function flagInformationRequestEvidenceRequestToJSON(
+  flagInformationRequestEvidenceRequest: FlagInformationRequestEvidenceRequest,
+): string {
+  return JSON.stringify(
+    FlagInformationRequestEvidenceRequest$outboundSchema.parse(
+      flagInformationRequestEvidenceRequest,
+    ),
+  );
+}

package/src/models/operations/getaudit.ts

@@ -0,0 +1,29 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetAuditRequest = {
+  auditId: string;
+};
+
+/** @internal */
+export type GetAuditRequest$Outbound = {
+  auditId: string;
+};
+
+/** @internal */
+export const GetAuditRequest$outboundSchema: z.ZodType<
+  GetAuditRequest$Outbound,
+  z.ZodTypeDef,
+  GetAuditRequest
+> = z.object({
+  auditId: z.string(),
+});
+
+export function getAuditRequestToJSON(
+  getAuditRequest: GetAuditRequest,
+): string {
+  return JSON.stringify(GetAuditRequest$outboundSchema.parse(getAuditRequest));
+}

package/src/models/operations/getframeworkcodes.ts

@@ -0,0 +1,31 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type GetFrameworkCodesRequest = {
+  auditId: string;
+};
+
+/** @internal */
+export type GetFrameworkCodesRequest$Outbound = {
+  auditId: string;
+};
+
+/** @internal */
+export const GetFrameworkCodesRequest$outboundSchema: z.ZodType<
+  GetFrameworkCodesRequest$Outbound,
+  z.ZodTypeDef,
+  GetFrameworkCodesRequest
+> = z.object({
+  auditId: z.string(),
+});
+
+export function getFrameworkCodesRequestToJSON(
+  getFrameworkCodesRequest: GetFrameworkCodesRequest,
+): string {
+  return JSON.stringify(
+    GetFrameworkCodesRequest$outboundSchema.parse(getFrameworkCodesRequest),
+  );
+}