vanta-auditor-api-sdk 0.1.1

package/src/models/components/evidence.ts

@@ -0,0 +1,158 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AuditEvidenceState,
+  AuditEvidenceState$inboundSchema,
+  AuditEvidenceState$outboundSchema,
+} from "./auditevidencestate.js";
+import {
+  AuditEvidenceType,
+  AuditEvidenceType$inboundSchema,
+  AuditEvidenceType$outboundSchema,
+} from "./auditevidencetype.js";
+import {
+  EvidenceControl,
+  EvidenceControl$inboundSchema,
+  EvidenceControl$Outbound,
+  EvidenceControl$outboundSchema,
+} from "./evidencecontrol.js";
+
+export type Evidence = {
+  /**
+   * Vanta internal reference to evidence
+   */
+  id: string;
+  /**
+   * This is a static UUID to map Audit Firm controls to Vanta controls
+   */
+  externalId: string;
+  status: AuditEvidenceState;
+  /**
+   * Mutable name for evidence. Not guaranteed to be unique.
+   */
+  name: string;
+  /**
+   * The date this Audit Evidence was deleted
+   */
+  deletionDate: Date | null;
+  /**
+   * The date this Audit Evidence was created
+   */
+  creationDate: Date;
+  /**
+   * Point in time that status was last updated
+   */
+  statusUpdatedDate: Date;
+  /**
+   * The outcome of the automated test run, for Test-type evidence
+   */
+  testStatus: string | null;
+  evidenceType: AuditEvidenceType;
+  /**
+   * Unique identifier for evidence
+   */
+  evidenceId: string;
+  /**
+   * The controls associated to this evidence
+   */
+  relatedControls: Array<EvidenceControl>;
+  /**
+   * The description for the evidence. It will be set to null if the evidence is deleted
+   */
+  description: string | null;
+};
+
+/** @internal */
+export const Evidence$inboundSchema: z.ZodType<
+  Evidence,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  status: AuditEvidenceState$inboundSchema,
+  name: z.string(),
+  deletionDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  creationDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  statusUpdatedDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  testStatus: z.nullable(z.string()),
+  evidenceType: AuditEvidenceType$inboundSchema,
+  evidenceId: z.string(),
+  relatedControls: z.array(EvidenceControl$inboundSchema),
+  description: z.nullable(z.string()),
+});
+
+/** @internal */
+export type Evidence$Outbound = {
+  id: string;
+  externalId: string;
+  status: string;
+  name: string;
+  deletionDate: string | null;
+  creationDate: string;
+  statusUpdatedDate: string;
+  testStatus: string | null;
+  evidenceType: string;
+  evidenceId: string;
+  relatedControls: Array<EvidenceControl$Outbound>;
+  description: string | null;
+};
+
+/** @internal */
+export const Evidence$outboundSchema: z.ZodType<
+  Evidence$Outbound,
+  z.ZodTypeDef,
+  Evidence
+> = z.object({
+  id: z.string(),
+  externalId: z.string(),
+  status: AuditEvidenceState$outboundSchema,
+  name: z.string(),
+  deletionDate: z.nullable(z.date().transform(v => v.toISOString())),
+  creationDate: z.date().transform(v => v.toISOString()),
+  statusUpdatedDate: z.date().transform(v => v.toISOString()),
+  testStatus: z.nullable(z.string()),
+  evidenceType: AuditEvidenceType$outboundSchema,
+  evidenceId: z.string(),
+  relatedControls: z.array(EvidenceControl$outboundSchema),
+  description: z.nullable(z.string()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Evidence$ {
+  /** @deprecated use `Evidence$inboundSchema` instead. */
+  export const inboundSchema = Evidence$inboundSchema;
+  /** @deprecated use `Evidence$outboundSchema` instead. */
+  export const outboundSchema = Evidence$outboundSchema;
+  /** @deprecated use `Evidence$Outbound` instead. */
+  export type Outbound = Evidence$Outbound;
+}
+
+export function evidenceToJSON(evidence: Evidence): string {
+  return JSON.stringify(Evidence$outboundSchema.parse(evidence));
+}
+
+export function evidenceFromJSON(
+  jsonString: string,
+): SafeParseResult<Evidence, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Evidence$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Evidence' from JSON`,
+  );
+}

package/src/models/components/evidencecontrol.ts

@@ -0,0 +1,74 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvidenceControl = {
+  /**
+   * Name of control associated to this evidence
+   */
+  name: string;
+  /**
+   * A list sections associated to the control
+   */
+  sectionNames: Array<string>;
+};
+
+/** @internal */
+export const EvidenceControl$inboundSchema: z.ZodType<
+  EvidenceControl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  sectionNames: z.array(z.string()),
+});
+
+/** @internal */
+export type EvidenceControl$Outbound = {
+  name: string;
+  sectionNames: Array<string>;
+};
+
+/** @internal */
+export const EvidenceControl$outboundSchema: z.ZodType<
+  EvidenceControl$Outbound,
+  z.ZodTypeDef,
+  EvidenceControl
+> = z.object({
+  name: z.string(),
+  sectionNames: z.array(z.string()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvidenceControl$ {
+  /** @deprecated use `EvidenceControl$inboundSchema` instead. */
+  export const inboundSchema = EvidenceControl$inboundSchema;
+  /** @deprecated use `EvidenceControl$outboundSchema` instead. */
+  export const outboundSchema = EvidenceControl$outboundSchema;
+  /** @deprecated use `EvidenceControl$Outbound` instead. */
+  export type Outbound = EvidenceControl$Outbound;
+}
+
+export function evidenceControlToJSON(
+  evidenceControl: EvidenceControl,
+): string {
+  return JSON.stringify(EvidenceControl$outboundSchema.parse(evidenceControl));
+}
+
+export function evidenceControlFromJSON(
+  jsonString: string,
+): SafeParseResult<EvidenceControl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvidenceControl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvidenceControl' from JSON`,
+  );
+}

package/src/models/components/evidenceurl.ts

@@ -0,0 +1,86 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EvidenceUrl = {
+  /**
+   * Vanta internal reference to evidence
+   */
+  id: string;
+  /**
+   * Pre-signed S3 URL for evidence
+   */
+  url: string;
+  /**
+   * File name of evidence
+   */
+  filename: string;
+  /**
+   * Set to true if this is a presigned s3 url. Set to false if this is a customer uploaded link
+   */
+  isDownloadable: boolean;
+};
+
+/** @internal */
+export const EvidenceUrl$inboundSchema: z.ZodType<
+  EvidenceUrl,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  url: z.string(),
+  filename: z.string(),
+  isDownloadable: z.boolean(),
+});
+
+/** @internal */
+export type EvidenceUrl$Outbound = {
+  id: string;
+  url: string;
+  filename: string;
+  isDownloadable: boolean;
+};
+
+/** @internal */
+export const EvidenceUrl$outboundSchema: z.ZodType<
+  EvidenceUrl$Outbound,
+  z.ZodTypeDef,
+  EvidenceUrl
+> = z.object({
+  id: z.string(),
+  url: z.string(),
+  filename: z.string(),
+  isDownloadable: z.boolean(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EvidenceUrl$ {
+  /** @deprecated use `EvidenceUrl$inboundSchema` instead. */
+  export const inboundSchema = EvidenceUrl$inboundSchema;
+  /** @deprecated use `EvidenceUrl$outboundSchema` instead. */
+  export const outboundSchema = EvidenceUrl$outboundSchema;
+  /** @deprecated use `EvidenceUrl$Outbound` instead. */
+  export type Outbound = EvidenceUrl$Outbound;
+}
+
+export function evidenceUrlToJSON(evidenceUrl: EvidenceUrl): string {
+  return JSON.stringify(EvidenceUrl$outboundSchema.parse(evidenceUrl));
+}
+
+export function evidenceUrlFromJSON(
+  jsonString: string,
+): SafeParseResult<EvidenceUrl, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EvidenceUrl$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EvidenceUrl' from JSON`,
+  );
+}

package/src/models/components/frameworkid.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const FrameworkId = {
+  AuE8: "AU_E_8",
+  AwsFtr: "AWS_FTR",
+  Ccpa: "CCPA",
+  CisV8: "CIS_V8",
+  Cps234: "CPS_234",
+  Dora: "DORA",
+  Fedramp: "FEDRAMP",
+  Gdpr: "GDPR",
+  Hipaa: "HIPAA",
+  HitrustE1: "HITRUST_E1",
+  Iso27001: "ISO_27001",
+  Iso270012022: "ISO_27001_2022",
+  Iso27017: "ISO_27017",
+  Iso27018: "ISO_27018",
+  Iso27701: "ISO_27701",
+  Iso42001: "ISO_42001",
+  Iso9001: "ISO_9001",
+  MsftSspa: "MSFT_SSPA",
+  Mvsp: "MVSP",
+  Nis2D: "NIS_2D",
+  Nist171: "NIST_171",
+  Nist53: "NIST_53",
+  NistAiRmf: "NIST_AI_RMF",
+  NistCsf: "NIST_CSF",
+  NistCsf2: "NIST_CSF_2",
+  Ofdss: "OFDSS",
+  PciSaqA: "PCI_SAQ_A",
+  PciSaqAEp: "PCI_SAQ_A_EP",
+  PciSaqDMerchant: "PCI_SAQ_D_MERCHANT",
+  PciSaqDSp: "PCI_SAQ_D_SP",
+  PciDds4: "PCI_DDS_4",
+  Soc2: "SOC_2",
+  SoxItgc: "SOX_ITGC",
+  UkCyberEssentials: "UK_CYBER_ESSENTIALS",
+  UsDataPrivacy: "US_DATA_PRIVACY",
+} as const;
+export type FrameworkId = ClosedEnum<typeof FrameworkId>;
+
+/** @internal */
+export const FrameworkId$inboundSchema: z.ZodNativeEnum<typeof FrameworkId> = z
+  .nativeEnum(FrameworkId);
+
+/** @internal */
+export const FrameworkId$outboundSchema: z.ZodNativeEnum<typeof FrameworkId> =
+  FrameworkId$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FrameworkId$ {
+  /** @deprecated use `FrameworkId$inboundSchema` instead. */
+  export const inboundSchema = FrameworkId$inboundSchema;
+  /** @deprecated use `FrameworkId$outboundSchema` instead. */
+  export const outboundSchema = FrameworkId$outboundSchema;
+}

package/src/models/components/frameworksection.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  FrameworkId,
+  FrameworkId$inboundSchema,
+  FrameworkId$outboundSchema,
+} from "./frameworkid.js";
+
+export type FrameworkSectionFrameworkId = FrameworkId | string;
+
+export type FrameworkSection = {
+  frameworkId: FrameworkId | string;
+  sectionId: string;
+};
+
+/** @internal */
+export const FrameworkSectionFrameworkId$inboundSchema: z.ZodType<
+  FrameworkSectionFrameworkId,
+  z.ZodTypeDef,
+  unknown
+> = z.union([FrameworkId$inboundSchema, z.string()]);
+
+/** @internal */
+export type FrameworkSectionFrameworkId$Outbound = string | string;
+
+/** @internal */
+export const FrameworkSectionFrameworkId$outboundSchema: z.ZodType<
+  FrameworkSectionFrameworkId$Outbound,
+  z.ZodTypeDef,
+  FrameworkSectionFrameworkId
+> = z.union([FrameworkId$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FrameworkSectionFrameworkId$ {
+  /** @deprecated use `FrameworkSectionFrameworkId$inboundSchema` instead. */
+  export const inboundSchema = FrameworkSectionFrameworkId$inboundSchema;
+  /** @deprecated use `FrameworkSectionFrameworkId$outboundSchema` instead. */
+  export const outboundSchema = FrameworkSectionFrameworkId$outboundSchema;
+  /** @deprecated use `FrameworkSectionFrameworkId$Outbound` instead. */
+  export type Outbound = FrameworkSectionFrameworkId$Outbound;
+}
+
+export function frameworkSectionFrameworkIdToJSON(
+  frameworkSectionFrameworkId: FrameworkSectionFrameworkId,
+): string {
+  return JSON.stringify(
+    FrameworkSectionFrameworkId$outboundSchema.parse(
+      frameworkSectionFrameworkId,
+    ),
+  );
+}
+
+export function frameworkSectionFrameworkIdFromJSON(
+  jsonString: string,
+): SafeParseResult<FrameworkSectionFrameworkId, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FrameworkSectionFrameworkId$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FrameworkSectionFrameworkId' from JSON`,
+  );
+}
+
+/** @internal */
+export const FrameworkSection$inboundSchema: z.ZodType<
+  FrameworkSection,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  frameworkId: z.union([FrameworkId$inboundSchema, z.string()]),
+  sectionId: z.string(),
+});
+
+/** @internal */
+export type FrameworkSection$Outbound = {
+  frameworkId: string | string;
+  sectionId: string;
+};
+
+/** @internal */
+export const FrameworkSection$outboundSchema: z.ZodType<
+  FrameworkSection$Outbound,
+  z.ZodTypeDef,
+  FrameworkSection
+> = z.object({
+  frameworkId: z.union([FrameworkId$outboundSchema, z.string()]),
+  sectionId: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace FrameworkSection$ {
+  /** @deprecated use `FrameworkSection$inboundSchema` instead. */
+  export const inboundSchema = FrameworkSection$inboundSchema;
+  /** @deprecated use `FrameworkSection$outboundSchema` instead. */
+  export const outboundSchema = FrameworkSection$outboundSchema;
+  /** @deprecated use `FrameworkSection$Outbound` instead. */
+  export type Outbound = FrameworkSection$Outbound;
+}
+
+export function frameworkSectionToJSON(
+  frameworkSection: FrameworkSection,
+): string {
+  return JSON.stringify(
+    FrameworkSection$outboundSchema.parse(frameworkSection),
+  );
+}
+
+export function frameworkSectionFromJSON(
+  jsonString: string,
+): SafeParseResult<FrameworkSection, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FrameworkSection$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FrameworkSection' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export * from "./addauditorinput.js";
+export * from "./addcommentinput.js";
+export * from "./audit.js";
+export * from "./auditevidencestate.js";
+export * from "./auditevidencetype.js";
+export * from "./auditevidenceupdateinput.js";
+export * from "./auditor.js";
+export * from "./auditorcontrol.js";
+export * from "./auditorenabledstatetransition.js";
+export * from "./comment.js";
+export * from "./control.js";
+export * from "./controldomain.js";
+export * from "./controlsource.js";
+export * from "./createcustomcontrolinput.js";
+export * from "./createcustomevidencerequestinput.js";
+export * from "./customevidencerequest.js";
+export * from "./evidence.js";
+export * from "./evidencecontrol.js";
+export * from "./evidenceurl.js";
+export * from "./frameworkid.js";
+export * from "./frameworksection.js";
+export * from "./pageinfo.js";
+export * from "./paginatedresponseaudit.js";
+export * from "./paginatedresponseauditorcontrol.js";
+export * from "./paginatedresponsecomment.js";
+export * from "./paginatedresponseevidence.js";
+export * from "./paginatedresponseevidenceurl.js";
+export * from "./recurrenceduration.js";
+export * from "./security.js";

package/src/models/components/pageinfo.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Provides information about the pagination of a dataset.
+ */
+export type PageInfo = {
+  /**
+   * The cursor that points to the end of the current page, or null if there is no such cursor.
+   */
+  endCursor: string | null;
+  /**
+   * Indicates if there is another page after the current page.
+   */
+  hasNextPage: boolean;
+  /**
+   * Indicates if there is a page before the current page.
+   */
+  hasPreviousPage: boolean;
+  /**
+   * The cursor that points to the start of the current page, or null if there is no such cursor.
+   */
+  startCursor: string | null;
+};
+
+/** @internal */
+export const PageInfo$inboundSchema: z.ZodType<
+  PageInfo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  endCursor: z.nullable(z.string()),
+  hasNextPage: z.boolean(),
+  hasPreviousPage: z.boolean(),
+  startCursor: z.nullable(z.string()),
+});
+
+/** @internal */
+export type PageInfo$Outbound = {
+  endCursor: string | null;
+  hasNextPage: boolean;
+  hasPreviousPage: boolean;
+  startCursor: string | null;
+};
+
+/** @internal */
+export const PageInfo$outboundSchema: z.ZodType<
+  PageInfo$Outbound,
+  z.ZodTypeDef,
+  PageInfo
+> = z.object({
+  endCursor: z.nullable(z.string()),
+  hasNextPage: z.boolean(),
+  hasPreviousPage: z.boolean(),
+  startCursor: z.nullable(z.string()),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PageInfo$ {
+  /** @deprecated use `PageInfo$inboundSchema` instead. */
+  export const inboundSchema = PageInfo$inboundSchema;
+  /** @deprecated use `PageInfo$outboundSchema` instead. */
+  export const outboundSchema = PageInfo$outboundSchema;
+  /** @deprecated use `PageInfo$Outbound` instead. */
+  export type Outbound = PageInfo$Outbound;
+}
+
+export function pageInfoToJSON(pageInfo: PageInfo): string {
+  return JSON.stringify(PageInfo$outboundSchema.parse(pageInfo));
+}
+
+export function pageInfoFromJSON(
+  jsonString: string,
+): SafeParseResult<PageInfo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PageInfo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PageInfo' from JSON`,
+  );
+}