import {z} from 'zod' export type CreateApiV0OrganizationsOrganizationIdPaymentsSearchArgs = {include?: (Array<'bank-account' | 'rejected-by' | 'latest-submission.created-by' | 'created-by' | 'latest-submission'>) | undefined, 'organization-id': string, body: {'search-query': string}}; export type CreateApiV0OrganizationsOrganizationIdPaymentsSearchOptions = {baseUrl?: string | undefined, apiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const createApiV0OrganizationsOrganizationIdPaymentsSearchResponse = z.object({"search-results": z.array(z.object({creditor: z.union([z.object({"account-url": z.union([z.string(), z.string()]), "creditor-type": z.literal("griffin-bank-account")}), z.object({iban: z.string().min(5).max(34).optional(), "uk-domestic-sort-code": z.string().min(6).max(6).optional(), bic: z.string().min(8).max(11).optional(), "account-number": z.string().min(8).max(8).optional(), "account-holder": z.string().min(1).optional(), "bank-id-code": z.literal("gbdsc").optional(), "bank-id": z.string().min(6).max(6).optional(), "creditor-type": z.literal("uk-domestic"), bban: z.string().min(1).max(30).optional(), "account-url": z.union([z.string(), z.string()]).optional(), "uk-domestic-account-number": z.string().min(8).max(8).optional(), "other-account-identification": z.string().min(1).max(64).optional(), "account-number-code": z.literal("bban").optional(), "other-institution-identification": z.string().min(1).max(64).optional()})]).optional(), "rejected-at": z.string().optional(), "latest-submission-url": z.string().optional(), "rejected-by-url": z.string().optional(), "payment-direction": z.enum(["inbound-payment", "outbound-payment"]), "created-by-url": z.string().optional(), "created-via": z.enum(["api", "ui"]).optional(), "created-at": z.string(), "payment-url": z.string(), "payment-reference": z.string().min(1).max(35).optional(), "payment-amount": z.object({currency: z.literal("GBP"), value: z.string()}), "payment-type": z.enum(["credit-transfer", "direct-debit"]), "ultimate-debtor": z.object({iban: z.string().min(5).max(34).optional(), "uk-domestic-sort-code": z.string().min(6).max(6).optional(), bic: z.string().min(8).max(11).optional(), "account-number": z.string().min(8).max(8).optional(), "account-holder": z.string().min(1).optional(), "bank-id-code": z.literal("gbdsc").optional(), "bank-id": z.string().min(6).max(6).optional(), bban: z.string().min(1).max(30).optional(), "account-url": z.union([z.string(), z.string()]).optional(), "uk-domestic-account-number": z.string().min(8).max(8).optional(), "other-account-identification": z.string().min(1).max(64).optional(), "account-number-code": z.literal("bban").optional(), "other-institution-identification": z.string().min(1).max(64).optional()}).optional(), "payment-admissions-url": z.string().optional(), "payment-submissions-url": z.string().optional(), debtor: z.object({iban: z.string().min(5).max(34).optional(), "uk-domestic-sort-code": z.string().min(6).max(6).optional(), bic: z.string().min(8).max(11).optional(), "account-number": z.string().min(8).max(8).optional(), "account-holder": z.string().min(1).optional(), "bank-id-code": z.literal("gbdsc").optional(), "bank-id": z.string().min(6).max(6).optional(), bban: z.string().min(1).max(30).optional(), "account-url": z.union([z.string(), z.string()]).optional(), "uk-domestic-account-number": z.string().min(8).max(8).optional(), "other-account-identification": z.string().min(1).max(64).optional(), "account-number-code": z.literal("bban").optional(), "other-institution-identification": z.string().min(1).max(64).optional()}).optional(), "rejection-reason": z.string().min(1).nullable().optional(), "mandate-url": z.union([z.string(), z.string()]).optional()})), meta: z.object({page: z.object({total: z.number().int().gte(0).optional(), "estimated-total": z.object({"at-least": z.literal(10000).optional()}).optional()}).optional()}), included: z.object({accounts: z.array(z.object({"account-submissions-url": z.union([z.string(), z.string()]), "bank-account-product-url": z.union([z.string(), z.string()]).optional(), "account-restricted": z.boolean(), "account-payments-url": z.union([z.string(), z.string()]), "pooled-account-memberships-url": z.union([z.string(), z.string()]).optional(), "account-admissions-url": z.union([z.string(), z.string()]), "bank-product-type": z.enum(["savings-account", "client-money-account", "safeguarding-account", "embedded-account", "operational-account"]), "account-mandates-url": z.union([z.string(), z.string()]).optional(), "display-name": z.string().min(1), "controller-url": z.string(), "pooled-funds": z.boolean(), "accrued-interest": z.object({currency: z.literal("GBP"), value: z.string()}), "account-status": z.enum(["closing", "open", "closed", "opening"]), "client-money-type": z.enum(["designated-client-fund", "designated-client-money", "general-client-money"]).optional(), "owner-url": z.union([z.string(), z.string()]), "closed-at": z.string().optional(), "created-at": z.string(), "opened-at": z.string().optional(), "close-account-url": z.union([z.string(), z.string()]).optional(), "available-balance": z.object({currency: z.literal("GBP"), value: z.string()}), "pooled-account-membership-updates-url": z.union([z.string(), z.string()]).optional(), "bank-account-restrictions-url": z.union([z.string(), z.string()]).optional(), "bank-addresses": z.array(z.object({"account-holder": z.string().min(1), "bank-id-code": z.literal("gbdsc"), "bank-id": z.string().min(6).max(6), "account-number": z.string().min(8).max(8), "account-number-code": z.literal("bban")})).optional(), "account-transactions-url": z.union([z.string(), z.string()]), "account-url": z.union([z.string(), z.string()]), "bank-account-events-url": z.union([z.string(), z.string()]).optional(), "beneficiary-url": z.union([z.string(), z.string()]).optional(), "primary-account": z.boolean(), "account-balance": z.object({currency: z.literal("GBP"), value: z.string()}), "savings-type": z.enum(["easy-access", "bare-trust"]).optional(), "account-statements-url": z.union([z.string(), z.string()])})).optional(), submissions: z.array(z.object({"submission-scheme-information": z.union([z.object({"end-to-end-identification": z.string().min(1), "scheme-status-code": z.string().min(1).optional(), "scheme-status-code-description": z.string().min(1).optional(), "payment-scheme": z.literal("fps")}), z.object({"end-to-end-identification": z.string().min(1), "payment-scheme": z.literal("book-transfer")})]), "submission-status": z.enum(["scheduled", "failed", "processing", "returned", "delivered"]), "created-by-url": z.string().optional(), "scheduled-at": z.string().optional(), "created-at": z.string(), "submission-status-reason": z.string().min(1).optional(), "payment-url": z.string(), "unique-scheme-identifier": z.string().min(1).max(140).optional(), "account-url": z.union([z.string(), z.string()]), "submission-url": z.string()})).optional(), users: z.array(z.object({"user-email": z.string(), "user-url": z.string(), "user-username": z.string(), "api-keys-url": z.union([z.string(), z.string()]), "user-memberships-url": z.union([z.string(), z.string()]), "given-name": z.string().min(1).optional(), surname: z.string().min(1).optional()})).optional()}).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 }; /** * Search payments * * POST /v0/organizations/{organization-id}/payments/search */ export const createApiV0OrganizationsOrganizationIdPaymentsSearch = async (args: CreateApiV0OrganizationsOrganizationIdPaymentsSearchArgs, options?: CreateApiV0OrganizationsOrganizationIdPaymentsSearchOptions) => { const {baseUrl = "https://api.griffin.com", fetch: fetchFn = fetch, apiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") for (const item of args.include ?? []) query.append("include", String(item)) if (apiKeyAuth !== undefined) headers.set("Authorization", apiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v0/organizations/${encodeURIComponent(String(args['organization-id']))}/payments/search${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(createApiV0OrganizationsOrganizationIdPaymentsSearchResponse, await res.json()) };