vanta-auditor-api-sdk 0.6.3 → 0.7.0

package/src/models/components/computerstatusfilter.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Enum representing computer compliance statuses that can be utilized as a filter. The meanings are as follows:
+ *
+ * @remarks
+ * AV_NOT_INSTALLED: The computer does not have antivirus software installed.
+ * HD_NOT_ENCRYPTED: The computer's harddrive is not encrypted.
+ * LAST_CHECK_OVER_14_DAYS: No data has been received from computer for over 14 days.
+ * PWM_NOT_INSTALLED: The computer does not have a password manager installed.
+ * SCREENLOCK_NOT_CONFIGURED: The computer does not have screenlock configured appropriately.
+ */
+export const ComputerStatusFilter = {
+  PwmNotInstalled: "PWM_NOT_INSTALLED",
+  HdNotEncrypted: "HD_NOT_ENCRYPTED",
+  AvNotInstalled: "AV_NOT_INSTALLED",
+  ScreenlockNotConfigured: "SCREENLOCK_NOT_CONFIGURED",
+  LastCheckOver14Days: "LAST_CHECK_OVER_14_DAYS",
+} as const;
+/**
+ * Enum representing computer compliance statuses that can be utilized as a filter. The meanings are as follows:
+ *
+ * @remarks
+ * AV_NOT_INSTALLED: The computer does not have antivirus software installed.
+ * HD_NOT_ENCRYPTED: The computer's harddrive is not encrypted.
+ * LAST_CHECK_OVER_14_DAYS: No data has been received from computer for over 14 days.
+ * PWM_NOT_INSTALLED: The computer does not have a password manager installed.
+ * SCREENLOCK_NOT_CONFIGURED: The computer does not have screenlock configured appropriately.
+ */
+export type ComputerStatusFilter = ClosedEnum<typeof ComputerStatusFilter>;
+
+/** @internal */
+export const ComputerStatusFilter$outboundSchema: z.ZodNativeEnum<
+  typeof ComputerStatusFilter
+> = z.nativeEnum(ComputerStatusFilter);

package/src/models/components/computerstatusoutcome.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";
+
+/**
+ * The possible outcomes of a status check. The outcome can be one of the following:
+ *
+ * @remarks
+ * FAIL:  The check is failing.
+ * IN_PROGRESS: The check needs further data from the given computer in order to evaluate. The field(s) needed from a computer to calculate the ComputerStatusOutcome were null.
+ * NA: The check is not applicable for the given computer.
+ * PASS: The check is passing.
+ */
+export const ComputerStatusOutcome = {
+  Fail: "FAIL",
+  InProgress: "IN_PROGRESS",
+  Na: "NA",
+  Pass: "PASS",
+} as const;
+/**
+ * The possible outcomes of a status check. The outcome can be one of the following:
+ *
+ * @remarks
+ * FAIL:  The check is failing.
+ * IN_PROGRESS: The check needs further data from the given computer in order to evaluate. The field(s) needed from a computer to calculate the ComputerStatusOutcome were null.
+ * NA: The check is not applicable for the given computer.
+ * PASS: The check is passing.
+ */
+export type ComputerStatusOutcome = ClosedEnum<typeof ComputerStatusOutcome>;
+
+/** @internal */
+export const ComputerStatusOutcome$inboundSchema: z.ZodNativeEnum<
+  typeof ComputerStatusOutcome
+> = z.nativeEnum(ComputerStatusOutcome);

package/src/models/components/currencycode.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const CurrencyCode = {
+  Ars: "ARS",
+  Aud: "AUD",
+  Brl: "BRL",
+  Cad: "CAD",
+  Cop: "COP",
+  Czk: "CZK",
+  Dkk: "DKK",
+  Eur: "EUR",
+  Gbp: "GBP",
+  Ils: "ILS",
+  Inr: "INR",
+  Jpy: "JPY",
+  Mxn: "MXN",
+  Nok: "NOK",
+  Nzd: "NZD",
+  Php: "PHP",
+  Pkr: "PKR",
+  Pln: "PLN",
+  Rsd: "RSD",
+  Sek: "SEK",
+  Sgd: "SGD",
+  Uah: "UAH",
+  Usd: "USD",
+  Zar: "ZAR",
+} as const;
+export type CurrencyCode = ClosedEnum<typeof CurrencyCode>;
+
+/** @internal */
+export const CurrencyCode$inboundSchema: z.ZodNativeEnum<typeof CurrencyCode> =
+  z.nativeEnum(CurrencyCode);

package/src/models/components/customtask.ts

