vanta-auditor-api-sdk 0.4.1 → 0.5.0

package/src/models/components/auditorcontrol.ts

@@ -6,23 +6,9 @@ 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 {
-  ControlSource,
-  ControlSource$inboundSchema,
-  ControlSource$outboundSchema,
-} from "./controlsource.js";
-import {
-  CustomField,
-  CustomField$inboundSchema,
-  CustomField$Outbound,
-  CustomField$outboundSchema,
-} from "./customfield.js";
-import {
-  Section,
-  Section$inboundSchema,
-  Section$Outbound,
-  Section$outboundSchema,
-} from "./section.js";
+import { ControlSource, ControlSource$inboundSchema } from "./controlsource.js";
+import { CustomField, CustomField$inboundSchema } from "./customfield.js";
+import { Section, Section$inboundSchema } from "./section.js";
 
 /**
  * The control's owner.
@@ -76,6 +62,14 @@ export type AuditorControl = {
    * The control's custom field values, if control custom fields is included in your Vanta instance.
    */
   customFields: Array<CustomField>;
+  /**
+   * When the control was created. Returns null for Vanta library controls.
+   */
+  creationDate: Date | null;
+  /**
+   * When the control was last modified. Returns null for Vanta library controls.
+   */
+  modificationDate: Date | null;
   /**
    * The report standard framework fulfilled by the control.
    */
@@ -93,27 +87,7 @@ export const Owner$inboundSchema: z.ZodType<Owner, z.ZodTypeDef, unknown> = z
     displayName: z.string(),
     emailAddress: z.string(),
   });
-/** @internal */
-export type Owner$Outbound = {
-  id: string;
-  displayName: string;
-  emailAddress: string;
-};
 
-/** @internal */
-export const Owner$outboundSchema: z.ZodType<
-  Owner$Outbound,
-  z.ZodTypeDef,
-  Owner
-> = z.object({
-  id: z.string(),
-  displayName: z.string(),
-  emailAddress: z.string(),
-});
-
-export function ownerToJSON(owner: Owner): string {
-  return JSON.stringify(Owner$outboundSchema.parse(owner));
-}
 export function ownerFromJSON(
   jsonString: string,
 ): SafeParseResult<Owner, SDKValidationError> {
@@ -139,46 +113,16 @@ export const AuditorControl$inboundSchema: z.ZodType<
   owner: z.nullable(z.lazy(() => Owner$inboundSchema)),
   role: z.nullable(z.string()).optional(),
   customFields: z.array(CustomField$inboundSchema),
+  creationDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  modificationDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
   framework: z.string(),
   sections: z.array(Section$inboundSchema),
 });
-/** @internal */
-export type AuditorControl$Outbound = {
-  id: string;
-  externalId: string | null;
-  name: string;
-  description: string;
-  source: string;
-  domains: Array<string>;
-  owner: Owner$Outbound | null;
-  role?: string | null | undefined;
-  customFields: Array<CustomField$Outbound>;
-  framework: string;
-  sections: Array<Section$Outbound>;
-};
-
-/** @internal */
-export const AuditorControl$outboundSchema: z.ZodType<
-  AuditorControl$Outbound,
-  z.ZodTypeDef,
-  AuditorControl
-> = 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(() => Owner$outboundSchema)),
-  role: z.nullable(z.string()).optional(),
-  customFields: z.array(CustomField$outboundSchema),
-  framework: z.string(),
-  sections: z.array(Section$outboundSchema),
-});
 
-export function auditorControlToJSON(auditorControl: AuditorControl): string {
-  return JSON.stringify(AuditorControl$outboundSchema.parse(auditorControl));
-}
 export function auditorControlFromJSON(
   jsonString: string,
 ): SafeParseResult<AuditorControl, SDKValidationError> {

package/src/models/components/auditorenabledstatetransition.ts

@@ -16,11 +16,7 @@ export type AuditorEnabledStateTransition = ClosedEnum<
   typeof AuditorEnabledStateTransition
 >;
 
-/** @internal */
-export const AuditorEnabledStateTransition$inboundSchema: z.ZodNativeEnum<
-  typeof AuditorEnabledStateTransition
-> = z.nativeEnum(AuditorEnabledStateTransition);
 /** @internal */
 export const AuditorEnabledStateTransition$outboundSchema: z.ZodNativeEnum<
   typeof AuditorEnabledStateTransition
-> = AuditorEnabledStateTransition$inboundSchema;
+> = z.nativeEnum(AuditorEnabledStateTransition);

package/src/models/components/comment.ts

@@ -36,6 +36,15 @@ export type Comment = {
    * The email of the comment author. This acts as a unique identifier to map users between Vanta and external 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 */
@@ -54,36 +63,9 @@ export const Comment$inboundSchema: z.ZodType<Comment, z.ZodTypeDef, unknown> =
       z.string().datetime({ offset: true }).transform(v => new Date(v)),
     ),
     email: z.nullable(z.string()),
+    authorName: z.nullable(z.string()),
   });
