import {z} from 'zod' export type GetApiRisksVendorsDiffsArgs = {start_date: string, end_date?: string | undefined, page_token?: string | undefined, page_size?: number | undefined}; export type GetApiRisksVendorsDiffsOptions = {baseUrl?: string | undefined, APIKeyInHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const scanResult = z.object({date: z.string().optional(), metaValue: z.string().optional(), status: z.enum(["PASS", "FAIL", "UNKNOWN", "WAIVED"]).optional()}); export const scanDiff = z.object({expected: z.string().optional(), hostname: z.string().optional(), property: z.string().optional(), scanA: scanResult.optional(), scanB: scanResult.optional()}); export const diffStatus = z.string(); export const vendorDiff = z.object({expected: z.string().optional(), metaValueA: z.string().optional(), metaValueB: z.string().optional(), prevProvisionalID: z.string().optional(), statusA: diffStatus.optional(), statusB: diffStatus.optional()}); export const riskDiff = z.object({category: z.enum(["website_sec", "email_sec", "network_sec", "ip_domain_reputation", "brand_protect", "attack_surface", "dns", "vulnerability_management", "data_leakage", "encryption", "questionnaire_risks", "vulns", "typosquatting", "emailexposures", "dataleaks", "additional_evidence"]).optional(), description: z.string().optional(), group: z.string().optional(), id: z.string().optional(), name: z.string().optional(), remediation: z.string().optional(), riskDetails: z.string().optional(), riskSubtype: z.string().optional(), riskType: z.string().optional(), scanDiffs: z.array(scanDiff).optional(), severity: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5)]).optional(), severityName: z.enum(["pass", "info", "low", "medium", "high", "critical"]).optional(), vendorDiff: vendorDiff.optional()}); export const riskDiffGroup = z.object({groupID: z.string().optional(), highestSeverity: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3), z.literal(4), z.literal(5)]).optional(), highestSeverityName: z.enum(["pass", "info", "low", "medium", "high", "critical"]).optional(), name: z.string().optional(), risks: z.array(riskDiff).optional()}); export const vendorsRiskDiffs = z.object({id: z.number().int().optional(), name: z.string().optional(), primary_hostname: z.string().optional(), risksIntroduced: z.array(riskDiffGroup).optional(), risksResolved: z.array(riskDiffGroup).optional()}); export const vendorsRisksDiffResponsePayloadBody = z.object({next_page_token: z.string().optional(), total_results: z.number().int().optional(), vendors: z.array(vendorsRiskDiffs).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 }; /** * Get a list of risk changes for monitored vendors * * GET /risks/vendors/diffs */ export const getApiRisksVendorsDiffs = async (args: GetApiRisksVendorsDiffsArgs, options?: GetApiRisksVendorsDiffsOptions) => { const {baseUrl = "https://cyber-risk.upguard.com/api/public", fetch: fetchFn = fetch, APIKeyInHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.page_token != null) query.append("page_token", String(args.page_token)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (APIKeyInHeader !== undefined) headers.set("Authorization", APIKeyInHeader) const url = `${baseUrl.replace(/\/+$/, '')}/risks/vendors/diffs${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(vendorsRisksDiffResponsePayloadBody, await res.json()) };