vanta-auditor-api-sdk 0.6.3 → 0.6.4

package/src/models/components/personnelperson.ts

@@ -19,7 +19,7 @@ import {
 /**
  * Employment status, or null if not available.
  */
-export const EmploymentStatus = {
+export const PersonnelPersonEmploymentStatus = {
   CurrentlyEmployed: "CURRENTLY_EMPLOYED",
   InactiveEmployee: "INACTIVE_EMPLOYEE",
   NotPeople: "NOT_PEOPLE",
@@ -30,7 +30,9 @@ export const EmploymentStatus = {
 /**
  * Employment status, or null if not available.
  */
-export type EmploymentStatus = ClosedEnum<typeof EmploymentStatus>;
+export type PersonnelPersonEmploymentStatus = ClosedEnum<
+  typeof PersonnelPersonEmploymentStatus
+>;
 
 export type Groups = {
   name: string;
@@ -59,7 +61,7 @@ export type Source = {
  * @remarks
  * Full Audit View only - omitted in Controlled Audit View.
  */
-export type TaskStatus = {
+export type PersonnelPersonTaskStatus = {
   /**
    * Overall user task status.
    */
@@ -241,7 +243,7 @@ export type PersonnelPerson = {
   /**
    * Employment status, or null if not available.
    */
-  employmentStatus?: EmploymentStatus | null | undefined;
+  employmentStatus?: PersonnelPersonEmploymentStatus | null | undefined;
   /**
    * Start date in ISO 8601 format (YYYY-MM-DD), or null if not available.
    *
@@ -274,7 +276,7 @@ export type PersonnelPerson = {
    * @remarks
    * Full Audit View only - omitted in Controlled Audit View.
    */
-  taskStatus?: TaskStatus | null | undefined;
+  taskStatus?: PersonnelPersonTaskStatus | null | undefined;
   /**
    * Last date user was sent an onboarding reminder email in ISO 8601 format, or null if never reminded.
    *
@@ -327,9 +329,9 @@ export type PersonnelPerson = {
 };
 
 /** @internal */
-export const EmploymentStatus$inboundSchema: z.ZodNativeEnum<
-  typeof EmploymentStatus
-> = z.nativeEnum(EmploymentStatus);
+export const PersonnelPersonEmploymentStatus$inboundSchema: z.ZodNativeEnum<
+  typeof PersonnelPersonEmploymentStatus
+> = z.nativeEnum(PersonnelPersonEmploymentStatus);
 
 /** @internal */
 export const Groups$inboundSchema: z.ZodType<Groups, z.ZodTypeDef, unknown> = z
@@ -365,8 +367,8 @@ export function sourceFromJSON(
 }
 
 /** @internal */
-export const TaskStatus$inboundSchema: z.ZodType<
-  TaskStatus,
+export const PersonnelPersonTaskStatus$inboundSchema: z.ZodType<
+  PersonnelPersonTaskStatus,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -378,13 +380,13 @@ export const TaskStatus$inboundSchema: z.ZodType<
   numTasksDueSoon: z.nullable(z.number()),
 });
 
-export function taskStatusFromJSON(
+export function personnelPersonTaskStatusFromJSON(
   jsonString: string,
-): SafeParseResult<TaskStatus, SDKValidationError> {
+): SafeParseResult<PersonnelPersonTaskStatus, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => TaskStatus$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TaskStatus' from JSON`,
+    (x) => PersonnelPersonTaskStatus$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PersonnelPersonTaskStatus' from JSON`,
   );
 }
 
@@ -524,12 +526,14 @@ export const PersonnelPerson$inboundSchema: z.ZodType<
   name: z.string(),
   email: z.string(),
   jobTitle: z.nullable(z.string()).optional(),
-  employmentStatus: z.nullable(EmploymentStatus$inboundSchema).optional(),
+  employmentStatus: z.nullable(PersonnelPersonEmploymentStatus$inboundSchema)
+    .optional(),
   startDate: z.nullable(z.string()).optional(),
   endDate: z.nullable(z.string()).optional(),
   groups: z.array(z.lazy(() => Groups$inboundSchema)).optional(),
   source: z.nullable(z.lazy(() => Source$inboundSchema)).optional(),
-  taskStatus: z.nullable(z.lazy(() => TaskStatus$inboundSchema)).optional(),
+  taskStatus: z.nullable(z.lazy(() => PersonnelPersonTaskStatus$inboundSchema))
+    .optional(),
   lastReminded: z.nullable(z.string()).optional(),
   policies: z.nullable(z.lazy(() => Policies$inboundSchema)).optional(),
   trainings: z.nullable(z.lazy(() => Trainings$inboundSchema)).optional(),

package/src/models/components/scimbasedpersoninfosource.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";
+
+/**
+ * The person's information comes from SCIM.
+ */
+export type ScimBasedPersonInfoSource = {
+  type: "SCIM";
+};
+
+/** @internal */
+export const ScimBasedPersonInfoSource$inboundSchema: z.ZodType<
+  ScimBasedPersonInfoSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("SCIM"),
+});
+
+export function scimBasedPersonInfoSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<ScimBasedPersonInfoSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ScimBasedPersonInfoSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ScimBasedPersonInfoSource' from JSON`,
+  );
+}

package/src/models/components/taskssummarystatus.ts

@@ -0,0 +1,53 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The overall status of a person's outstanding tasks:
+ *
+ * @remarks
+ * - NONE: There are no tasks.
+ * - DUE_SOON: At least one task is due soon.
+ * - OVERDUE: At least one task is overdue. Has a higher priority than DUE_SOON.
+ * - COMPLETE: All tasks are complete.
+ * - PAUSED: All tasks are paused.
+ * - OFFBOARDING_DUE_SOON: At least one offboarding task is due soon.
+ * - OFFBOARDING_OVERDUE: At least one offboarding task is overdue. Has a higher priority than OFFBOARDING_DUE_SOON.
+ * - OFFBOARDING_COMPLETE: All offboarding tasks are complete.
+ */
+export const TasksSummaryStatus = {
+  Complete: "COMPLETE",
+  DueSoon: "DUE_SOON",
+  None: "NONE",
+  OffboardingComplete: "OFFBOARDING_COMPLETE",
+  OffboardingDueSoon: "OFFBOARDING_DUE_SOON",
+  OffboardingOverdue: "OFFBOARDING_OVERDUE",
+  Overdue: "OVERDUE",
+  Paused: "PAUSED",
+} as const;
+/**
+ * The overall status of a person's outstanding tasks:
+ *
+ * @remarks
+ * - NONE: There are no tasks.
+ * - DUE_SOON: At least one task is due soon.
+ * - OVERDUE: At least one task is overdue. Has a higher priority than DUE_SOON.
+ * - COMPLETE: All tasks are complete.
+ * - PAUSED: All tasks are paused.
+ * - OFFBOARDING_DUE_SOON: At least one offboarding task is due soon.
+ * - OFFBOARDING_OVERDUE: At least one offboarding task is overdue. Has a higher priority than OFFBOARDING_DUE_SOON.
+ * - OFFBOARDING_COMPLETE: All offboarding tasks are complete.
+ */
+export type TasksSummaryStatus = ClosedEnum<typeof TasksSummaryStatus>;
+
+/** @internal */
+export const TasksSummaryStatus$inboundSchema: z.ZodNativeEnum<
+  typeof TasksSummaryStatus
+> = z.nativeEnum(TasksSummaryStatus);
+/** @internal */
+export const TasksSummaryStatus$outboundSchema: z.ZodNativeEnum<
+  typeof TasksSummaryStatus
+> = TasksSummaryStatus$inboundSchema;

package/src/models/components/taskstatus.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * 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.
+ */
+export const TaskStatus = {
+  Complete: "COMPLETE",
+  DueSoon: "DUE_SOON",
+  Overdue: "OVERDUE",
+  None: "NONE",
+} as const;
+/**
+ * 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.
+ */
+export type TaskStatus = ClosedEnum<typeof TaskStatus>;
+
+/** @internal */
+export const TaskStatus$inboundSchema: z.ZodNativeEnum<typeof TaskStatus> = z
+  .nativeEnum(TaskStatus);
+/** @internal */
+export const TaskStatus$outboundSchema: z.ZodNativeEnum<typeof TaskStatus> =
+  TaskStatus$inboundSchema;

package/src/models/components/tasksummarydetails.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 {
+  AcceptPoliciesTaskSummary,
+  AcceptPoliciesTaskSummary$inboundSchema,
+} from "./acceptpoliciestasksummary.js";
+import {
+  CompleteBackgroundChecksTaskSummary,
+  CompleteBackgroundChecksTaskSummary$inboundSchema,
+} from "./completebackgroundcheckstasksummary.js";
+import {
+  CompleteCustomTasksTaskSummary,
+  CompleteCustomTasksTaskSummary$inboundSchema,
+} from "./completecustomtaskstasksummary.js";
+import {
+  CompleteOffboardingCustomTasksTaskSummary,
+  CompleteOffboardingCustomTasksTaskSummary$inboundSchema,
+} from "./completeoffboardingcustomtaskstasksummary.js";
+import {
+  CompleteTrainingsTaskSummary,
+  CompleteTrainingsTaskSummary$inboundSchema,
+} from "./completetrainingstasksummary.js";
+import {
+  InstallDeviceMonitoringTaskSummary,
+  InstallDeviceMonitoringTaskSummary$inboundSchema,
+} from "./installdevicemonitoringtasksummary.js";
+
+/**
+ * All detailed information about a person's tasks, split across task categories.
+ */
+export type TaskSummaryDetails = {
+  /**
+   * Task summary for completing all trainings.
+   */
+  completeTrainings: CompleteTrainingsTaskSummary;
+  /**
+   * Policy acceptance details for a person.
+   */
+  acceptPolicies: AcceptPoliciesTaskSummary;
+  /**
+   * Task summary for completing all custom tasks.
+   */
+  completeCustomTasks: CompleteCustomTasksTaskSummary;
+  /**
+   * Task summary for completing all offboarding custom tasks.
+   */
+  completeOffboardingCustomTasks: CompleteOffboardingCustomTasksTaskSummary;
+  /**
+   * Task summary for installing device monitoring.
+   */
+  installDeviceMonitoring: InstallDeviceMonitoringTaskSummary;
+  /**
+   * Task summary for completing background checks.
+   */
+  completeBackgroundChecks: CompleteBackgroundChecksTaskSummary;
+};
+
+/** @internal */
+export const TaskSummaryDetails$inboundSchema: z.ZodType<
+  TaskSummaryDetails,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  completeTrainings: CompleteTrainingsTaskSummary$inboundSchema,
+  acceptPolicies: AcceptPoliciesTaskSummary$inboundSchema,
+  completeCustomTasks: CompleteCustomTasksTaskSummary$inboundSchema,
+  completeOffboardingCustomTasks:
+    CompleteOffboardingCustomTasksTaskSummary$inboundSchema,
+  installDeviceMonitoring: InstallDeviceMonitoringTaskSummary$inboundSchema,
+  completeBackgroundChecks: CompleteBackgroundChecksTaskSummary$inboundSchema,
+});
+
+export function taskSummaryDetailsFromJSON(
+  jsonString: string,
+): SafeParseResult<TaskSummaryDetails, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TaskSummaryDetails$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TaskSummaryDetails' from JSON`,
+  );
+}

