vanta-auditor-api-sdk 0.1.1

package/src/models/components/control.ts

@@ -0,0 +1,187 @@
+/*
+ * 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 {
+  ControlSource,
+  ControlSource$inboundSchema,
+  ControlSource$outboundSchema,
+} from "./controlsource.js";
+
+/**
+ * The control's owner.
+ */
+export type ControlOwner = {
+  /**
+   * Unique identifier for the person.
+   */
+  id: string;
+  /**
+   * Name of the person that is shown in product.
+   */
+  displayName: string;
+  /**
+   * Email address of the person.
+   */
+  emailAddress: string;
+};
+
+export type Control = {
+  /**
+   * The control's unique ID.
+   */
+  id: string;
+  /**
+   * The control's external ID.
+   */
+  externalId: string | null;
+  /**
+   * The control's name.
+   */
+  name: string;
+  /**
+   * The control's description.
+   */
+  description: string;
+  source: ControlSource;
+  /**
+   * The security domains that the control belongs to.
+   */
+  domains: Array<string>;
+  /**
+   * The control's owner.
+   */
+  owner: ControlOwner | null;
+  /**
+   * The control's GDPR role, if the control is a GDPR control.
+   */
+  role?: string | undefined;
+};
+
+/** @internal */
+export const ControlOwner$inboundSchema: z.ZodType<
+  ControlOwner,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  displayName: z.string(),
+  emailAddress: z.string(),
+});
+
+/** @internal */
+export type ControlOwner$Outbound = {
+  id: string;
+  displayName: string;
+  emailAddress: string;
+};
+
+/** @internal */
+export const ControlOwner$outboundSchema: z.ZodType<
+  ControlOwner$Outbound,
+  z.ZodTypeDef,
+  ControlOwner
+> = z.object({
+  id: z.string(),
+  displayName: z.string(),
+  emailAddress: 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 ControlOwner$ {
+  /** @deprecated use `ControlOwner$inboundSchema` instead. */
+  export const inboundSchema = ControlOwner$inboundSchema;
+  /** @deprecated use `ControlOwner$outboundSchema` instead. */
+  export const outboundSchema = ControlOwner$outboundSchema;
+  /** @deprecated use `ControlOwner$Outbound` instead. */
+  export type Outbound = ControlOwner$Outbound;
+}
+
+export function controlOwnerToJSON(controlOwner: ControlOwner): string {
+  return JSON.stringify(ControlOwner$outboundSchema.parse(controlOwner));
+}
+
+export function controlOwnerFromJSON(
+  jsonString: string,
+): SafeParseResult<ControlOwner, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ControlOwner$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ControlOwner' from JSON`,
+  );
+}
+
+/** @internal */
+export const Control$inboundSchema: z.ZodType<Control, z.ZodTypeDef, unknown> =
+  z.object({
+    id: z.string(),
+    externalId: z.nullable(z.string()),
+    name: z.string(),
+    description: z.string(),
+    source: ControlSource$inboundSchema,
+    domains: z.array(z.string()),
+    owner: z.nullable(z.lazy(() => ControlOwner$inboundSchema)),
+    role: z.string().optional(),
+  });
+
+/** @internal */
+export type Control$Outbound = {
+  id: string;
+  externalId: string | null;
+  name: string;
+  description: string;
+  source: string;
+  domains: Array<string>;
+  owner: ControlOwner$Outbound | null;
+  role?: string | undefined;
+};
+
+/** @internal */
+export const Control$outboundSchema: z.ZodType<
+  Control$Outbound,
+  z.ZodTypeDef,
+  Control
+> = z.object({
+  id: z.string(),
+  externalId: z.nullable(z.string()),
+  name: z.string(),
+  description: z.string(),
+  source: ControlSource$outboundSchema,
+  domains: z.array(z.string()),
+  owner: z.nullable(z.lazy(() => ControlOwner$outboundSchema)),
+  role: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Control$ {
+  /** @deprecated use `Control$inboundSchema` instead. */
+  export const inboundSchema = Control$inboundSchema;
+  /** @deprecated use `Control$outboundSchema` instead. */
+  export const outboundSchema = Control$outboundSchema;
+  /** @deprecated use `Control$Outbound` instead. */
+  export type Outbound = Control$Outbound;
+}
+
+export function controlToJSON(control: Control): string {
+  return JSON.stringify(Control$outboundSchema.parse(control));
+}
+
+export function controlFromJSON(
+  jsonString: string,
+): SafeParseResult<Control, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Control$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Control' from JSON`,
+  );
+}