-/** @internal */
-export type Comment$Outbound = {
-  id: string;
-  auditEvidenceId: string;
-  text: string;
-  creationDate: string;
-  modificationDate: string | null;
-  deletionDate: string | null;
-  email: string | null;
-};
 
-/** @internal */
-export const Comment$outboundSchema: z.ZodType<
-  Comment$Outbound,
-  z.ZodTypeDef,
-  Comment
-> = z.object({
-  id: z.string(),
-  auditEvidenceId: z.string(),
-  text: z.string(),
-  creationDate: z.date().transform(v => v.toISOString()),
-  modificationDate: z.nullable(z.date().transform(v => v.toISOString())),
-  deletionDate: z.nullable(z.date().transform(v => v.toISOString())),
-  email: z.nullable(z.string()),
-});
-
-export function commentToJSON(comment: Comment): string {
-  return JSON.stringify(Comment$outboundSchema.parse(comment));
-}
 export function commentFromJSON(
   jsonString: string,
 ): SafeParseResult<Comment, SDKValidationError> {

package/src/models/components/control.ts

@@ -6,17 +6,8 @@ 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 {
-  ControlSource,
-  ControlSource$inboundSchema,
-  ControlSource$outboundSchema,
-} from "./controlsource.js";
-import {
-  CustomField,
-  CustomField$inboundSchema,
-  CustomField$Outbound,
-  CustomField$outboundSchema,
-} from "./customfield.js";
+import { ControlSource, ControlSource$inboundSchema } from "./controlsource.js";
+import { CustomField, CustomField$inboundSchema } from "./customfield.js";
 
 /**
  * The control's owner.
@@ -70,6 +61,14 @@ export type Control = {
    * The control's custom field values, if control custom fields is included in your Vanta instance.
    */
   customFields: Array<CustomField>;
+  /**
+   * When the control was created. Returns null for Vanta library controls.
+   */
+  creationDate: Date | null;
+  /**
+   * When the control was last modified. Returns null for Vanta library controls.
+   */
+  modificationDate: Date | null;
 };
 
 /** @internal */
@@ -82,27 +81,7 @@ export const ControlOwner$inboundSchema: z.ZodType<
   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(),
-});
 
-export function controlOwnerToJSON(controlOwner: ControlOwner): string {
-  return JSON.stringify(ControlOwner$outboundSchema.parse(controlOwner));
-}
 export function controlOwnerFromJSON(
   jsonString: string,
 ): SafeParseResult<ControlOwner, SDKValidationError> {
@@ -125,40 +104,14 @@ export const Control$inboundSchema: z.ZodType<Control, z.ZodTypeDef, unknown> =
     owner: z.nullable(z.lazy(() => ControlOwner$inboundSchema)),
     role: z.nullable(z.string()).optional(),
     customFields: z.array(CustomField$inboundSchema),
+    creationDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ),
+    modificationDate: z.nullable(
+      z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    ),
   });
-/** @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 | null | undefined;
-  customFields: Array<CustomField$Outbound>;
-};
-
-/** @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.nullable(z.string()).optional(),
-  customFields: z.array(CustomField$outboundSchema),
-});
 
-export function controlToJSON(control: Control): string {
-  return JSON.stringify(Control$outboundSchema.parse(control));
-}
 export function controlFromJSON(
   jsonString: string,
 ): SafeParseResult<Control, SDKValidationError> {

package/src/models/components/controldomain.ts

@@ -48,11 +48,7 @@ export const ControlDomain = {
 } 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;
+> = z.nativeEnum(ControlDomain);

package/src/models/components/controlsource.ts

@@ -15,7 +15,3 @@ export type ControlSource = ClosedEnum<typeof ControlSource>;
 export const ControlSource$inboundSchema: z.ZodNativeEnum<
   typeof ControlSource
 > = z.nativeEnum(ControlSource);
-/** @internal */
-export const ControlSource$outboundSchema: z.ZodNativeEnum<
-  typeof ControlSource
-> = ControlSource$inboundSchema;