package/src/models/components/tasktype.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 type a task summary falls into.
+ *
+ * @remarks
+ * COMPLETE_TRAININGS: The task summary containing security trainings.
+ * ACCEPT_POLICIES: The task summary containing policy acceptance.
+ * COMPLETE_CUSTOM_TASKS: The task summary containing custom tasks.
+ * INSTALL_DEVICE_MONITORING: The task summary containing device monitoring installation.
+ * COMPLETE_BACKGROUND_CHECKS: The task summary containing background checks.
+ */
+export const TaskType = {
+  CompleteTrainings: "COMPLETE_TRAININGS",
+  AcceptPolicies: "ACCEPT_POLICIES",
+  CompleteCustomTasks: "COMPLETE_CUSTOM_TASKS",
+  CompleteCustomOffboardingTasks: "COMPLETE_CUSTOM_OFFBOARDING_TASKS",
+  InstallDeviceMonitoring: "INSTALL_DEVICE_MONITORING",
+  CompleteBackgroundChecks: "COMPLETE_BACKGROUND_CHECKS",
+} as const;
+/**
+ * The type a task summary falls into.
+ *
+ * @remarks
+ * COMPLETE_TRAININGS: The task summary containing security trainings.
+ * ACCEPT_POLICIES: The task summary containing policy acceptance.
+ * COMPLETE_CUSTOM_TASKS: The task summary containing custom tasks.
+ * INSTALL_DEVICE_MONITORING: The task summary containing device monitoring installation.
+ * COMPLETE_BACKGROUND_CHECKS: The task summary containing background checks.
+ */
+export type TaskType = ClosedEnum<typeof TaskType>;
+
+/** @internal */
+export const TaskType$outboundSchema: z.ZodNativeEnum<typeof TaskType> = z
+  .nativeEnum(TaskType);

