import {z} from 'zod' export type GetApiPropertyReportsReportsReportIdArgs = {reportId: string, include?: Array<'pdf'> | undefined}; export type GetApiPropertyReportsReportsReportIdOptions = {baseUrl?: string | undefined, yourApiToken?: string | undefined, fetch?: typeof fetch | undefined}; export const report = z.object({type: z.string(), id: z.string(), attributes: z.object({title: z.string().optional(), description: z.string().optional(), state: z.string().optional(), reportUrl: z.string().optional(), imageUrl: z.string().optional(), imageSource: z.string().optional()})}); export const meta = z.record(z.string(), z.unknown()); export const link = z.union([z.string(), z.object({href: z.string(), meta: meta.optional()})]); export const includedLinks = z.object({self: link.optional(), related: link.optional()}); export const includedMedia = z.object({type: z.literal("medium"), id: z.string(), attributes: z.object({id: z.string().optional(), url: z.string().optional()}).optional(), relationships: z.object({}).optional(), links: includedLinks.optional(), meta: meta.optional()}); export const getApiPropertyReportsReportsReportIdResponse = z.object({data: report.optional(), included: z.array(includedMedia).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 single report * * GET /property-reports/reports/{reportId} */ export const getApiPropertyReportsReportsReportId = async (args: GetApiPropertyReportsReportsReportIdArgs, options?: GetApiPropertyReportsReportsReportIdOptions) => { const {baseUrl = "https://api.spectre.uk.com/v1", fetch: fetchFn = fetch, yourApiToken} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/vnd.api+json") if (args.include != null) query.append("include", args.include.join(',')) if (yourApiToken !== undefined) headers.set('authorization', `Bearer ${yourApiToken}`) const url = `${baseUrl.replace(/\/+$/, '')}/property-reports/reports/${encodeURIComponent(String(args.reportId))}${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(getApiPropertyReportsReportsReportIdResponse, await res.json()) };