package/src/models/components/controldomain.ts

@@ -0,0 +1,70 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ControlDomain = {
+  ARTIFICIALAndAUTONOMOUSTECHNOLOGY: "ARTIFICIAL_&_AUTONOMOUS_TECHNOLOGY",
+  AssetManagement: "ASSET_MANAGEMENT",
+  BUSINESSCONTINUITYAndDISASTERRECOVERY:
+    "BUSINESS_CONTINUITY_&_DISASTER_RECOVERY",
+  CAPACITYAndPERFORMANCEPLANNING: "CAPACITY_&_PERFORMANCE_PLANNING",
+  ChangeManagement: "CHANGE_MANAGEMENT",
+  CloudSecurity: "CLOUD_SECURITY",
+  Compliance: "COMPLIANCE",
+  ConfigurationManagement: "CONFIGURATION_MANAGEMENT",
+  ContinuousMonitoring: "CONTINUOUS_MONITORING",
+  CryptographicProtections: "CRYPTOGRAPHIC_PROTECTIONS",
+  DATACLASSIFICATIONAndHANDLING: "DATA_CLASSIFICATION_&_HANDLING",
+  EmbeddedTechnology: "EMBEDDED_TECHNOLOGY",
+  EndpointSecurity: "ENDPOINT_SECURITY",
+  HumanResourcesSecurity: "HUMAN_RESOURCES_SECURITY",
+  IDENTIFICATIONAndAUTHENTICATION: "IDENTIFICATION_&_AUTHENTICATION",
+  IncidentResponse: "INCIDENT_RESPONSE",
+  InformationAssurance: "INFORMATION_ASSURANCE",
+  Maintenance: "MAINTENANCE",
+  MobileDeviceManagement: "MOBILE_DEVICE_MANAGEMENT",
+  NetworkSecurity: "NETWORK SECURITY",
+  PHYSICALAndENVIRONMENTALSECURITY: "PHYSICAL_&_ENVIRONMENTAL_SECURITY",
+  Privacy: "PRIVACY",
+  PROJECTAndRESOURCEMANAGEMENT: "PROJECT_&_RESOURCE MANAGEMENT",
+  RiskManagement: "RISK_MANAGEMENT",
+  SECUREENGINEERINGAndARCHITECTURE: "SECURE_ENGINEERING_&_ARCHITECTURE",
+  SECURITYAWARENESSAndTRAINING: "SECURITY_AWARENESS_&_TRAINING",
+  SecurityOperations: "SECURITY_OPERATIONS",
+  SECURITYAndPRIVACYGOVERNANCE: "SECURITY_&_PRIVACY_GOVERNANCE",
+  TECHNOLOGYDEVELOPMENTAndACQUISITION: "TECHNOLOGY_DEVELOPMENT_&_ACQUISITION",
+  ThirdPartyManagement: "THIRD-PARTY_MANAGEMENT",
+  ThreatManagement: "THREAT_MANAGEMENT",
+  VULNERABILITYAndPATCHMANAGEMENT: "VULNERABILITY_&_PATCH_MANAGEMENT",
+  WebSecurity: "WEB_SECURITY",
+  Administrative: "ADMINISTRATIVE",
+  Physical: "PHYSICAL",
+  Technical: "TECHNICAL",
+  Basic: "BASIC",
+  Derived: "DERIVED",
+} as const;
+export type ControlDomain = ClosedEnum<typeof ControlDomain>;
+
+/** @internal */
+export const ControlDomain$inboundSchema: z.ZodNativeEnum<
+  typeof ControlDomain
+> = z.nativeEnum(ControlDomain);
+
+/** @internal */
+export const ControlDomain$outboundSchema: z.ZodNativeEnum<
+  typeof ControlDomain
+> = ControlDomain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ControlDomain$ {
+  /** @deprecated use `ControlDomain$inboundSchema` instead. */
+  export const inboundSchema = ControlDomain$inboundSchema;
+  /** @deprecated use `ControlDomain$outboundSchema` instead. */
+  export const outboundSchema = ControlDomain$outboundSchema;
+}

