import {z} from 'zod' export type PageSize = number; export type PageCursor = string; export type InformationRequestSupportedEvidenceType = 'UPLOADED_DOCUMENT' | 'OBSERVATION' | 'LINK' | 'VANTA_DOCUMENT' | 'VANTA_POLICY' | 'VANTA_TEST' | 'VANTA_TEST_SNAPSHOT'; export type GetApiAuditsAuditIdInformationRequestsRequestIdEvidenceArgs = {auditId: string, requestId: string, pageSize?: PageSize | undefined, pageCursor?: PageCursor | undefined, changedSinceDate?: string | undefined, evidenceTypeMatchesAny?: Array | undefined}; export type GetApiAuditsAuditIdInformationRequestsRequestIdEvidenceOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const informationRequestSupportedEvidenceType = z.enum(["UPLOADED_DOCUMENT", "OBSERVATION", "LINK", "VANTA_DOCUMENT", "VANTA_POLICY", "VANTA_TEST", "VANTA_TEST_SNAPSHOT"]); export const uploadedDocumentEvidence = z.object({id: z.string(), filename: z.string().optional(), mimeType: z.string(), url: z.string()}); export const linkEvidence = z.object({title: z.string(), description: z.string().optional(), url: z.string()}); export const observationEvidence = z.object({observationDetails: z.string()}); export const vantaDocumentUploadedEvidence = z.object({type: z.literal("uploaded"), id: z.string(), filename: z.string().optional(), mimeType: z.string(), url: z.string()}); export const vantaDocumentLinkEvidence = z.object({type: z.literal("link"), id: z.string(), url: z.string()}); export const vantaDocumentEvidence = z.object({title: z.string(), description: z.string().optional(), expirationDate: z.string().optional(), addedBy: z.object({email: z.string(), name: z.string()}).optional(), documentVersionId: z.string(), file: z.union([vantaDocumentUploadedEvidence, vantaDocumentLinkEvidence])}); export const vantaPolicyEvidence = z.object({title: z.string(), description: z.string().optional(), expirationDate: z.string().optional(), lastEditedBy: z.object({email: z.string(), name: z.string()}).optional(), policyId: z.string(), policyVersionId: z.string(), policyVersionFileId: z.string(), file: z.object({effectiveOrCreationDate: z.string(), locale: z.string(), url: z.string(), mimeType: z.string(), filename: z.string().optional(), id: z.string()})}); export const vantaTestRunStatus = z.enum(["NA", "IN_PROGRESS", "FAIL", "PASS", "INVALID", "DISABLED"]); export const vantaTestFileType = z.enum(["TEST_EVIDENCE_WORKPAPER", "TEST_RAW_DATA", "OUT_OF_SCOPE_RESOURCES", "API_REQUESTS"]); export const vantaTestEvidence = z.object({title: z.string(), testId: z.string(), snapshotId: z.string(), testRunStatus: vantaTestRunStatus, executedAt: z.string(), fileType: vantaTestFileType, file: z.object({mimeType: z.string(), url: z.string()})}); export const vantaTestSnapshotEvidence = z.object({snapshotId: z.string(), testId: z.string(), testRunId: z.string(), testRunTitle: z.string(), testRunStatus: z.enum(["NA", "IN_PROGRESS", "FAIL", "PASS", "INVALID", "DISABLED"]), testRunExecutedAt: z.string()}); export const informationRequestEvidenceUnion = z.union([uploadedDocumentEvidence, linkEvidence, observationEvidence, vantaDocumentEvidence, vantaPolicyEvidence, vantaTestEvidence, vantaTestSnapshotEvidence]); export const informationRequestEvidence = z.object({id: z.string(), evidenceType: informationRequestSupportedEvidenceType, visibleToAuditorDate: z.string().nullable().optional(), creationDate: z.string(), modificationDate: z.string(), deletionDate: z.string().nullable().optional(), evidence: informationRequestEvidenceUnion}); export const pageInfo = z.object({endCursor: z.string().nullable(), hasNextPage: z.boolean(), hasPreviousPage: z.boolean(), startCursor: z.string().nullable()}); export const paginatedResponseInformationRequestEvidence = z.object({results: z.object({data: z.array(informationRequestEvidence), 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 evidence for an information request * * GET /audits/{auditId}/information-requests/{requestId}/evidence */ export const getApiAuditsAuditIdInformationRequestsRequestIdEvidence = async (args: GetApiAuditsAuditIdInformationRequestsRequestIdEvidenceArgs, options?: GetApiAuditsAuditIdInformationRequestsRequestIdEvidenceOptions) => { 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)) if (args.changedSinceDate != null) query.append("changedSinceDate", String(args.changedSinceDate)) for (const item of args.evidenceTypeMatchesAny ?? []) query.append("evidenceTypeMatchesAny", String(item)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/audits/${encodeURIComponent(String(args.auditId))}/information-requests/${encodeURIComponent(String(args.requestId))}/evidence${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(paginatedResponseInformationRequestEvidence, await res.json()) };