import {z} from 'zod' export type PageSize = number; export type PageCursor = string; export type TasksSummaryStatus = 'COMPLETE' | 'DUE_SOON' | 'NONE' | 'OFFBOARDING_COMPLETE' | 'OFFBOARDING_DUE_SOON' | 'OFFBOARDING_OVERDUE' | 'OVERDUE' | 'PAUSED'; export type TaskType = 'COMPLETE_TRAININGS' | 'ACCEPT_POLICIES' | 'COMPLETE_CUSTOM_TASKS' | 'COMPLETE_CUSTOM_OFFBOARDING_TASKS' | 'INSTALL_DEVICE_MONITORING' | 'COMPLETE_BACKGROUND_CHECKS'; export type TaskStatus = 'COMPLETE' | 'DUE_SOON' | 'OVERDUE' | 'NONE'; export type GetApiAuditsAuditIdPeopleArgs = {auditId: string, pageSize?: PageSize | undefined, pageCursor?: PageCursor | undefined, tasksSummaryStatusMatchesAny?: Array | undefined, taskTypeMatchesAny?: Array | undefined, taskStatusMatchesAny?: Array | undefined}; export type GetApiAuditsAuditIdPeopleOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const employmentStatus = z.enum(["UPCOMING", "CURRENT", "ON_LEAVE", "INACTIVE", "FORMER"]); export const leaveStatus = z.enum(["ACTIVE", "UPCOMING"]); export const leaveInfo = z.object({startDate: z.string(), endDate: z.string().nullable(), status: leaveStatus}); export const personInfoSourceTypeVANTA = z.literal("VANTA"); export const vantaBasedPersonInfoSource = z.object({type: personInfoSourceTypeVANTA}); export const personInfoSourceTypeSCIM = z.literal("SCIM"); export const scimBasedPersonInfoSource = z.object({type: personInfoSourceTypeSCIM}); export const personInfoSourceTypeINTEGRATION = z.literal("INTEGRATION"); export const integrationBasedPersonInfoSource = z.object({integrationId: z.string(), resourceId: z.string().nullable(), type: personInfoSourceTypeINTEGRATION}); export const personInfoSource = z.union([vantaBasedPersonInfoSource, scimBasedPersonInfoSource, integrationBasedPersonInfoSource]); export const taskTypeCOMPLETETRAININGS = z.literal("COMPLETE_TRAININGS"); export const taskStatus = z.enum(["COMPLETE", "DUE_SOON", "OVERDUE", "NONE"]); export const training = z.object({name: z.string()}); export const completeTrainingsTaskSummary = z.object({taskType: taskTypeCOMPLETETRAININGS, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable(), incompleteTrainings: z.array(training), completedTrainings: z.array(training)}); export const taskTypeACCEPTPOLICIES = z.literal("ACCEPT_POLICIES"); export const acceptPoliciesTaskSummary = z.object({taskType: taskTypeACCEPTPOLICIES, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable(), unacceptedPolicies: z.array(z.object({name: z.string()})), acceptedPolicies: z.array(z.object({name: z.string()}))}); export const taskTypeCOMPLETECUSTOMTASKS = z.literal("COMPLETE_CUSTOM_TASKS"); export const customTask = z.object({name: z.string()}); export const completeCustomTasksTaskSummary = z.object({taskType: taskTypeCOMPLETECUSTOMTASKS, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable(), incompleteCustomTasks: z.array(customTask), completedCustomTasks: z.array(customTask)}); export const taskTypeCOMPLETECUSTOMOFFBOARDINGTASKS = z.literal("COMPLETE_CUSTOM_OFFBOARDING_TASKS"); export const completeOffboardingCustomTasksTaskSummary = z.object({taskType: taskTypeCOMPLETECUSTOMOFFBOARDINGTASKS, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable(), incompleteCustomOffboardingTasks: z.array(customTask), completedCustomOffboardingTasks: z.array(customTask)}); export const taskTypeINSTALLDEVICEMONITORING = z.literal("INSTALL_DEVICE_MONITORING"); export const installDeviceMonitoringTaskSummary = z.object({taskType: taskTypeINSTALLDEVICEMONITORING, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable()}); export const taskTypeCOMPLETEBACKGROUNDCHECKS = z.literal("COMPLETE_BACKGROUND_CHECKS"); export const completeBackgroundChecksTaskSummary = z.object({taskType: taskTypeCOMPLETEBACKGROUNDCHECKS, status: taskStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable(), disabled: z.object({date: z.string(), reason: z.string().nullable()}).nullable()}); export const taskSummaryDetails = z.object({completeTrainings: completeTrainingsTaskSummary, acceptPolicies: acceptPoliciesTaskSummary, completeCustomTasks: completeCustomTasksTaskSummary, completeOffboardingCustomTasks: completeOffboardingCustomTasksTaskSummary, installDeviceMonitoring: installDeviceMonitoringTaskSummary, completeBackgroundChecks: completeBackgroundChecksTaskSummary}); export const tasksSummaryStatus = z.enum(["COMPLETE", "DUE_SOON", "NONE", "OFFBOARDING_COMPLETE", "OFFBOARDING_DUE_SOON", "OFFBOARDING_OVERDUE", "OVERDUE", "PAUSED"]); export const person = z.object({id: z.string(), userId: z.string().nullable(), emailAddress: z.string(), employment: z.object({status: employmentStatus, startDate: z.string(), jobTitle: z.string().nullable(), endDate: z.string().nullable()}), leaveInfo: leaveInfo.nullable(), groupIds: z.array(z.string()), name: z.object({first: z.string().nullable(), last: z.string().nullable(), display: z.string()}), sources: z.object({employment: z.object({endDate: personInfoSource, startDate: personInfoSource}), emailAddress: personInfoSource}), tasksSummary: z.object({details: taskSummaryDetails, status: tasksSummaryStatus, dueDate: z.string().nullable(), completionDate: z.string().nullable()})}); export const pageInfo = z.object({endCursor: z.string().nullable(), hasNextPage: z.boolean(), hasPreviousPage: z.boolean(), startCursor: z.string().nullable()}); export const paginatedResponsePerson = z.object({results: z.object({data: z.array(person), pageInfo: pageInfo})}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * List of people who are in scope for this audit * * GET /audits/{auditId}/people */ export const getApiAuditsAuditIdPeople = async (args: GetApiAuditsAuditIdPeopleArgs, options?: GetApiAuditsAuditIdPeopleOptions) => { const {baseUrl = "https://api.vanta.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.pageCursor != null) query.append("pageCursor", String(args.pageCursor)) for (const item of args.tasksSummaryStatusMatchesAny ?? []) query.append("tasksSummaryStatusMatchesAny", String(item)) for (const item of args.taskTypeMatchesAny ?? []) query.append("taskTypeMatchesAny", String(item)) for (const item of args.taskStatusMatchesAny ?? []) query.append("taskStatusMatchesAny", String(item)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/audits/${encodeURIComponent(String(args.auditId))}/people${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(paginatedResponsePerson, await res.json()) };