package/src/models/components/tasktypeacceptpolicies.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeACCEPTPOLICIES = {
+  AcceptPolicies: "ACCEPT_POLICIES",
+} as const;
+export type TaskTypeACCEPTPOLICIES = ClosedEnum<typeof TaskTypeACCEPTPOLICIES>;
+
+/** @internal */
+export const TaskTypeACCEPTPOLICIES$inboundSchema: z.ZodNativeEnum<
+  typeof TaskTypeACCEPTPOLICIES
+> = z.nativeEnum(TaskTypeACCEPTPOLICIES);

package/src/models/components/tasktypecompletebackgroundchecks.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeCOMPLETEBACKGROUNDCHECKS = {
+  CompleteBackgroundChecks: "COMPLETE_BACKGROUND_CHECKS",
+} as const;
+export type TaskTypeCOMPLETEBACKGROUNDCHECKS = ClosedEnum<
+  typeof TaskTypeCOMPLETEBACKGROUNDCHECKS
+>;
+
+/** @internal */
+export const TaskTypeCOMPLETEBACKGROUNDCHECKS$inboundSchema: z.ZodNativeEnum<
+  typeof TaskTypeCOMPLETEBACKGROUNDCHECKS
+> = z.nativeEnum(TaskTypeCOMPLETEBACKGROUNDCHECKS);

