import {z} from 'zod' export type GetApiApi3ReportsIdArgs = {id: number}; export type GetApiApi3ReportsIdOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const reportEmailSmtp = z.object({global: z.boolean().optional(), relay: z.string().optional(), sender: z.string().optional()}); export const reportEmail = z.object({access: z.enum(["file", "zip", "url", "none"]).optional(), additional: z.enum(["file", "zip", "none"]).optional(), additionalRecipients: z.array(z.string()).optional(), assetAccess: z.boolean().optional(), owner: z.enum(["file", "url", "zip", "none"]).optional(), smtp: reportEmailSmtp.optional()}); export const link = z.object({deprecation: z.string().optional(), href: z.string().optional(), hreflang: z.string().optional(), media: z.string().optional(), rel: z.string().optional(), title: z.string().optional(), type: z.string().optional()}); export const reportConfigCategoryFilters = z.object({excluded: z.array(z.string()).optional(), included: z.array(z.string()).optional(), links: z.array(link)}); export const reportConfigFiltersResource = z.object({categories: reportConfigCategoryFilters.optional(), severity: z.enum(["all", "critical", "critical-and-severe"]).optional(), statuses: z.array(z.enum(["vulnerable", "vulnerable-version", "potentially-vulnerable", "vulnerable-and-validated"])).optional()}); export const reportRepeat = z.object({dayOfWeek: z.enum(["sunday", "monday", "tuesday", "wednesday", "thursday", "friday", "saturday"]).optional(), every: z.enum(["hour", "day", "week", "date-of-month", "day-of-month"]), interval: z.number().int().gte(1), weekOfMonth: z.number().int().gte(1).lte(6).optional()}); export const reportFrequencyResource = z.enum(["scan", "schedule", "none"]); export const reportFrequency = z.object({nextRuntimes: z.array(z.string()).optional(), repeat: reportRepeat.optional(), start: z.string().optional(), type: reportFrequencyResource.optional()}); export const rangeIntervalResource = z.enum(["day", "month", "year"]); export const rangeResource = z.object({every: rangeIntervalResource.optional(), from: z.object({}).optional(), interval: z.number().int().optional(), to: z.string().optional()}); export const remediationSortResource = z.enum(["assets", "vulnerabilities", "malware_kits", "exploits", "riskscore"]); export const remediationResource = z.object({solutions: z.number().int().gte(1).optional(), sort: remediationSortResource.optional()}); export const allAssetsTrendOptionResource = z.enum(["average-risk", "number-of-assets", "none"]); export const riskTrendAllAssetsResource = z.object({total: z.boolean().optional(), trend: allAssetsTrendOptionResource.optional()}); export const assetCollectionRiskTrendMembershipOptionResource = z.enum(["historical", "generation"]); export const assetCollectionRiskTrendOptionResource = z.enum(["average", "total"]); export const riskTrendResource = z.object({allAssets: riskTrendAllAssetsResource.optional(), assetGroupMembership: assetCollectionRiskTrendMembershipOptionResource.optional(), assetGroups: assetCollectionRiskTrendOptionResource.optional(), assets: z.boolean().optional(), from: z.object({}).optional(), sites: assetCollectionRiskTrendOptionResource.optional(), tagMembership: assetCollectionRiskTrendMembershipOptionResource.optional(), tags: assetCollectionRiskTrendOptionResource.optional(), to: z.string().optional()}); export const reportConfigScopeResource = z.object({assetGroups: z.array(z.number().int()).optional(), assets: z.array(z.number().int()).optional(), scan: z.object({}).optional(), sites: z.array(z.number().int()).optional(), tags: z.array(z.number().int()).optional()}); export const reportStorage = z.object({location: z.string().optional(), path: z.string().optional()}); export const report = z.object({baseline: z.object({}).optional(), bureau: z.string().optional(), component: z.string().optional(), email: reportEmail.optional(), enclave: z.string().optional(), filters: reportConfigFiltersResource.optional(), format: z.enum(["sql-query", "arf-xml", "csv-export", "cyberscope-xml", "nexpose-simple-xml", "oval-xml", "qualys-xml", "scap-xml", "xccdf-csv", "xccdf-xml", "xml-export", "xml-export-v2", "pdf", "rtf", "xml", "html", "text"]).optional(), frequency: reportFrequency.optional(), id: z.number().int().optional(), language: z.string().optional(), links: z.array(link).optional(), name: z.string().optional(), organization: z.string().optional(), owner: z.number().int().optional(), policies: z.array(z.object({})).optional(), policy: z.object({}).optional(), query: z.string().optional(), range: rangeResource.optional(), remediation: remediationResource.optional(), riskTrend: riskTrendResource.optional(), scope: reportConfigScopeResource.optional(), storage: reportStorage.optional(), template: z.string().optional(), timezone: z.string().optional(), users: z.array(z.number().int()).optional(), version: z.string().optional()}); 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 }; /** * Report * * GET /api/3/reports/{id} */ export const getApiApi3ReportsId = async (args: GetApiApi3ReportsIdArgs, options?: GetApiApi3ReportsIdOptions) => { const {baseUrl = "https://:", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json;charset=UTF-8") const url = `${baseUrl.replace(/\/+$/, '')}/api/3/reports/${encodeURIComponent(String(args.id))}${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(report, await res.json()) };