import {z} from 'zod' export type PageSize = number; export type PageCursor = string; export type GetApiAuditsAuditIdControlsControlIdCommentsArgs = {auditId: string, controlId: string, pageSize?: PageSize | undefined, pageCursor?: PageCursor | undefined, changedSinceDate?: string | undefined}; export type GetApiAuditsAuditIdControlsControlIdCommentsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const auditControlComment = z.object({id: z.string(), text: z.string(), creationDate: z.string(), modificationDate: z.string().nullable(), deletionDate: z.string().nullable(), email: z.string().nullable(), authorName: z.string().nullable()}); export const pageInfo = z.object({endCursor: z.string().nullable(), hasNextPage: z.boolean(), hasPreviousPage: z.boolean(), startCursor: z.string().nullable()}); export const paginatedResponseAuditControlComment = z.object({results: z.object({data: z.array(auditControlComment), 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 comments for a control within an audit * * GET /audits/{auditId}/controls/{controlId}/comments */ export const getApiAuditsAuditIdControlsControlIdComments = async (args: GetApiAuditsAuditIdControlsControlIdCommentsArgs, options?: GetApiAuditsAuditIdControlsControlIdCommentsOptions) => { 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)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/audits/${encodeURIComponent(String(args.auditId))}/controls/${encodeURIComponent(String(args.controlId))}/comments${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(paginatedResponseAuditControlComment, await res.json()) };