package/src/models/components/createcustomcontrolinput.ts

@@ -3,18 +3,13 @@
  */
 
 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 {
   ControlDomain,
-  ControlDomain$inboundSchema,
   ControlDomain$outboundSchema,
 } from "./controldomain.js";
 import {
   FrameworkSection,
-  FrameworkSection$inboundSchema,
   FrameworkSection$Outbound,
   FrameworkSection$outboundSchema,
 } from "./frameworksection.js";
@@ -70,29 +65,10 @@ export type CreateCustomControlInput = {
 };
 
 /** @internal */
-export const Role$inboundSchema: z.ZodNativeEnum<typeof Role> = z.nativeEnum(
+export const Role$outboundSchema: z.ZodNativeEnum<typeof Role> = z.nativeEnum(
   Role,
 );
-/** @internal */
-export const Role$outboundSchema: z.ZodNativeEnum<typeof Role> =
-  Role$inboundSchema;
 
-/** @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;
@@ -126,12 +102,3 @@ export function createCustomControlInputToJSON(
     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

@@ -3,12 +3,8 @@
  */
 
 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 {
   RecurrenceDuration,
-  RecurrenceDuration$inboundSchema,
   RecurrenceDuration$outboundSchema,
 } from "./recurrenceduration.js";
 
@@ -37,20 +33,6 @@ export type CreateCustomEvidenceRequestInput = {
   auditorEmail: string;
 };
 
-/** @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(),
-  auditorEmail: z.string(),
-});
 /** @internal */
 export type CreateCustomEvidenceRequestInput$Outbound = {
   controlIds: Array<string>;
@@ -86,12 +68,3 @@ export function createCustomEvidenceRequestInputToJSON(
     ),
   );
 }
-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/createinformationrequestinput.ts

@@ -0,0 +1,138 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+import {
+  InformationRequestType,
+  InformationRequestType$outboundSchema,
+} from "./informationrequesttype.js";
+
+/**
+ * How frequently this request recurs. Null or omitted for one-time requests.
+ */
+export const CreateInformationRequestInputCadence = {
+  Annually: "ANNUALLY",
+  Biannually: "BIANNUALLY",
+  Monthly: "MONTHLY",
+  Quarterly: "QUARTERLY",
+} as const;
+/**
+ * How frequently this request recurs. Null or omitted for one-time requests.
+ */
+export type CreateInformationRequestInputCadence = ClosedEnum<
+  typeof CreateInformationRequestInputCadence
+>;
+
+/**
+ * Input for creating a new information request.
+ *
+ * @remarks
+ * New requests are created in an initial state by default.
+ */
+export type CreateInformationRequestInput = {
+  /**
+   * External unique ID to prevent duplicate requests across audit systems.
+   *
+   * @remarks
+   * Must be unique within the audit. Used for idempotency.
+   */
+  uniqueId: string;
+  /**
+   * Short, descriptive title summarizing what is being requested.
+   *
+   * @remarks
+   * Must be at least 1 character.
+   */
+  title: string;
+  /**
+   * 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;
+  /**
+   * Detailed description explaining what evidence is needed.
+   *
+   * @remarks
+   * Helps the customer understand what to submit. Optional.
+   */
+  description?: string | null | undefined;
+  /**
+   * Framework codes this request addresses.
+   *
+   * @remarks
+   * An empty array if no framework codes are associated.
+   */
+  frameworkCodes: Array<string>;
+  /**
+   * How frequently this request recurs. Null or omitted for one-time requests.
+   */
+  cadence?: CreateInformationRequestInputCadence | null | undefined;
+  /**
+   * Deadline for fulfilling this request. Null or omitted if no deadline.
+   *
+   * @remarks
+   * Format: ISO 8601 UTC timestamp.
+   */
+  dueDate?: Date | null | undefined;
+  /**
+   * Start date of the audit period. Evidence before this date may not be accepted.
+   *
+   * @remarks
+   * Null or omitted if not restricted.
+   * Format: ISO 8601 UTC timestamp.
+   */
+  evidenceCaptureDate?: Date | null | undefined;
+};
+
+/** @internal */
+export const CreateInformationRequestInputCadence$outboundSchema:
+  z.ZodNativeEnum<typeof CreateInformationRequestInputCadence> = z.nativeEnum(
+    CreateInformationRequestInputCadence,
+  );
+
+/** @internal */
+export type CreateInformationRequestInput$Outbound = {
+  uniqueId: string;
+  title: string;
+  requestType: string;
+  description?: string | null | undefined;
+  frameworkCodes: Array<string>;
+  cadence?: string | null | undefined;
+  dueDate?: string | null | undefined;
+  evidenceCaptureDate?: string | null | undefined;
+};
+
+/** @internal */
+export const CreateInformationRequestInput$outboundSchema: z.ZodType<
+  CreateInformationRequestInput$Outbound,
+  z.ZodTypeDef,
+  CreateInformationRequestInput
+> = z.object({
+  uniqueId: z.string(),
+  title: z.string(),
+  requestType: InformationRequestType$outboundSchema,
+  description: z.nullable(z.string()).optional(),
+  frameworkCodes: z.array(z.string()),
+  cadence: z.nullable(CreateInformationRequestInputCadence$outboundSchema)
+    .optional(),
+  dueDate: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  evidenceCaptureDate: z.nullable(z.date().transform(v => v.toISOString()))
+    .optional(),
+});
+
+export function createInformationRequestInputToJSON(
+  createInformationRequestInput: CreateInformationRequestInput,
+): string {
+  return JSON.stringify(
+    CreateInformationRequestInput$outboundSchema.parse(
+      createInformationRequestInput,
+    ),
+  );
+}

