vanta-auditor-api-sdk 0.6.3 → 0.6.4

package/src/models/components/completecustomtaskstasksummary.ts

@@ -0,0 +1,111 @@
+/*
+ * 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 { CustomTask, CustomTask$inboundSchema } from "./customtask.js";
+import { TaskStatus, TaskStatus$inboundSchema } from "./taskstatus.js";
+import {
+  TaskTypeCOMPLETECUSTOMTASKS,
+  TaskTypeCOMPLETECUSTOMTASKS$inboundSchema,
+} from "./tasktypecompletecustomtasks.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type CompleteCustomTasksTaskSummaryDisabled = {
+  date: Date;
+  reason: string | null;
+};
+
+/**
+ * Task summary for completing all custom tasks.
+ */
+export type CompleteCustomTasksTaskSummary = {
+  taskType: TaskTypeCOMPLETECUSTOMTASKS;
+  /**
+   * 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: CompleteCustomTasksTaskSummaryDisabled | null;
+  /**
+   * Incomplete custom tasks that are relevant given a person's requirements.
+   */
+  incompleteCustomTasks: Array<CustomTask>;
+  /**
+   * Custom tasks that have been completed and are relevant given a person's current requirements.
+   */
+  completedCustomTasks: Array<CustomTask>;
+};
+
+/** @internal */
+export const CompleteCustomTasksTaskSummaryDisabled$inboundSchema: z.ZodType<
+  CompleteCustomTasksTaskSummaryDisabled,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  reason: z.nullable(z.string()),
+});
+
+export function completeCustomTasksTaskSummaryDisabledFromJSON(
+  jsonString: string,
+): SafeParseResult<CompleteCustomTasksTaskSummaryDisabled, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompleteCustomTasksTaskSummaryDisabled$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompleteCustomTasksTaskSummaryDisabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompleteCustomTasksTaskSummary$inboundSchema: z.ZodType<
+  CompleteCustomTasksTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeCOMPLETECUSTOMTASKS$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(() => CompleteCustomTasksTaskSummaryDisabled$inboundSchema),
+  ),
+  incompleteCustomTasks: z.array(CustomTask$inboundSchema),
+  completedCustomTasks: z.array(CustomTask$inboundSchema),
+});
+
+export function completeCustomTasksTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CompleteCustomTasksTaskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompleteCustomTasksTaskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompleteCustomTasksTaskSummary' from JSON`,
+  );
+}

package/src/models/components/completeoffboardingcustomtaskstasksummary.ts

