import {z} from 'zod' export type GetApiApiV2CompaniesIdFindingsPatchmanagementArgs = {id: number, page_number?: number | undefined, page_size?: (10 | 20 | 30 | 50 | 100 | 250) | undefined, status?: string | undefined, severity?: string | undefined, asset?: string | undefined, output?: 'Failed' | undefined, exclude_fields?: string | undefined, start_date?: string | undefined, end_date?: string | undefined, confidence_level?: ('VeryHigh' | 'High' | 'Medium' | 'Low') | undefined, is_rsi_finding?: boolean | undefined}; export type GetApiApiV2CompaniesIdFindingsPatchmanagementOptions = {baseUrl?: string | undefined, OAuthv2?: string | undefined, fetch?: typeof fetch | undefined}; export const findingId = z.number().int(); export const findingDomain = z.string(); export const findingIPAddress = z.string(); export const findingSubDomain = z.string().nullable(); export const findingSeverity = z.enum(["Info", "Low", "Medium", "High", "Critical"]); export const findingStatus = z.enum(["Active", "FalsePositive", "Suppressed", "Acknowledged", "Deleted", "Remediated"]); export const findingDate = z.string(); export const lastCheckDate = z.string(); export const findingControlId = z.string(); export const findingCvssScore = z.number().gte(0).lte(10).nullable(); export const findingCwssScore = z.number().gte(0).lte(10).nullable(); export const ticketStatus = z.enum(["Unassigned", "Assigned", "In Progress", "Closed–Acknowledged", "Closed–Remediated", "Closed–False Positive", "On Hold", "Recheck", "Deleted"]); export const findingTicketSummary = z.object({TicketId: z.number().nullable().optional(), Status: ticketStatus.optional(), Owner: z.string().nullable().optional()}); export const findingCveId = z.string().nullable(); export const findingCweId = z.string().nullable(); export const findingDetail = z.string().max(5000); export const findingTitle = z.string(); export const cpes = z.array(z.string()); export const port = z.number().nullable(); export const tagOfFinding = z.object({Id: z.number().int().optional(), Name: z.string().optional()}); export const findingConfidenceLevel = z.enum(["Low", "Medium", "High", "VeryHigh"]).nullable(); export const updateDate = z.string().nullable(); export const findingIsRsi = z.boolean(); export const patchManagementFinding = z.object({FindingId: findingId.optional(), Domain: findingDomain.optional(), IPAddress: findingIPAddress.optional(), Subdomain: findingSubDomain.optional(), Severity: findingSeverity.optional(), Status: findingStatus.optional(), ProductName: z.string().optional(), PublishDate: z.string().nullable().optional(), FindingDate: findingDate.optional(), LastCheckDate: lastCheckDate.optional(), ControlId: findingControlId.optional(), CvssScore: findingCvssScore.optional(), CwssScore: findingCwssScore.optional(), Ticket: findingTicketSummary.optional(), CveId: findingCveId.optional(), CweId: findingCweId.optional(), Detail: findingDetail.optional(), Title: findingTitle.optional(), References: z.array(z.string()).nullable().optional(), Cpes: cpes.optional(), Port: port.optional(), Epss: z.number().gte(0).lte(100).nullable().optional(), InKev: z.boolean().nullable().optional(), Tags: z.array(tagOfFinding).optional(), Output: z.literal("Failed").optional(), ConfidenceLevel: findingConfidenceLevel.optional(), UpdateDate: updateDate.optional(), IsRsiFinding: findingIsRsi.optional()}); export const getApiApiV2CompaniesIdFindingsPatchmanagementResponse = z.array(patchManagementFinding); 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 all the patch management findings found for a company. * * GET /api/v2/companies/{id}/findings/patchmanagement */ export const getApiApiV2CompaniesIdFindingsPatchmanagement = async (args: GetApiApiV2CompaniesIdFindingsPatchmanagementArgs, options?: GetApiApiV2CompaniesIdFindingsPatchmanagementOptions) => { const {baseUrl = "https://app.blackkitetech.com", fetch: fetchFn = fetch, OAuthv2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page_number != null) query.append("page_number", String(args.page_number)) if (args.page_size != null) query.append("page_size", String(args.page_size)) if (args.status != null) query.append("status", String(args.status)) if (args.severity != null) query.append("severity", String(args.severity)) if (args.asset != null) query.append("asset", String(args.asset)) if (args.output != null) query.append("output", String(args.output)) if (args.exclude_fields != null) query.append("exclude_fields", String(args.exclude_fields)) 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.confidence_level != null) query.append("confidence_level", String(args.confidence_level)) if (args.is_rsi_finding != null) query.append("is_rsi_finding", String(args.is_rsi_finding)) if (OAuthv2 !== undefined) headers.set('authorization', `Bearer ${OAuthv2}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/companies/${encodeURIComponent(String(args.id))}/findings/patchmanagement${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(getApiApiV2CompaniesIdFindingsPatchmanagementResponse, await res.json()) };