import {z} from 'zod' export type GetApiCustomerInvoicesInvoiceIdArgs = {invoiceId: number}; export type GetApiCustomerInvoicesInvoiceIdOptions = {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 invoiceSection: z.ZodType = z.object({sectionId: z.number(), name: z.string().nullable(), sortOrder: z.number().nullable(), parentSectionId: z.number().nullable(), description: z.string().nullable(), lineItems: z.array(z.object({priceBookLineItemId: z.number().nullable(), itemName: z.string().nullable(), itemQuantity: z.number().nullable(), unitOfMeasureSell: z.union([z.literal("each"), z.literal("hour"), z.literal("day"), z.literal("kilogram"), z.literal("tonne"), z.literal("litre"), z.literal("bag"), z.literal("sheet"), z.literal("length"), z.literal("box"), z.literal("millimetre"), z.literal("centimetre"), z.literal("metre"), z.literal("square_metre"), z.literal("cubic_metre")]).nullable(), itemPrice: z.number().nullable(), salesAccountId: z.number().nullable(), isLabour: z.boolean().nullable(), sortOrder: z.number().nullable(), discountRate: z.number().nullable(), isCombined: z.boolean().nullable(), combinedItemId: z.number().nullable(), customerInvoiceLineItemId: z.number(), itemDescription: z.string().nullable(), isCardPaymentFee: z.boolean().nullable()})).optional(), sections: z.array(z.lazy(() => invoiceSection)).optional()}); export const detailedCustomerInvoice = z.object({id: z.number(), jobId: z.number(), customerId: z.number(), attn: z.string().nullable(), title: z.string(), description: z.string().nullable(), invoiceNumber: z.string().nullable(), receiverEmail: z.string().nullable(), receiverFullName: z.string().nullable(), receiverPostalAddress: z.string().nullable(), dueDate: z.string().nullable(), dueDays: z.union([z.number(), z.string()]).nullable(), invoiceDate: z.string().nullable(), paidAt: z.string().nullable(), subtotal: z.number(), taxValue: z.number(), totalPaid: z.number().nullable(), taxRate: z.number(), type: z.union([z.literal("approved"), z.literal("toBeApproved"), z.literal("draft")]), status: z.union([z.literal("unpaid"), z.literal("draft"), z.literal("voided"), z.literal("paidDisputed"), z.literal("unpaidDisputed"), z.literal("paid")]), isSent: z.boolean(), isFinal: z.boolean(), createdAt: z.string(), fergusPayEnabled: z.boolean(), directDebitStatus: z.union([z.literal("processing"), z.literal("succeeded"), z.literal("failed")]).nullable(), links: z.array(links), customer: z.object({id: z.number(), customerFullName: z.string(), links: z.array(links)}), sections: z.array(z.object({sectionId: z.number(), name: z.string().nullable(), sortOrder: z.number().nullable(), parentSectionId: z.number().nullable(), description: z.string().nullable(), lineItems: z.array(z.object({priceBookLineItemId: z.number().nullable(), itemName: z.string().nullable(), itemQuantity: z.number().nullable(), unitOfMeasureSell: z.union([z.literal("each"), z.literal("hour"), z.literal("day"), z.literal("kilogram"), z.literal("tonne"), z.literal("litre"), z.literal("bag"), z.literal("sheet"), z.literal("length"), z.literal("box"), z.literal("millimetre"), z.literal("centimetre"), z.literal("metre"), z.literal("square_metre"), z.literal("cubic_metre")]).nullable(), itemPrice: z.number().nullable(), salesAccountId: z.number().nullable(), isLabour: z.boolean().nullable(), sortOrder: z.number().nullable(), discountRate: z.number().nullable(), isCombined: z.boolean().nullable(), combinedItemId: z.number().nullable(), customerInvoiceLineItemId: z.number(), itemDescription: z.string().nullable(), isCardPaymentFee: z.boolean().nullable()})).optional(), sections: z.array(invoiceSection).optional()}))}); export const getCustomerInvoiceByIdResponse = z.object({result: z.string(), data: detailedCustomerInvoice}); 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 }; /** * Returns a single invoice by ID with customer details and sections * * GET /customerInvoices/{invoiceId} * * Also accepts auth: PersonalAccessToken */ export const getApiCustomerInvoicesInvoiceId = async (args: GetApiCustomerInvoicesInvoiceIdArgs, options?: GetApiCustomerInvoicesInvoiceIdOptions) => { 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 (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/customerInvoices/${encodeURIComponent(String(args.invoiceId))}${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(getCustomerInvoiceByIdResponse, await res.json()) };