@@ -0,0 +1,125 @@
+/*
+ * 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 { CustomTask, CustomTask$inboundSchema } from "./customtask.js";
+import { TaskStatus, TaskStatus$inboundSchema } from "./taskstatus.js";
+import {
+  TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS,
+  TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS$inboundSchema,
+} from "./tasktypecompletecustomoffboardingtasks.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type CompleteOffboardingCustomTasksTaskSummaryDisabled = {
+  date: Date;
+  reason: string | null;
+};
+
+/**
+ * Task summary for completing all offboarding custom tasks.
+ */
+export type CompleteOffboardingCustomTasksTaskSummary = {
+  taskType: TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS;
+  /**
+   * 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: CompleteOffboardingCustomTasksTaskSummaryDisabled | null;
+  /**
+   * Incomplete custom tasks that are relevant given a person's requirements.
+   */
+  incompleteCustomOffboardingTasks: Array<CustomTask>;
+  /**
+   * Custom tasks that have been completed and are relevant given a person's current requirements.
+   */
+  completedCustomOffboardingTasks: Array<CustomTask>;
+};
+
+/** @internal */
+export const CompleteOffboardingCustomTasksTaskSummaryDisabled$inboundSchema:
+  z.ZodType<
+    CompleteOffboardingCustomTasksTaskSummaryDisabled,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+    reason: z.nullable(z.string()),
+  });
+
+export function completeOffboardingCustomTasksTaskSummaryDisabledFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CompleteOffboardingCustomTasksTaskSummaryDisabled,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompleteOffboardingCustomTasksTaskSummaryDisabled$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CompleteOffboardingCustomTasksTaskSummaryDisabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompleteOffboardingCustomTasksTaskSummary$inboundSchema: z.ZodType<
+  CompleteOffboardingCustomTasksTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS$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(() =>
+      CompleteOffboardingCustomTasksTaskSummaryDisabled$inboundSchema
+    ),
+  ),
+  incompleteCustomOffboardingTasks: z.array(CustomTask$inboundSchema),
+  completedCustomOffboardingTasks: z.array(CustomTask$inboundSchema),
+});
+
+export function completeOffboardingCustomTasksTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  CompleteOffboardingCustomTasksTaskSummary,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      CompleteOffboardingCustomTasksTaskSummary$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'CompleteOffboardingCustomTasksTaskSummary' from JSON`,
+  );
+}

package/src/models/components/completetrainingstasksummary.ts

@@ -0,0 +1,108 @@
+/*
+ * 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 {
+  TaskTypeCOMPLETETRAININGS,
+  TaskTypeCOMPLETETRAININGS$inboundSchema,
+} from "./tasktypecompletetrainings.js";
+import { Training, Training$inboundSchema } from "./training.js";
+
+/**
+ * If the task is disabled, the reason and date when it was disabled.
+ */
+export type Disabled = {
+  date: Date;
+  reason: string | null;
+};
+
+/**
+ * Task summary for completing all trainings.
+ */
+export type CompleteTrainingsTaskSummary = {
+  taskType: TaskTypeCOMPLETETRAININGS;
+  /**
+   * 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: Disabled | null;
+  /**
+   * Incomplete security trainings that are relevant given a person's requirements.
+   */
+  incompleteTrainings: Array<Training>;
+  /**
+   * Security trainings that have been completed and are relevant given a person's current requirements.
+   */
+  completedTrainings: Array<Training>;
+};
+
+/** @internal */
+export const Disabled$inboundSchema: z.ZodType<
+  Disabled,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  date: z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  reason: z.nullable(z.string()),
+});
+
+export function disabledFromJSON(
+  jsonString: string,
+): SafeParseResult<Disabled, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Disabled$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Disabled' from JSON`,
+  );
+}
+
+/** @internal */
+export const CompleteTrainingsTaskSummary$inboundSchema: z.ZodType<
+  CompleteTrainingsTaskSummary,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  taskType: TaskTypeCOMPLETETRAININGS$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(() => Disabled$inboundSchema)),
+  incompleteTrainings: z.array(Training$inboundSchema),
+  completedTrainings: z.array(Training$inboundSchema),
+});
+
+export function completeTrainingsTaskSummaryFromJSON(
+  jsonString: string,
+): SafeParseResult<CompleteTrainingsTaskSummary, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CompleteTrainingsTaskSummary$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CompleteTrainingsTaskSummary' from JSON`,
+  );
+}

package/src/models/components/computerstatus.ts

@@ -0,0 +1,47 @@
+/*
+ * 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 {
+  ComputerStatusOutcome,
+  ComputerStatusOutcome$inboundSchema,
+} from "./computerstatusoutcome.js";
+
+/**
+ * The a status check for a computer. Representation for screenlock, diskEncryption, passwordManager, and antivirusInstallation.
+ */
+export type ComputerStatus = {
+  /**
+   * 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.
+   */
+  outcome: ComputerStatusOutcome;
+};
+
+/** @internal */
+export const ComputerStatus$inboundSchema: z.ZodType<
+  ComputerStatus,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  outcome: ComputerStatusOutcome$inboundSchema,
+});
+
+export function computerStatusFromJSON(
+  jsonString: string,
+): SafeParseResult<ComputerStatus, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ComputerStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ComputerStatus' from JSON`,
+  );
+}

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);