import {z} from 'zod' export type GetApiApiV2CompaniesIdAssessmentsAssessmentIdArgs = {id: number, assessmentId: number}; export type GetApiApiV2CompaniesIdAssessmentsAssessmentIdOptions = {baseUrl?: string | undefined, OAuthv2?: string | undefined, fetch?: typeof fetch | undefined}; export const getAssessmentDetailsResponse = z.object({Id: z.number().int(), Name: z.string(), Description: z.string().optional(), Summary: z.string().optional(), Status: z.enum(["Analyzing", "InvitationSent", "InvitationEnqueued", "WaitingOnVendor", "ReadyToReview", "InReview", "Completed"]), OnlyApiEditable: z.boolean(), Frameworks: z.array(z.object({FrameworkName: z.string().optional(), FrameworkFullName: z.string().optional(), Ratings: z.object({FullyCompliant: z.number().int().optional(), PartiallyCompliant: z.number().int().optional(), Failed: z.number().int().optional(), InsufficientEvidence: z.number().int().nullable().optional(), NoEvidence: z.number().int().optional(), NotApplicable: z.number().int().optional()}).optional()})).optional(), Documents: z.array(z.object({Id: z.number().int().optional(), FileName: z.string().optional(), Type: z.string().optional(), Date: z.string().optional(), DateSource: z.string().optional(), UploadDate: z.string().optional(), UploadedBy: z.string().optional(), Status: z.enum(["Waiting", "InProgress", "Completed", "ParseError"]).optional()})).optional(), SnapshotRatings: z.object({CyberRating: z.object({Grade: z.number().gte(0).lte(100).optional(), GradeLetter: z.enum(["A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F", "n/a"]).optional()}).optional(), CyberRatings: z.array(z.object({Module: z.string().optional(), Grade: z.number().gte(0).lte(100).optional(), GradeLetter: z.enum(["A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F", "n/a"]).optional()})).optional(), FairRatings: z.array(z.object({RiskType: z.enum(["Data Breach", "Ransomware", "Business Interruption"]).optional(), AnnualLossExposureAvg: z.number().optional()})).optional(), RsiDbiRatings: z.object({RansomwareIndex: z.number().gte(0).lte(1).optional(), RansomwareIndexIndustryAverage: z.number().gte(0).lte(1).optional(), BreachIndex: z.number().gte(0).lte(1).optional(), BreachIndexIndustryAverage: z.number().gte(0).lte(1).optional()}).optional(), RsiTrend: z.array(z.object({Date: z.string().optional(), Value: z.number().gte(0).lte(1).optional()})).optional(), DbiTrend: z.array(z.object({Date: z.string().optional(), Value: z.number().gte(0).lte(1).optional()})).optional(), FocusTags: z.array(z.object({Id: z.number().int().optional(), Name: z.string().optional()})).optional(), SnapshotDate: z.string().optional()}).optional(), Activities: z.array(z.object({HistoryType: z.enum(["LaunchAssessment", "ViewAssessment", "EditNameOrDesc", "EditSummary", "EditStatus", "AddComment", "UploadedDocToAssess", "UploadedDocToAttach", "DownloadAttachment", "UpdateRatings", "DeleteAttachment", "DeleteDocToAsses", "UploadedBKReportToAttach", "AssessedDocDownloaded", "OnlyApiEditableChanged", "FairCalculationCompleted", "AssessmentSharedWithVendor", "InvitationAccepted", "SendBacktoCustomer", "SendBackToVendor", "AssessmentUnshared"]).optional(), InsertUser: z.string().nullable().optional(), InsertDate: z.string().optional(), FullName: z.string().nullable().optional(), DocumentName: z.string().nullable().optional(), Comment: z.string().nullable().optional()})).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 }; /** * Gets the details of a specific assessment for a monitored company. * * GET /api/v2/companies/{id}/assessments/{assessmentId} */ export const getApiApiV2CompaniesIdAssessmentsAssessmentId = async (args: GetApiApiV2CompaniesIdAssessmentsAssessmentIdArgs, options?: GetApiApiV2CompaniesIdAssessmentsAssessmentIdOptions) => { 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 (OAuthv2 !== undefined) headers.set('authorization', `Bearer ${OAuthv2}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/companies/${encodeURIComponent(String(args.id))}/assessments/${encodeURIComponent(String(args.assessmentId))}${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(getAssessmentDetailsResponse, await res.json()) };