import {z} from 'zod' export type GetApiApiV2CompaniesIdFindingsWebrankingArgs = {id: number, page_number?: number | undefined, page_size?: (10 | 20 | 30 | 50 | 100 | 250) | undefined}; export type GetApiApiV2CompaniesIdFindingsWebrankingOptions = {baseUrl?: string | undefined, OAuthv2?: string | undefined, fetch?: typeof fetch | undefined}; export const findingDomain = z.string(); export const findingControlId = z.string(); export const rankingAndTrend = z.object({Rank: z.number().nullable().optional(), TrendImageUrl: z.string().nullable().optional(), ControlId: findingControlId.optional()}); export const findingSeverity = z.enum(["Info", "Low", "Medium", "High", "Critical"]); export const webRankingFinding = z.object({Domain: findingDomain.optional(), Rankings: z.object({AlexaRankingAndTrend: rankingAndTrend.optional(), CiscoRankingAndTrend: rankingAndTrend.optional(), MajesticRankingAndTrend: rankingAndTrend.optional(), WebRankCountryImage: z.string().optional()}).optional(), "GooglePageSpeedInsightsPerformanceFindings ": z.object({ControlId: findingControlId.optional(), Severity: findingSeverity.optional(), DesktopSpeedGrade: z.enum(["Bad", "Poor", "Average", "Good", "Excellent", "Not Applicable"]).optional(), MobileSpeedGrade: z.enum(["Bad", "Poor", "Average", "Good", "Excellent", "Not Applicable"]).optional(), MobileUsabilityGrade: z.enum(["Bad", "Poor", "Average", "Good", "Excellent", "Not Applicable"]).optional(), Findings: z.array(z.object({Status: z.enum(["Passed", "Failed"]).optional(), Name: z.string().optional(), Category: z.enum(["Mobile Speed", "Desktop Speed"]).optional(), Description: z.string().optional(), References: z.array(z.string()).optional()})).nullable().optional()}).nullable().optional(), WCAGParsingParsingComplianceFindings: z.array(z.object({ControlId: findingControlId.optional(), Severity: findingSeverity.optional(), Title: z.string().optional(), Location: z.string().optional(), Code: z.string().optional()})).nullable().optional()}); export const getApiApiV2CompaniesIdFindingsWebrankingResponse = z.array(webRankingFinding); 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 web ranking findings of a company. * * GET /api/v2/companies/{id}/findings/webranking */ export const getApiApiV2CompaniesIdFindingsWebranking = async (args: GetApiApiV2CompaniesIdFindingsWebrankingArgs, options?: GetApiApiV2CompaniesIdFindingsWebrankingOptions) => { 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 (OAuthv2 !== undefined) headers.set('authorization', `Bearer ${OAuthv2}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/companies/${encodeURIComponent(String(args.id))}/findings/webranking${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(getApiApiV2CompaniesIdFindingsWebrankingResponse, await res.json()) };