package/src/models/components/tasktypecompletecustomoffboardingtasks.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS = {
+  CompleteCustomOffboardingTasks: "COMPLETE_CUSTOM_OFFBOARDING_TASKS",
+} as const;
+export type TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS = ClosedEnum<
+  typeof TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS
+>;
+
+/** @internal */
+export const TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS$inboundSchema:
+  z.ZodNativeEnum<typeof TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS> = z.nativeEnum(
+    TaskTypeCOMPLETECUSTOMOFFBOARDINGTASKS,
+  );

package/src/models/components/tasktypecompletecustomtasks.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeCOMPLETECUSTOMTASKS = {
+  CompleteCustomTasks: "COMPLETE_CUSTOM_TASKS",
+} as const;
+export type TaskTypeCOMPLETECUSTOMTASKS = ClosedEnum<
+  typeof TaskTypeCOMPLETECUSTOMTASKS
+>;
+
+/** @internal */
+export const TaskTypeCOMPLETECUSTOMTASKS$inboundSchema: z.ZodNativeEnum<
+  typeof TaskTypeCOMPLETECUSTOMTASKS
+> = z.nativeEnum(TaskTypeCOMPLETECUSTOMTASKS);

package/src/models/components/tasktypecompletetrainings.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeCOMPLETETRAININGS = {
+  CompleteTrainings: "COMPLETE_TRAININGS",
+} as const;
+export type TaskTypeCOMPLETETRAININGS = ClosedEnum<
+  typeof TaskTypeCOMPLETETRAININGS
+>;
+
+/** @internal */
+export const TaskTypeCOMPLETETRAININGS$inboundSchema: z.ZodNativeEnum<
+  typeof TaskTypeCOMPLETETRAININGS
+> = z.nativeEnum(TaskTypeCOMPLETETRAININGS);

package/src/models/components/tasktypeinstalldevicemonitoring.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const TaskTypeINSTALLDEVICEMONITORING = {
+  InstallDeviceMonitoring: "INSTALL_DEVICE_MONITORING",
+} as const;
+export type TaskTypeINSTALLDEVICEMONITORING = ClosedEnum<
+  typeof TaskTypeINSTALLDEVICEMONITORING
+>;
+
+/** @internal */
+export const TaskTypeINSTALLDEVICEMONITORING$inboundSchema: z.ZodNativeEnum<
+  typeof TaskTypeINSTALLDEVICEMONITORING
+> = z.nativeEnum(TaskTypeINSTALLDEVICEMONITORING);

package/src/models/components/training.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 person's security training.
+ */
+export type Training = {
+  name: string;
+};
+
+/** @internal */
+export const Training$inboundSchema: z.ZodType<
+  Training,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+export function trainingFromJSON(
+  jsonString: string,
+): SafeParseResult<Training, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Training$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Training' from JSON`,
+  );
+}

package/src/models/components/vantabasedpersoninfosource.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";
+
+/**
+ * The person's information comes from what is set in Vanta.
+ */
+export type VantaBasedPersonInfoSource = {
+  type: "VANTA";
+};
+
+/** @internal */
+export const VantaBasedPersonInfoSource$inboundSchema: z.ZodType<
+  VantaBasedPersonInfoSource,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("VANTA"),
+});
+
+export function vantaBasedPersonInfoSourceFromJSON(
+  jsonString: string,
+): SafeParseResult<VantaBasedPersonInfoSource, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => VantaBasedPersonInfoSource$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'VantaBasedPersonInfoSource' from JSON`,
+  );
+}