import {z} from 'zod' export type GetApiApiV2CompaniesIdSummaryArgs = {id: number}; export type GetApiApiV2CompaniesIdSummaryOptions = {baseUrl?: string | undefined, OAuthv2?: string | undefined, fetch?: typeof fetch | undefined}; export const technicalCategorySummary = z.object({Description: z.string().optional(), CyberRating: z.number().gte(0).lte(100).optional(), GradeLetter: z.enum(["A", "B", "C", "D", "F"]).optional(), LastUpdatedAt: z.string().optional()}); export const technicalSummary = z.object({GradeLetter: z.enum(["A+", "A", "A-", "B+", "B", "B-", "C+", "C", "C-", "D+", "D", "D-", "F"]).optional(), CyberRating: z.number().gte(0).lte(100).optional(), CyberRatingAsString: z.enum(["Excellent", "Good", "Average", "Poor", "Bad"]).optional(), CompletedAt: z.string().optional(), LastUpdatedAt: z.string().optional(), SafeGuard: z.object({GradeLetter: z.enum(["A", "B", "C", "D", "F"]).optional(), PatchManagement: technicalCategorySummary.optional(), ApplicationSecurity: technicalCategorySummary.optional(), CDNSecurity: technicalCategorySummary.optional(), WebsiteSecurity: technicalCategorySummary.optional()}).optional(), Reputation: z.object({GradeLetter: z.enum(["A", "B", "C", "D", "F"]).optional(), BrandMonitoring: technicalCategorySummary.optional(), IPReputation: technicalCategorySummary.optional(), FraudulentApps: technicalCategorySummary.optional(), FraudulentDomains: technicalCategorySummary.optional(), WebRanking: technicalCategorySummary.optional()}).optional(), Resiliency: z.object({GradeLetter: z.enum(["A", "B", "C", "D", "F"]).optional(), AttackSurface: technicalCategorySummary.optional(), DNSHealth: technicalCategorySummary.optional(), EmailSecurity: technicalCategorySummary.optional(), DDoSResiliency: technicalCategorySummary.optional(), NetworkSecurity: technicalCategorySummary.optional()}).optional(), Privacy: z.object({GradeLetter: z.enum(["A", "B", "C", "D", "F"]).optional(), SSLStrength: technicalCategorySummary.optional(), CredentialManagement: technicalCategorySummary.optional(), HacktivistShares: technicalCategorySummary.optional(), SocialNetwork: technicalCategorySummary.optional(), InformationDisclosure: technicalCategorySummary.optional()}).optional()}); export const complianceSummary = z.array(z.object({Standard: z.string().optional(), Rating: z.number().gte(0).lte(100).optional(), Completeness: z.number().gte(0).lte(100).optional(), Confidence: z.number().gte(0).lte(100).optional(), LastUpdatedAt: z.string().optional()})); export const financialSummary = z.object({Avg: z.number().optional(), Min: z.number().optional(), Max: z.number().optional(), LossEventFrequency: z.object({Value: z.number().gte(0).lte(1).optional(), ThreatEventFrequency: z.object({Value: z.number().gte(0).optional(), ContactFrequency: z.object({Value: z.number().gte(0).optional()}).optional(), ProbabilityOfAction: z.object({Value: z.number().gte(0).optional()}).optional()}).optional(), Vulnerability: z.object({Value: z.number().gte(0).optional(), ThreatCapability: z.object({Value: z.number().gte(0).optional()}).optional(), ResistanceStrength: z.object({Value: z.number().gte(0).optional()}).optional()}).optional()}).optional(), LossMagnitude: z.object({Value: z.number().gte(0).optional(), PrimaryLoss: z.object({Value: z.number().gte(0).optional(), Exposure: z.object({AvgNumberOfRecords: z.number().gte(0).optional(), AvgNumberOfOtherRecords: z.number().gte(0).optional(), CostPerRecord: z.number().gte(0).optional(), CostPerOtherRecord: z.number().gte(0).optional(), TimeToIdentifyAndContain: z.number().gte(0).optional(), HasInternalNetworkAccess: z.boolean().optional()}).optional()}).optional(), SecondaryLoss: z.object({Value: z.number().gte(0).optional(), DetectionAndEscalation: z.number().gte(0).optional(), Notification: z.number().gte(0).optional(), PostDataBreachResponse: z.number().gte(0).optional(), LostBusiness: z.number().gte(0).optional()}).optional()}).optional()}); export const financialDataBreachSummary = z.object({RiskType: z.string().optional(), Avg: z.number().optional(), Min: z.number().optional(), Max: z.number().optional(), LossEventFrequency: z.object({Value: z.number().gte(0).lte(1).optional(), ThreatEventFrequency: z.object({Value: z.number().gte(0).optional(), ContactFrequency: z.object({Value: z.number().gte(0).optional()}).optional(), ProbabilityOfAction: z.object({Value: z.number().gte(0).optional()}).optional()}).optional(), Vulnerability: z.object({Value: z.number().gte(0).optional(), ThreatCapability: z.object({Value: z.number().gte(0).optional()}).optional(), ResistanceStrength: z.object({Value: z.number().gte(0).optional()}).optional()}).optional()}).optional(), LossMagnitude: z.object({Value: z.number().gte(0).optional(), PrimaryLoss: z.object({Value: z.number().gte(0).optional(), Exposure: z.object({AvgNumberOfRecords: z.number().gte(0).optional(), AvgNumberOfOtherRecords: z.number().gte(0).optional(), UseBlackKiteCalculation: z.boolean().optional(), CostPerRecord: z.number().gte(0).optional(), CostPerOtherRecord: z.number().gte(0).optional(), TimeToIdentifyAndContain: z.number().gte(0).optional(), HasInternalNetworkAccess: z.boolean().optional()}).optional()}).optional(), SecondaryLoss: z.object({Value: z.number().gte(0).optional(), DetectionAndEscalation: z.number().gte(0).optional(), Notification: z.number().gte(0).optional(), PostDataBreachResponse: z.number().gte(0).optional(), LostBusiness: z.number().gte(0).optional()}).optional()}).optional()}); export const financialRansomwareSummary = z.object({RiskType: z.string().optional(), Avg: z.number().optional(), Min: z.number().optional(), Max: z.number().optional(), LossEventFrequency: z.object({Value: z.number().gte(0).lte(1).optional(), ThreatEventFrequency: z.object({Value: z.number().gte(0).optional()}).optional(), Vulnerability: z.object({Value: z.number().gte(0).optional()}).optional()}).optional(), LossMagnitude: z.object({Value: z.number().gte(0).optional(), PrimaryLoss: z.object({Value: z.number().gte(0).optional(), EstimatedRansom: z.number().gte(0).optional(), InsuranceDeductible: z.number().gte(0).optional(), CostOfDowntime: z.number().gte(0).optional(), Exposure: z.object({AvgNumberOfRecords: z.number().gte(0).optional(), AvgNumberOfOtherRecords: z.number().gte(0).optional(), UseBlackKiteCalculation: z.boolean().optional(), AverageDownTimeDays: z.number().gte(0).optional(), RevenueAtRisk: z.number().gte(0).lte(999999999999).nullable().optional(), HasInternalNetworkAccess: z.boolean().optional()}).optional()}).optional(), SecondaryLoss: z.object({Value: z.number().gte(0).optional(), RegulatoryFine: z.number().gte(0).optional(), EstimatedInsuranceImpactfication: z.number().gte(0).optional(), LossOfBusiness: z.number().gte(0).optional()}).optional()}).optional()}); export const financialBusinessInterruptionSummary = z.object({RiskType: z.string().optional(), Avg: z.number().optional(), Min: z.number().optional(), Max: z.number().optional(), LossEventFrequency: z.object({Value: z.number().gte(0).lte(1).optional(), ThreatEventFrequency: z.object({Value: z.number().gte(0).optional()}).optional(), Vulnerability: z.object({Value: z.number().gte(0).optional()}).optional()}).optional(), LossMagnitude: z.object({Value: z.number().gte(0).optional(), PrimaryLoss: z.object({Value: z.number().gte(0).optional(), RecoveryCosts: z.number().gte(0).optional(), InsuranceDeductible: z.number().gte(0).optional(), CostOfDowntime: z.number().gte(0).optional(), Exposure: z.object({AvgNumberOfRecords: z.number().gte(0).optional(), AvgNumberOfOtherRecords: z.number().gte(0).optional(), UseBlackKiteCalculation: z.boolean().optional(), AverageDownTimeDays: z.number().gte(0).optional(), RevenueAtRisk: z.number().gte(0).lte(999999999999).nullable().optional(), IsSoleSource: z.boolean().optional()}).optional()}).optional(), SecondaryLoss: z.object({Value: z.number().gte(0).optional(), PenaltyPinch: z.number().gte(0).optional(), EstimatedInsuranceImpactfication: z.number().gte(0).optional(), LossOfBusiness: z.number().gte(0).optional()}).optional()}).optional()}); export const companyRiskSummary = z.object({DomainName: z.string(), TechnicalSummary: technicalSummary.optional(), ComplianceSummary: complianceSummary.optional(), FinancialSummary: financialSummary.optional(), FinancialSummaries: z.array(z.union([financialDataBreachSummary, financialRansomwareSummary, financialBusinessInterruptionSummary])).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 risk score summary of a monitored company. * * GET /api/v2/companies/{id}/summary */ export const getApiApiV2CompaniesIdSummary = async (args: GetApiApiV2CompaniesIdSummaryArgs, options?: GetApiApiV2CompaniesIdSummaryOptions) => { 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))}/summary${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(companyRiskSummary, await res.json()) };