package/src/models/components/controlsource.ts

@@ -0,0 +1,33 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ControlSource = {
+  Vanta: "Vanta",
+  Custom: "Custom",
+} as const;
+export type ControlSource = ClosedEnum<typeof ControlSource>;
+
+/** @internal */
+export const ControlSource$inboundSchema: z.ZodNativeEnum<
+  typeof ControlSource
+> = z.nativeEnum(ControlSource);
+
+/** @internal */
+export const ControlSource$outboundSchema: z.ZodNativeEnum<
+  typeof ControlSource
+> = ControlSource$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ControlSource$ {
+  /** @deprecated use `ControlSource$inboundSchema` instead. */
+  export const inboundSchema = ControlSource$inboundSchema;
+  /** @deprecated use `ControlSource$outboundSchema` instead. */
+  export const outboundSchema = ControlSource$outboundSchema;
+}

package/src/models/components/createcustomcontrolinput.ts

@@ -0,0 +1,164 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  ControlDomain,
+  ControlDomain$inboundSchema,
+  ControlDomain$outboundSchema,
+} from "./controldomain.js";
+import {
+  FrameworkSection,
+  FrameworkSection$inboundSchema,
+  FrameworkSection$Outbound,
+  FrameworkSection$outboundSchema,
+} from "./frameworksection.js";
+
+/**
+ * The GDPR role of the control, which specifies whether the data is being "collected" or "processed". See the GdprRole enum for possible values.
+ *
+ * @remarks
+ * This field should only be included for controls that are to be mapped to the GDPR framework.
+ */
+export const Role = {
+  Both: "BOTH",
+  Controller: "CONTROLLER",
+  Processor: "PROCESSOR",
+} as const;
+/**
+ * The GDPR role of the control, which specifies whether the data is being "collected" or "processed". See the GdprRole enum for possible values.
+ *
+ * @remarks
+ * This field should only be included for controls that are to be mapped to the GDPR framework.
+ */
+export type Role = ClosedEnum<typeof Role>;
+
+export type CreateCustomControlInput = {
+  /**
+   * The external id of the control.
+   */
+  externalId: string;
+  /**
+   * The name of the control.
+   */
+  name: string | null;
+  /**
+   * The description of the control.
+   */
+  description: string;
+  /**
+   * The effective date of the control.
+   */
+  effectiveDate: Date;
+  category: ControlDomain;
+  /**
+   * Framework sections that the control should be mapped to.
+   */
+  sections?: Array<FrameworkSection> | null | undefined;
+  /**
+   * The GDPR role of the control, which specifies whether the data is being "collected" or "processed". See the GdprRole enum for possible values.
+   *
+   * @remarks
+   * This field should only be included for controls that are to be mapped to the GDPR framework.
+   */
+  role?: Role | null | undefined;
+};
+
+/** @internal */
+export const Role$inboundSchema: z.ZodNativeEnum<typeof Role> = z.nativeEnum(
+  Role,
+);
+
+/** @internal */
+export const Role$outboundSchema: z.ZodNativeEnum<typeof Role> =
+  Role$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Role$ {
+  /** @deprecated use `Role$inboundSchema` instead. */
+  export const inboundSchema = Role$inboundSchema;
+  /** @deprecated use `Role$outboundSchema` instead. */
+  export const outboundSchema = Role$outboundSchema;
+}
+
+/** @internal */
+export const CreateCustomControlInput$inboundSchema: z.ZodType<
+  CreateCustomControlInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  externalId: z.string(),
+  name: z.nullable(z.string()),
+  description: z.string(),
+  effectiveDate: z.string().datetime({ offset: true }).transform(v =>
+    new Date(v)
+  ),
+  category: ControlDomain$inboundSchema,
+  sections: z.nullable(z.array(FrameworkSection$inboundSchema)).optional(),
+  role: z.nullable(Role$inboundSchema).optional(),
+});
+
+/** @internal */
+export type CreateCustomControlInput$Outbound = {
+  externalId: string;
+  name: string | null;
+  description: string;
+  effectiveDate: string;
+  category: string;
+  sections?: Array<FrameworkSection$Outbound> | null | undefined;
+  role?: string | null | undefined;
+};
+
+/** @internal */
+export const CreateCustomControlInput$outboundSchema: z.ZodType<
+  CreateCustomControlInput$Outbound,
+  z.ZodTypeDef,
+  CreateCustomControlInput
+> = z.object({
+  externalId: z.string(),
+  name: z.nullable(z.string()),
+  description: z.string(),
+  effectiveDate: z.date().transform(v => v.toISOString()),
+  category: ControlDomain$outboundSchema,
+  sections: z.nullable(z.array(FrameworkSection$outboundSchema)).optional(),
+  role: z.nullable(Role$outboundSchema).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace CreateCustomControlInput$ {
+  /** @deprecated use `CreateCustomControlInput$inboundSchema` instead. */
+  export const inboundSchema = CreateCustomControlInput$inboundSchema;
+  /** @deprecated use `CreateCustomControlInput$outboundSchema` instead. */
+  export const outboundSchema = CreateCustomControlInput$outboundSchema;
+  /** @deprecated use `CreateCustomControlInput$Outbound` instead. */
+  export type Outbound = CreateCustomControlInput$Outbound;
+}
+
+export function createCustomControlInputToJSON(
+  createCustomControlInput: CreateCustomControlInput,
+): string {
+  return JSON.stringify(
+    CreateCustomControlInput$outboundSchema.parse(createCustomControlInput),
+  );
+}
+
+export function createCustomControlInputFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCustomControlInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCustomControlInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCustomControlInput' from JSON`,
+  );
+}