package/src/models/components/customevidencerequest.ts

@@ -9,7 +9,6 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   RecurrenceDuration,
   RecurrenceDuration$inboundSchema,
-  RecurrenceDuration$outboundSchema,
 } from "./recurrenceduration.js";
 
 export type CustomEvidenceRequest = {
@@ -51,39 +50,7 @@ export const CustomEvidenceRequest$inboundSchema: z.ZodType<
   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(),
-});
-
-export function customEvidenceRequestToJSON(
-  customEvidenceRequest: CustomEvidenceRequest,
-): string {
-  return JSON.stringify(
-    CustomEvidenceRequest$outboundSchema.parse(customEvidenceRequest),
-  );
-}
 export function customEvidenceRequestFromJSON(
   jsonString: string,
 ): SafeParseResult<CustomEvidenceRequest, SDKValidationError> {

package/src/models/components/customfield.ts

@@ -17,19 +17,7 @@ export type CustomField = {
 /** @internal */
 export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
   .union([z.string(), z.array(z.string())]);
-/** @internal */
-export type Value$Outbound = string | Array<string>;
 
-/** @internal */
-export const Value$outboundSchema: z.ZodType<
-  Value$Outbound,
-  z.ZodTypeDef,
-  Value
-> = z.union([z.string(), z.array(z.string())]);
-
-export function valueToJSON(value: Value): string {
-  return JSON.stringify(Value$outboundSchema.parse(value));
-}
 export function valueFromJSON(
   jsonString: string,
 ): SafeParseResult<Value, SDKValidationError> {
@@ -49,25 +37,7 @@ export const CustomField$inboundSchema: z.ZodType<
   label: z.string(),
   value: z.union([z.string(), z.array(z.string())]),
 });
-/** @internal */
-export type CustomField$Outbound = {
-  label: string;
-  value: string | Array<string>;
-};
 
-/** @internal */
-export const CustomField$outboundSchema: z.ZodType<
-  CustomField$Outbound,
-  z.ZodTypeDef,
-  CustomField
-> = z.object({
-  label: z.string(),
-  value: z.union([z.string(), z.array(z.string())]),
-});
-
-export function customFieldToJSON(customField: CustomField): string {
-  return JSON.stringify(CustomField$outboundSchema.parse(customField));
-}
 export function customFieldFromJSON(
   jsonString: string,
 ): SafeParseResult<CustomField, SDKValidationError> {