import {z} from 'zod' export type GetApiApiV2FeedAccountAccountUidSettledTransactionsBetweenArgs = {accountUid: string, minTransactionTimestamp: string, maxTransactionTimestamp: string}; export type GetApiApiV2FeedAccountAccountUidSettledTransactionsBetweenOptions = {baseUrl: string, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const currencyAndAmount = z.object({currency: z.string().min(1), minorUnits: z.number().int().gte(0)}); export const associatedFeedRoundUp = z.object({goalCategoryUid: z.string().optional(), amount: currencyAndAmount.optional()}); export const batchPaymentDetails = z.object({batchPaymentUid: z.string().optional(), batchPaymentType: z.literal("BULK_PAYMENT").optional()}); export const feedItem = z.object({feedItemUid: z.string().optional(), categoryUid: z.string().optional(), amount: currencyAndAmount.optional(), sourceAmount: currencyAndAmount.optional(), direction: z.enum(["IN", "OUT"]).optional(), updatedAt: z.string().optional(), transactionTime: z.string().optional(), settlementTime: z.string().optional(), retryAllocationUntilTime: z.string().optional(), source: z.enum(["BRITISH_BUSINESS_BANK_FEES", "CARD_FEE_CHARGE", "CASH_DEPOSIT", "CASH_DEPOSIT_CHARGE", "CASH_WITHDRAWAL", "CASH_WITHDRAWAL_CHARGE", "CHAPS", "CHEQUE", "CICS_CHEQUE", "CURRENCY_CLOUD", "DIRECT_CREDIT", "DIRECT_DEBIT", "DIRECT_DEBIT_DISPUTE", "INTERNAL_TRANSFER", "MASTER_CARD", "MASTERCARD_MONEYSEND", "MASTERCARD_CHARGEBACK", "MISSED_PAYMENT_FEE", "FASTER_PAYMENTS_IN", "FASTER_PAYMENTS_OUT", "FASTER_PAYMENTS_REVERSAL", "STRIPE_FUNDING", "INTEREST_PAYMENT", "NOSTRO_DEPOSIT", "OVERDRAFT", "OVERDRAFT_INTEREST_WAIVED", "FASTER_PAYMENTS_REFUND", "STARLING_PAY_STRIPE", "ON_US_PAY_ME", "LOAN_PRINCIPAL_PAYMENT", "LOAN_REFUND", "LOAN_REPAYMENT", "LOAN_OVERPAYMENT", "LOAN_LATE_PAYMENT", "LOAN_FEE_PAYMENT", "LOAN_INTEREST_CHARGE", "SEPA_CREDIT_TRANSFER", "SEPA_DIRECT_DEBIT", "TARGET2_CUSTOMER_PAYMENT", "FX_TRANSFER", "ISS_PAYMENT", "STARLING_PAYMENT", "SUBSCRIPTION_CHARGE", "OVERDRAFT_FEE", "WITHHELD_TAX", "ERRORS_AND_OMISSIONS", "MARKETING_REFERRALS_REWARD", "BUSINESS_REFERRALS_REWARD", "INTEREST_V2_PAYMENT"]).optional(), sourceSubType: z.enum(["CONTACTLESS", "MAGNETIC_STRIP", "MANUAL_KEY_ENTRY", "CHIP_AND_PIN", "ONLINE", "ATM", "CREDIT_AUTH", "APPLE_PAY", "APPLE_PAY_ONLINE", "ANDROID_PAY", "ANDROID_PAY_ONLINE", "FITBIT_PAY", "GARMIN_PAY", "SAMSUNG_PAY", "CLICK_TO_PAY", "OTHER_WALLET", "CARD_SUBSCRIPTION", "NOT_APPLICABLE", "UNKNOWN", "DEPOSIT", "OVERDRAFT", "SETTLE_UP", "NEARBY", "TRANSFER_SAME_CURRENCY", "NEW_CARD", "NEW_CARD_OVERSEAS"]).optional(), status: z.enum(["UPCOMING", "UPCOMING_CANCELLED", "PENDING", "REVERSED", "SETTLED", "DECLINED", "REFUNDED", "RETRYING", "ACCOUNT_CHECK"]).optional(), transactingApplicationUserUid: z.string().optional(), counterPartyType: z.enum(["CATEGORY", "CHEQUE", "CUSTOMER", "PAYEE", "MERCHANT", "SENDER", "STARLING", "LOAN"]).optional(), counterPartyUid: z.string().optional(), counterPartyName: z.string().optional(), counterPartySubEntityUid: z.string().optional(), counterPartySubEntityName: z.string().optional(), counterPartySubEntityIdentifier: z.string().optional(), counterPartySubEntitySubIdentifier: z.string().optional(), exchangeRate: z.number().optional(), totalFees: z.number().optional(), totalFeeAmount: currencyAndAmount.optional(), reference: z.string().optional(), country: z.enum(["UNDEFINED", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BU", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CP", "CR", "CS", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DG", "DJ", "DK", "DM", "DO", "DZ", "EA", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "EU", "EZ", "FI", "FJ", "FK", "FM", "FO", "FR", "FX", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "IC", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NT", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SF", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SU", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UK", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XI", "XU", "XK", "XX", "YE", "YT", "YU", "ZA", "ZM", "ZR", "ZW"]).optional(), spendingCategory: z.enum(["BIKE", "BILLS_AND_SERVICES", "BUCKET_LIST", "CAR", "CASH", "CELEBRATION", "CHARITY", "CHILDREN", "CLOTHES", "COFFEE", "DEBT_REPAYMENT", "DIY", "DRINKS", "EATING_OUT", "EDUCATION", "EMERGENCY", "ENTERTAINMENT", "ESSENTIAL_SPEND", "EXPENSES", "FAMILY", "FITNESS", "FUEL", "GAMBLING", "GAMING", "GARDEN", "GENERAL", "GIFTS", "GROCERIES", "HOBBY", "HOLIDAYS", "HOME", "IMPULSE_BUY", "INCOME", "INSURANCE", "INVESTMENTS", "LIFESTYLE", "MAINTENANCE_AND_REPAIRS", "MEDICAL", "MORTGAGE", "NON_ESSENTIAL_SPEND", "PAYMENTS", "PERSONAL_CARE", "PERSONAL_TRANSFERS", "PETS", "PROJECTS", "RELATIONSHIPS", "RENT", "SAVING", "SHOPPING", "SUBSCRIPTIONS", "TAKEAWAY", "TAXI", "TRANSPORT", "TREATS", "WEDDING", "WELLBEING", "NONE", "REVENUE", "OTHER_INCOME", "CLIENT_REFUNDS", "INVENTORY", "STAFF", "TRAVEL", "WORKPLACE", "REPAIRS_AND_MAINTENANCE", "ADMIN", "MARKETING", "BUSINESS_ENTERTAINMENT", "INTEREST_PAYMENTS", "BANK_CHARGES", "OTHER", "FOOD_AND_DRINK", "EQUIPMENT", "PROFESSIONAL_SERVICES", "PHONE_AND_INTERNET", "VEHICLES", "DIRECTORS_WAGES", "VAT", "CORPORATION_TAX", "SELF_ASSESSMENT_TAX", "INVESTMENT_CAPITAL", "TRANSFERS", "LOAN_PRINCIPAL", "PERSONAL", "DIVIDENDS", "MONEY_OWED_FROM_CLIENTS", "CONSULTANCY_FEES", "OFFICE_AND_POSTAGE_COSTS", "TRAINING", "EMPLOYEE_BENEFITS", "ACCOUNTANCY_FEES", "IMPORT_VAT", "CATEGORISE_LATER", "SOFTWARE_AND_SUBSCRIPTIONS", "EXCHANGE_RATE_CHANGES", "EMPLOYEE_PENSIONS", "STAFF_TAXES", "SOFTWARE", "EQUIPMENT_HIRE", "CAPITAL_INTRODUCED", "DONATIONS", "PENSION_CONTRIBUTIONS", "PERSONAL_WITHDRAWALS", "CREDIT_CARD_REPAYMENTS", "TAX_POT_SAVINGS", "GRANTS", "REIMBURSED_EXPENSES", "VEHICLE_PURCHASES", "RENTAL_INCOME", "RENTAL_SERVICES", "RESIDENTIAL_PROPERTY_FINANCE_COSTS", "NON_RESIDENTIAL_PROPERTY_FINANCE_COSTS", "AGENT_MANAGEMENT_AND_LEGAL_FEES", "RENT_PAID_BY_YOU", "COUNCIL_TAX_PAID_BY_YOU", "OTHER_RATES_PAID_BY_YOU", "UTILITIES_PAID_BY_YOU", "RENTAL_INSURANCE", "REPLACING_DAMAGED_FURNISHINGS_AND_APPLIANCES", "GARDENING_CLEANING_AND_OTHER_SERVICES", "ADVERTISING", "MILEAGE_AND_OTHER_TRAVEL_COSTS", "OTHER_ALLOWABLE_COSTS", "MORTGAGE_CAPITAL_REPAYMENTS", "PROPERTY_UPGRADES", "RENTAL_REPAIRS_AND_MAINTENANCE", "DISPOSAL_OF_ASSETS", "COST_OF_SALES", "EMPLOYEE_AND_EMPLOYER_PENSIONS", "PAYE_AND_NI", "PENALTIES_AND_FINES", "COMPUTER_HARDWARE", "BUILDINGS", "FURNITURE_AND_EQUIPMENT", "INTANGIBLE_ASSETS", "MONEY_OWED_TO_THE_BUSINESS", "STOCK", "MONEY_OWED_TO_SUPPLIERS", "OWED_TO_PAYE_AND_NI", "CORPORATION_TAX_OWED", "DIRECTORS_LOAN", "MONEY_OWED_TO_OTHERS", "PENSION_CONTRIBUTIONS_OWED", "MONEY_OWED_TO_EMPLOYEES", "VEHICLE_AND_FUEL_COSTS", "INTEREST_GAINED", "UTILITIES", "EMPLOYEE_ENTERTAINING", "PLATFORM_FEES", "SHARE_CAPITAL_OUTSTANDING", "CAPITALISED_COSTS", "CHARITABLE_DONATIONS", "SHARE_PREMIUM", "MULTIPLE"]).optional(), userNote: z.string().optional(), roundUp: associatedFeedRoundUp.optional(), hasAttachment: z.boolean().optional(), hasReceipt: z.boolean().optional(), batchPaymentDetails: batchPaymentDetails.optional()}); export const feedItems = z.object({feedItems: z.array(feedItem).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 the account holder's settled feed items for the specified account, which have settlement time between the two provided timestamps * * GET /api/v2/feed/account/{accountUid}/settled-transactions-between */ export const getApiApiV2FeedAccountAccountUidSettledTransactionsBetween = async (args: GetApiApiV2FeedAccountAccountUidSettledTransactionsBetweenArgs, options: GetApiApiV2FeedAccountAccountUidSettledTransactionsBetweenOptions) => { const {baseUrl, fetch: fetchFn = fetch, Bearer} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.minTransactionTimestamp != null) query.append("minTransactionTimestamp", String(args.minTransactionTimestamp)) if (args.maxTransactionTimestamp != null) query.append("maxTransactionTimestamp", String(args.maxTransactionTimestamp)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/feed/account/${encodeURIComponent(String(args.accountUid))}/settled-transactions-between${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(feedItems, await res.json()) };