import {z} from 'zod' export type GetApiNotesArgs = {pageSize?: number | undefined, sortOrder?: ('asc' | 'desc') | undefined, pageCursor?: string | undefined, sortField?: 'created_at' | undefined, filterEntityId?: number | undefined, filterEntityName: 'JOB' | 'CUSTOMER' | 'CUSTOMER_INVOICE' | 'QUOTE' | 'SITE' | 'TASK' | 'ENQUIRY' | 'JOB_PHASE', filterCreatedById?: number | undefined}; export type GetApiNotesOptions = {baseUrl?: string | undefined, oauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const links = z.object({href: z.string(), rel: z.string(), type: z.enum(["GET", "POST", "PUT", "PATCH"])}); export const noteReply = z.object({id: z.number(), companyId: z.number(), entityId: z.number(), entityName: z.enum(["JOB", "CUSTOMER", "CUSTOMER_INVOICE", "QUOTE", "SITE", "TASK", "ENQUIRY", "JOB_PHASE"]), text: z.string(), createdById: z.number(), createdAt: z.string(), isPinned: z.boolean(), parentId: z.number().nullable(), links: z.array(links)}); export const note = z.object({id: z.number(), companyId: z.number(), entityId: z.number(), entityName: z.enum(["JOB", "CUSTOMER", "CUSTOMER_INVOICE", "QUOTE", "SITE", "TASK", "ENQUIRY", "JOB_PHASE"]), text: z.string(), createdById: z.number(), createdAt: z.string(), isPinned: z.boolean(), parentId: z.number().nullable(), links: z.array(links), replies: z.array(noteReply).optional()}); export const pagination = z.object({perPage: z.number(), pageCount: z.number(), links: z.object({self: z.string(), previous: z.string().nullable(), next: z.string().nullable()})}); export const getNotesResponse = z.object({result: z.string(), data: z.array(note), paging: pagination.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 }; /** * Schema for Notes * * GET /notes * * Also accepts auth: PersonalAccessToken */ export const getApiNotes = async (args: GetApiNotesArgs, options?: GetApiNotesOptions) => { const {baseUrl = "https://api.fergus.com", fetch: fetchFn = fetch, oauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) if (args.pageCursor != null) query.append("pageCursor", String(args.pageCursor)) if (args.sortField != null) query.append("sortField", String(args.sortField)) if (args.filterEntityId != null) query.append("filterEntityId", String(args.filterEntityId)) if (args.filterEntityName != null) query.append("filterEntityName", String(args.filterEntityName)) if (args.filterCreatedById != null) query.append("filterCreatedById", String(args.filterCreatedById)) if (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/notes${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(getNotesResponse, await res.json()) };