@@ -0,0 +1,34 @@
+/*
+ * 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";
+
+/**
+ * A custom task.
+ */
+export type CustomTask = {
+  name: string;
+};
+
+/** @internal */
+export const CustomTask$inboundSchema: z.ZodType<
+  CustomTask,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+export function customTaskFromJSON(
+  jsonString: string,
+): SafeParseResult<CustomTask, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CustomTask$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CustomTask' from JSON`,
+  );
+}

package/src/models/components/employmentstatus.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The employment status of a person:
+ *
+ * @remarks
+ * - UPCOMING: The person is not yet employed and will start employment in the future.
+ * - CURRENT: The person is currently employed.
+ * - ON_LEAVE: The person is on leave.
+ * - INACTIVE: The person's employment is inactive.
+ * - FORMER: The person was previously employed.
+ */
+export const EmploymentStatus = {
+  Upcoming: "UPCOMING",
+  Current: "CURRENT",
+  OnLeave: "ON_LEAVE",
+  Inactive: "INACTIVE",
+  Former: "FORMER",
+} as const;
+/**
+ * The employment status of a person:
+ *
+ * @remarks
+ * - UPCOMING: The person is not yet employed and will start employment in the future.
+ * - CURRENT: The person is currently employed.
+ * - ON_LEAVE: The person is on leave.
+ * - INACTIVE: The person's employment is inactive.
+ * - FORMER: The person was previously employed.
+ */
+export type EmploymentStatus = ClosedEnum<typeof EmploymentStatus>;
+
+/** @internal */
+export const EmploymentStatus$inboundSchema: z.ZodNativeEnum<
+  typeof EmploymentStatus
+> = z.nativeEnum(EmploymentStatus);

package/src/models/components/externalfindingseverity.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";
+
+/**
+ * ExternalFindingSeverity describes the severity of an external finding (Vulnerability or Security Alert)
+ */
+export const ExternalFindingSeverity = {
+  Critical: "CRITICAL",
+  High: "HIGH",
+  Low: "LOW",
+  Medium: "MEDIUM",
+} as const;
+/**
+ * ExternalFindingSeverity describes the severity of an external finding (Vulnerability or Security Alert)
+ */
+export type ExternalFindingSeverity = ClosedEnum<
+  typeof ExternalFindingSeverity
+>;
+
+/** @internal */
+export const ExternalFindingSeverity$outboundSchema: z.ZodNativeEnum<
+  typeof ExternalFindingSeverity
+> = z.nativeEnum(ExternalFindingSeverity);

package/src/models/components/externalfindingseveritytype.ts

@@ -0,0 +1,21 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const ExternalFindingSeverityType = {
+  Critical: "CRITICAL",
+  High: "HIGH",
+  Low: "LOW",
+  Medium: "MEDIUM",
+} as const;
+export type ExternalFindingSeverityType = ClosedEnum<
+  typeof ExternalFindingSeverityType
+>;
+
+/** @internal */
+export const ExternalFindingSeverityType$inboundSchema: z.ZodNativeEnum<
+  typeof ExternalFindingSeverityType
+> = z.nativeEnum(ExternalFindingSeverityType);

package/src/models/components/index.ts

@@ -3,6 +3,7 @@
  */
 
 export * from "./acceptinformationrequestevidenceinput.js";
+export * from "./acceptpoliciestasksummary.js";
 export * from "./accountaccess.js";
 export * from "./accountaccessservice.js";
 export * from "./accountaccessstatus.js";
@@ -16,6 +17,7 @@ export * from "./auditevidencetype.js";
 export * from "./auditevidenceupdateinput.js";
 export * from "./auditfocus.js";
 export * from "./auditor.js";
+export * from "./auditorapivulnerability.js";
 export * from "./auditorcontrol.js";
 export * from "./auditorenabledstatetransition.js";
 export * from "./auditrisk.js";
@@ -25,18 +27,30 @@ export * from "./auditvendorrisklevel.js";
 export * from "./auditvendorstatus.js";
 export * from "./codechange.js";
 export * from "./comment.js";
+export * from "./completebackgroundcheckstasksummary.js";
+export * from "./completecustomtaskstasksummary.js";
+export * from "./completeoffboardingcustomtaskstasksummary.js";
+export * from "./completetrainingstasksummary.js";
+export * from "./computerstatus.js";
+export * from "./computerstatusfilter.js";
+export * from "./computerstatusoutcome.js";
 export * from "./control.js";
 export * from "./controldomain.js";
 export * from "./controlsource.js";
 export * from "./createcustomcontrolinput.js";
 export * from "./createcustomevidencerequestinput.js";
 export * from "./createinformationrequestinput.js";
+export * from "./currencycode.js";
 export * from "./customevidencerequest.js";
 export * from "./customfield.js";
+export * from "./customtask.js";
 export * from "./deleteinformationrequestcommentinput.js";
+export * from "./employmentstatus.js";
 export * from "./evidence.js";
 export * from "./evidencecontrol.js";
 export * from "./evidenceurl.js";
