import {z} from 'zod' export type GetApiAffordabilityReportIdArgs = {reportId: string}; export type GetApiAffordabilityReportIdOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const affordability = z.object({createdAt: z.string(), id: z.string(), income: z.object({amountConsistency: z.number(), longevity: z.object({consecutiveIncomeMonths: z.number().optional(), incomePeriodLengthMonths: z.number().optional()}), predicted: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), regularIncomeDetected: z.boolean()}).optional(), overdraftUseByAccount: z.array(z.object({id: z.string(), daysInOverdraft: z.number(), daysInUnarrangedOverdraft: z.number().optional(), earliestBalanceDate: z.string(), details: z.array(z.object({days: z.number(), start: z.string(), end: z.string(), minimumBalance: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), unarrangedOverdraft: z.object({days: z.number(), details: z.array(z.object({days: z.number(), start: z.string(), end: z.string(), minimumBalance: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()})}))}).optional()})).optional()})).optional(), overview: z.object({discretionaryExpenses: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), fixedExpenses: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), flexibleExpenses: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), income: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), incomeIncludingTransfers: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), nonDiscretionaryExpenses: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()})}).optional(), primaryIncomeAccountId: z.string().optional(), riskIndicators: z.object({cashWithdrawals: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), gambling: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), loansOpened: z.object({byPeriod: z.object({"30days": z.object({byType: z.object({bnpl: z.number().optional(), hcstc: z.number().optional(), "dca/dmp": z.number().optional(), secured: z.number().optional(), unknown: z.number().optional(), unsecured: z.number().optional()}).optional(), totalByType: z.object({bnpl: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), hcstc: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), "dca/dmp": z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), secured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unknown: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unsecured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional()}).optional()}).optional(), "90days": z.object({byType: z.object({bnpl: z.number().optional(), hcstc: z.number().optional(), "dca/dmp": z.number().optional(), secured: z.number().optional(), unknown: z.number().optional(), unsecured: z.number().optional()}).optional(), totalByType: z.object({bnpl: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), hcstc: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), "dca/dmp": z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), secured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unknown: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unsecured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional()}).optional()}).optional(), "180days": z.object({byType: z.object({bnpl: z.number().optional(), hcstc: z.number().optional(), "dca/dmp": z.number().optional(), secured: z.number().optional(), unknown: z.number().optional(), unsecured: z.number().optional()}).optional(), totalByType: z.object({bnpl: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), hcstc: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), "dca/dmp": z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), secured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unknown: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unsecured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional()}).optional()}).optional(), "365days": z.object({byType: z.object({bnpl: z.number().optional(), hcstc: z.number().optional(), "dca/dmp": z.number().optional(), secured: z.number().optional(), unknown: z.number().optional(), unsecured: z.number().optional()}).optional(), totalByType: z.object({bnpl: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), hcstc: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), "dca/dmp": z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), secured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unknown: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional(), unsecured: z.object({borrowed: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional(), repaid: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}).optional()}).optional()}).optional()}).optional()}).optional()}).optional(), loanRepayments: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), outgoingTransfers: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()}), returnedDirectDebits: z.object({count: z.number().optional(), details: z.array(z.object({category: z.string(), count: z.number(), period: z.object({unit: z.literal("days"), value: z.number()}), total: z.object({returned: z.object({value: z.number().int(), majorUnits: z.number().int().optional(), minorUnits: z.number().int().optional(), currency: z.string()})})})).optional(), periodMonths: z.number().optional()})}).optional()}); export const links = z.object({next: z.string().optional(), prev: z.string().optional(), self: z.string()}); export const getApiAffordabilityReportIdResponse = z.object({data: affordability.optional(), links: links.optional(), meta: z.object({}).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 an existing affordability calculation for a user * * GET /affordability/{reportId} */ export const getApiAffordabilityReportId = async (args: GetApiAffordabilityReportIdArgs, options?: GetApiAffordabilityReportIdOptions) => { const {baseUrl = "https://api.moneyhub.co.uk/v2.0", fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (Bearer !== undefined) headers.set("Authorization", Bearer) const url = `${baseUrl.replace(/\/+$/, '')}/affordability/${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(getApiAffordabilityReportIdResponse, await res.json()) };