package/src/models/components/createcustomevidencerequestinput.ts

@@ -0,0 +1,105 @@
+/*
+ * 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 {
+  RecurrenceDuration,
+  RecurrenceDuration$inboundSchema,
+  RecurrenceDuration$outboundSchema,
+} from "./recurrenceduration.js";
+
+export type CreateCustomEvidenceRequestInput = {
+  /**
+   * A set of controls, referenced by id, to map the evidence to
+   */
+  controlIds: Array<string>;
+  /**
+   * Title for the evidence request
+   */
+  title: string;
+  /**
+   * Description for the evidence request
+   */
+  description: string;
+  cadence: RecurrenceDuration;
+  reminderWindow: RecurrenceDuration;
+  /**
+   * Whether this document contains sensitive data and needs more restrictive read access
+   */
+  isRestricted: boolean;
+};
+
+/** @internal */
+export const CreateCustomEvidenceRequestInput$inboundSchema: z.ZodType<
+  CreateCustomEvidenceRequestInput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  controlIds: z.array(z.string()),
+  title: z.string(),
+  description: z.string(),
+  cadence: RecurrenceDuration$inboundSchema,
+  reminderWindow: RecurrenceDuration$inboundSchema,
+  isRestricted: z.boolean(),
+});
+
+/** @internal */
+export type CreateCustomEvidenceRequestInput$Outbound = {
+  controlIds: Array<string>;
+  title: string;
+  description: string;
+  cadence: string;
+  reminderWindow: string;
+  isRestricted: boolean;
+};
+
+/** @internal */
+export const CreateCustomEvidenceRequestInput$outboundSchema: z.ZodType<
+  CreateCustomEvidenceRequestInput$Outbound,
+  z.ZodTypeDef,
+  CreateCustomEvidenceRequestInput
+> = z.object({
+  controlIds: z.array(z.string()),
+  title: z.string(),
+  description: z.string(),
+  cadence: RecurrenceDuration$outboundSchema,
+  reminderWindow: RecurrenceDuration$outboundSchema,
+  isRestricted: 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 CreateCustomEvidenceRequestInput$ {
+  /** @deprecated use `CreateCustomEvidenceRequestInput$inboundSchema` instead. */
+  export const inboundSchema = CreateCustomEvidenceRequestInput$inboundSchema;
+  /** @deprecated use `CreateCustomEvidenceRequestInput$outboundSchema` instead. */
+  export const outboundSchema = CreateCustomEvidenceRequestInput$outboundSchema;
+  /** @deprecated use `CreateCustomEvidenceRequestInput$Outbound` instead. */
+  export type Outbound = CreateCustomEvidenceRequestInput$Outbound;
+}
+
+export function createCustomEvidenceRequestInputToJSON(
+  createCustomEvidenceRequestInput: CreateCustomEvidenceRequestInput,
+): string {
+  return JSON.stringify(
+    CreateCustomEvidenceRequestInput$outboundSchema.parse(
+      createCustomEvidenceRequestInput,
+    ),
+  );
+}
+
+export function createCustomEvidenceRequestInputFromJSON(
+  jsonString: string,
+): SafeParseResult<CreateCustomEvidenceRequestInput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CreateCustomEvidenceRequestInput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CreateCustomEvidenceRequestInput' from JSON`,
+  );
+}