+export * from "./externalfindingseverity.js";
+export * from "./externalfindingseveritytype.js";
 export * from "./flaginformationrequestevidenceinput.js";
 export * from "./frameworkcodes.js";
 export * from "./frameworkid.js";
@@ -52,12 +66,18 @@ export * from "./informationrequestevidence.js";
 export * from "./informationrequestevidenceunion.js";
 export * from "./informationrequestsupportedevidencetype.js";
 export * from "./informationrequesttype.js";
+export * from "./installdevicemonitoringtasksummary.js";
+export * from "./integrationbasedpersoninfosource.js";
 export * from "./issuesnapshotitem.js";
 export * from "./issuesnapshotitemorderby.js";
 export * from "./issuesnapshotmetadata.js";
 export * from "./issuestatustypeforsnapshot.js";
+export * from "./keyvaluepair.js";
+export * from "./leavestatus.js";
 export * from "./linkevidence.js";
+export * from "./monitoredcomputer.js";
 export * from "./observationevidence.js";
+export * from "./operatingsystemtype.js";
 export * from "./orderdirection.js";
 export * from "./pageinfo.js";
 export * from "./paginatedissuesnapshotitemsresponse.js";
@@ -65,6 +85,7 @@ export * from "./paginatedissuesnapshotmetadataresponse.js";
 export * from "./paginatedresponseaccountaccess.js";
 export * from "./paginatedresponseaccountaccessservice.js";
 export * from "./paginatedresponseaudit.js";
+export * from "./paginatedresponseauditorapivulnerability.js";
 export * from "./paginatedresponseauditorcontrol.js";
 export * from "./paginatedresponseauditrisk.js";
 export * from "./paginatedresponseauditvendor.js";
@@ -76,24 +97,44 @@ export * from "./paginatedresponseinformationrequest.js";
 export * from "./paginatedresponseinformationrequestactivitylog.js";
 export * from "./paginatedresponseinformationrequestcomment.js";
 export * from "./paginatedresponseinformationrequestevidence.js";
+export * from "./paginatedresponsemonitoredcomputer.js";
+export * from "./paginatedresponseperson.js";
 export * from "./paginatedresponsepersonnelgroup.js";
 export * from "./paginatedresponsepersonnelperson.js";
 export * from "./paginatedresponserisksnapshot.js";
+export * from "./paginatedresponsevendor.js";
+export * from "./paginatedresponsevulnerabilityremediation.js";
+export * from "./paginatedresponsevulnerableasset.js";
 export * from "./partialupdateinformationrequest.js";
 export * from "./peopleemploymentstatus.js";
 export * from "./peopleorderby.js";
 export * from "./peoplesecuritytaskstatus.js";
 export * from "./peopletaskstatus.js";
+export * from "./person.js";
+export * from "./personinfosource.js";
 export * from "./personnelgroup.js";
 export * from "./personnelgrouptask.js";
 export * from "./personnelperson.js";
 export * from "./recurrenceduration.js";
 export * from "./riskorderby.js";
 export * from "./risksnapshot.js";
+export * from "./scimbasedpersoninfosource.js";
 export * from "./section.js";
 export * from "./security.js";
+export * from "./taskssummarystatus.js";
+export * from "./taskstatus.js";
+export * from "./tasksummarydetails.js";
+export * from "./tasktype.js";
+export * from "./tasktypeacceptpolicies.js";
+export * from "./tasktypecompletebackgroundchecks.js";
+export * from "./tasktypecompletecustomoffboardingtasks.js";
+export * from "./tasktypecompletecustomtasks.js";
+export * from "./tasktypecompletetrainings.js";
+export * from "./tasktypeinstalldevicemonitoring.js";
+export * from "./training.js";
 export * from "./updateinformationrequestcommentinput.js";
 export * from "./uploadeddocumentevidence.js";
+export * from "./vantabasedpersoninfosource.js";
 export * from "./vantadocumentevidence.js";
 export * from "./vantadocumentlinkevidence.js";
 export * from "./vantadocumentuploadedevidence.js";
@@ -105,4 +146,13 @@ export * from "./vantatestsnapshotevidence.js";
 export * from "./vantatestsnapshotevidencedetail.js";
 export * from "./vantatestsnapshotintegration.js";
 export * from "./vantatestsnapshotrawtestdatarow.js";
+export * from "./vendor.js";
+export * from "./vendordecisionstatus.js";
 export * from "./vendororderby.js";
+export * from "./vendorrisklevel.js";
+export * from "./vendorstatus.js";
+export * from "./vulnerabilityremediation.js";
+export * from "./vulnerabilitytype.js";
+export * from "./vulnerableasset.js";
+export * from "./vulnerableassetscanner.js";
+export * from "./vulnerableassettype.js";

