import {z} from 'zod' export type GetApiReturnsArgs = {limit?: number | undefined, starting_after?: string | undefined, sort_order?: ('asc' | 'desc') | undefined, connected_account_id?: string | undefined, type?: ('sepa' | 'sepa_instant') | undefined, return_type?: ('return' | 'refund' | 'reversal') | undefined, status?: ('pending' | 'sent' | 'processing' | 'executed' | 'received' | 'rejected') | undefined, related_payment_id?: string | undefined, related_payment_type?: string | undefined, start_date?: string | undefined, end_date?: string | undefined, start_value_date?: string | undefined, end_value_date?: string | undefined, direction?: ('credit' | 'debit') | undefined, reconciliation_status?: ('reconciled' | 'partially_reconciled' | 'unreconciled' | 'excluded') | undefined, file_id?: string | undefined, aggregation_reference?: string | undefined, 'validation.type'?: ('internal_account_is_active' | 'direct_debit_mandate_is_active' | 'liquidity_screening' | 'sanctions_screening' | 'risk_screening' | 'limits_screening' | 'mambu_authorization') | undefined, 'validation.status'?: ('queued' | 'in_progress' | 'successful' | 'failed' | 'pending_investigation' | 'pending_retry' | 'canceled' | 'technical_error') | undefined}; export type GetApiReturnsOptions = {baseUrl?: string | undefined, sec0?: string | undefined, fetch?: typeof fetch | undefined}; export const commonAddress = z.object({line_1: z.string().optional(), line_2: z.string().optional(), building_number: z.string().optional(), street_name: z.string().optional(), postal_code: z.string().optional(), region_state: z.string().optional(), city: z.string().optional(), country: z.string().optional(), department: z.string().nullable().optional(), sub_department: z.string().nullable().optional(), building_name: z.string().nullable().optional(), floor: z.string().nullable().optional(), postal_box: z.string().nullable().optional(), room: z.string().nullable().optional(), city_location_name: z.string().nullable().optional(), district_name: z.string().nullable().optional()}); export const returnDetails = z.object({id: z.string(), object: z.literal("return"), type: z.enum(["sepa", "sepa_instant"]), direction: z.enum(["credit", "debit"]), return_type: z.enum(["return", "refund", "reversal"]), connected_account_id: z.string(), related_payment_id: z.string(), related_payment_type: z.enum(["payment_order", "incoming_payment"]), return_reason: z.string(), status: z.enum(["received", "pending-approval", "approved", "canceled", "failed", "processing", "sent", "executed", "rejected"]), status_details: z.string(), metadata: z.object({}), bank_data: z.object({file_id: z.string(), message_id: z.string(), transaction_id: z.string(), end_to_end_id: z.string(), file_reference: z.string().optional()}), value_date: z.string(), returned_amount: z.number().int(), currency: z.literal("EUR"), receiving_account_number: z.string(), originating_account_number: z.string().optional(), originating_account_holder_name: z.string().optional(), originating_account_bank_name: z.string().nullable().optional(), originating_account_bank_address: commonAddress.nullable().optional(), receiving_account_bank_name: z.string().nullable().optional(), receiving_account_bank_address: commonAddress.nullable().optional(), reconciliation_status: z.enum(["unreconciled", "partially_reconciled", "reconciled", "excluded"]), reconciled_amount: z.number().int(), created_at: z.string()}); export const returnSearchResult = z.object({records: z.array(returnDetails)}); 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 returns * * GET /returns */ export const getApiReturns = async (args: GetApiReturnsArgs, options?: GetApiReturnsOptions) => { const {baseUrl = "https://sandbox.numeral.io/v1", fetch: fetchFn = fetch, sec0} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.limit != null) query.append("limit", String(args.limit)) if (args.starting_after != null) query.append("starting_after", String(args.starting_after)) if (args.sort_order != null) query.append("sort_order", String(args.sort_order)) if (args.connected_account_id != null) query.append("connected_account_id", String(args.connected_account_id)) if (args.type != null) query.append("type", String(args.type)) if (args.return_type != null) query.append("return_type", String(args.return_type)) if (args.status != null) query.append("status", String(args.status)) if (args.related_payment_id != null) query.append("related_payment_id", String(args.related_payment_id)) if (args.related_payment_type != null) query.append("related_payment_type", String(args.related_payment_type)) if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.start_value_date != null) query.append("start_value_date", String(args.start_value_date)) if (args.end_value_date != null) query.append("end_value_date", String(args.end_value_date)) if (args.direction != null) query.append("direction", String(args.direction)) if (args.reconciliation_status != null) query.append("reconciliation_status", String(args.reconciliation_status)) if (args.file_id != null) query.append("file_id", String(args.file_id)) if (args.aggregation_reference != null) query.append("aggregation_reference", String(args.aggregation_reference)) if (args['validation.type'] != null) query.append("validation.type", String(args['validation.type'])) if (args['validation.status'] != null) query.append("validation.status", String(args['validation.status'])) if (sec0 !== undefined) headers.set("x-api-key", sec0) const url = `${baseUrl.replace(/\/+$/, '')}/returns${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(returnSearchResult, await res.json()) };