package/src/models/components/customevidencerequest.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 {
+  RecurrenceDuration,
+  RecurrenceDuration$inboundSchema,
+  RecurrenceDuration$outboundSchema,
+} from "./recurrenceduration.js";
+
+export type CustomEvidenceRequest = {
+  /**
+   * Internal id of the custom evidence request within Vanta
+   */
+  id: string;
+  /**
+   * A set of controls, referenced by id, to map the evidence to
+   */
+  controlIds: Array<string>;
+  /**
+   * Title for the evidence request
+   */
+  title: string;
+  /**
+   * Description for the evidence request
+   */
+  description: string;
+  cadence: RecurrenceDuration;
+  reminderWindow: RecurrenceDuration;
+  /**
+   * Whether this document contains sensitive data and needs more restrictive read access
+   */
+  isRestricted: boolean;
+};
+
+/** @internal */
+export const CustomEvidenceRequest$inboundSchema: z.ZodType<
+  CustomEvidenceRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  controlIds: z.array(z.string()),
+  title: z.string(),
+  description: z.string(),
+  cadence: RecurrenceDuration$inboundSchema,
+  reminderWindow: RecurrenceDuration$inboundSchema,
+  isRestricted: z.boolean(),
+});
+
+/** @internal */
+export type CustomEvidenceRequest$Outbound = {
+  id: string;
+  controlIds: Array<string>;
+  title: string;
+  description: string;
+  cadence: string;
+  reminderWindow: string;
+  isRestricted: boolean;
+};
+
+/** @internal */
+export const CustomEvidenceRequest$outboundSchema: z.ZodType<
+  CustomEvidenceRequest$Outbound,
+  z.ZodTypeDef,
+  CustomEvidenceRequest
+> = z.object({
+  id: z.string(),
+  controlIds: z.array(z.string()),
+  title: z.string(),
+  description: z.string(),
+  cadence: RecurrenceDuration$outboundSchema,
+  reminderWindow: RecurrenceDuration$outboundSchema,
+  isRestricted: 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 CustomEvidenceRequest$ {
+  /** @deprecated use `CustomEvidenceRequest$inboundSchema` instead. */
+  export const inboundSchema = CustomEvidenceRequest$inboundSchema;
+  /** @deprecated use `CustomEvidenceRequest$outboundSchema` instead. */
+  export const outboundSchema = CustomEvidenceRequest$outboundSchema;
+  /** @deprecated use `CustomEvidenceRequest$Outbound` instead. */
+  export type Outbound = CustomEvidenceRequest$Outbound;
+}
+
+export function customEvidenceRequestToJSON(
+  customEvidenceRequest: CustomEvidenceRequest,
+): string {
+  return JSON.stringify(
+    CustomEvidenceRequest$outboundSchema.parse(customEvidenceRequest),
+  );
+}
+
+export function customEvidenceRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomEvidenceRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomEvidenceRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomEvidenceRequest' from JSON`,
+  );
+}