package/src/models/components/installdevicemonitoringtasksummary.ts

@@ -0,0 +1,104 @@
+/*
+ * 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 { TaskStatus, TaskStatus$inboundSchema } from "./taskstatus.js";
+import {
+  TaskTypeINSTALLDEVICEMONITORING,
+  TaskTypeINSTALLDEVICEMONITORING$inboundSchema,
+} from "./tasktypeinstalldevicemonitoring.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type InstallDeviceMonitoringTaskSummaryDisabled = {
+  date: Date;
+  reason: string | null;
+};
+
+/**
+ * Task summary for installing device monitoring.
+ */
+export type InstallDeviceMonitoringTaskSummary = {
+  taskType: TaskTypeINSTALLDEVICEMONITORING;
+  /**
+   * The status of a task.
+   *
+   * @remarks
+   * - COMPLETE: The task has been completed.
+   * - DUE_SOON: The task is due soon.
+   * - OVERDUE: The task is overdue.
+   * - NONE: The task is not assigned.
+   */
+  status: TaskStatus;
+  /**
+   * The due date of the task.
+   */
+  dueDate: Date | null;
+  /**
+   * The date the task was completed.
+   */
+  completionDate: Date | null;
+  /**
+   * If the task is disabled, the reason and date when it was disabled.
+   */
+  disabled: InstallDeviceMonitoringTaskSummaryDisabled | null;
+};
+
+/** @internal */
+export const InstallDeviceMonitoringTaskSummaryDisabled$inboundSchema:
+  z.ZodType<InstallDeviceMonitoringTaskSummaryDisabled, z.ZodTypeDef, unknown> =
+    z.object({
+      date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+      reason: z.nullable(z.string()),
+    });
+
+export function installDeviceMonitoringTaskSummaryDisabledFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  InstallDeviceMonitoringTaskSummaryDisabled,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      InstallDeviceMonitoringTaskSummaryDisabled$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'InstallDeviceMonitoringTaskSummaryDisabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const InstallDeviceMonitoringTaskSummary$inboundSchema: z.ZodType<
+  InstallDeviceMonitoringTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeINSTALLDEVICEMONITORING$inboundSchema,
+  status: TaskStatus$inboundSchema,
+  dueDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  completionDate: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ),
+  disabled: z.nullable(
+    z.lazy(() => InstallDeviceMonitoringTaskSummaryDisabled$inboundSchema),
+  ),
+});
+
+export function installDeviceMonitoringTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<InstallDeviceMonitoringTaskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      InstallDeviceMonitoringTaskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InstallDeviceMonitoringTaskSummary' from JSON`,
+  );
+}

package/src/models/components/integrationbasedpersoninfosource.ts

@@ -0,0 +1,38 @@
+/*
+ * 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";
+
+/**
+ * The person's information comes from an integration.
+ */
+export type IntegrationBasedPersonInfoSource = {
+  integrationId: string;
+  resourceId: string | null;
+  type: "INTEGRATION";
+};
+
+/** @internal */
+export const IntegrationBasedPersonInfoSource$inboundSchema: z.ZodType<
+  IntegrationBasedPersonInfoSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  integrationId: z.string(),
+  resourceId: z.nullable(z.string()),
+  type: z.literal("INTEGRATION"),
+});
+
+export function integrationBasedPersonInfoSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<IntegrationBasedPersonInfoSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => IntegrationBasedPersonInfoSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'IntegrationBasedPersonInfoSource' from JSON`,
+  );
+}

package/src/models/components/keyvaluepair.ts

@@ -0,0 +1,39 @@
+/*
+ * 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";
+
+export type KeyValuePair = {
+  /**
+   * Key of key-value pair.
+   */
+  key: string;
+  /**
+   * Value of key-value pair.
+   */
+  value: string;
+};
+
+/** @internal */
+export const KeyValuePair$inboundSchema: z.ZodType<
+  KeyValuePair,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  key: z.string(),
+  value: z.string(),
+});
+
+export function keyValuePairFromJSON(
+  jsonString: string,
+): SafeParseResult<KeyValuePair, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => KeyValuePair$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'KeyValuePair' from JSON`,
+  );
+}

package/src/models/components/leavestatus.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";
+
+/**
+ * User can be active or upcoming leave period
+ */
+export const LeaveStatus = {
+  Active: "ACTIVE",
+  Upcoming: "UPCOMING",
+} as const;
+/**
+ * User can be active or upcoming leave period
+ */
+export type LeaveStatus = ClosedEnum<typeof LeaveStatus>;
+
+/** @internal */
+export const LeaveStatus$inboundSchema: z.ZodNativeEnum<typeof LeaveStatus> = z
+  .nativeEnum(LeaveStatus);