import {z} from 'zod' export type GetApiReportsReportIdArgs = {report_id: string}; export type GetApiReportsReportIdOptions = {baseUrl?: string | undefined, appId?: string | undefined, secret?: string | undefined, fetch?: typeof fetch | undefined}; export const balanceReport = z.object({start_date_amount: z.number(), end_date_amount: z.number(), minimum: z.number(), maximum: z.number(), average: z.object({daily: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()}), daily_per_month: z.object({amount: z.number(), is_whole_month: z.boolean(), year: z.number().int(), month: z.number().int()}), monthly: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()}), minimum_monthly: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()}), maximum_monthly: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()}), quarterly: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()}), annual: z.object({amount: z.number(), start_date: z.string(), end_date: z.string()})}), forecasted_average: z.object({next_month: z.number(), next_quarter: z.number(), next_year: z.number()})}); export const incomeReport = z.object({start_date: z.string(), end_date: z.string(), transactions_count: z.number().int(), last_year_amount: z.number(), total: z.number(), total_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), is_whole_month: z.boolean(), amount: z.number(), count: z.number().int()})), average: z.object({monthly: z.number(), quarterly: z.number(), annual: z.number()}), forecasted_average: z.object({next_month: z.number(), next_quarter: z.number(), next_year: z.number()}), streams: z.object({regular_amount: z.number(), irregular_amount: z.number(), count: z.object({regular: z.number().int(), irregular: z.number().int(), maximum_overlapping: z.number().int()}), regular: z.array(z.object({transactions_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amount: z.object({total: z.number(), average: z.number(), median: z.number(), stdev: z.number()}), frequency: z.enum(["daily", "3_times_a_week", "twice_a_week", "weekly", "3_times_a_month", "every_2_weeks", "monthly", "every_2_months", "quarterly", "3_times_a_year", "2_times_a_year", "annual", "few_years"]), days_count: z.number().int(), category_code: z.string(), description: z.string(), merchant: z.object({name: z.string(), email: z.string(), phone: z.string(), address: z.string(), website: z.string()})})), irregular: z.object({transactions_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string()})})}); export const expenseReport = z.object({start_date: z.string(), end_date: z.string(), transactions_count: z.number().int(), last_year_amount: z.number(), total: z.number(), total_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), is_whole_month: z.boolean(), amount: z.number(), count: z.number().int()})), average: z.object({monthly: z.number(), quarterly: z.number(), annual: z.number()}), forecasted_average: z.object({next_month: z.number(), next_quarter: z.number(), next_year: z.number()}), streams: z.object({regular_amount: z.number(), irregular_amount: z.number(), count: z.object({regular: z.number().int(), irregular: z.number().int(), maximum_overlapping: z.number().int()}), regular: z.array(z.object({transactions_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amount: z.object({total: z.number(), average: z.number(), median: z.number(), stdev: z.number()}), frequency: z.enum(["daily", "3_times_a_week", "twice_a_week", "weekly", "3_times_a_month", "every_2_weeks", "monthly", "every_2_months", "quarterly", "3_times_a_year", "2_times_a_year", "annual", "few_years"]), days_count: z.number().int(), category_code: z.string(), description: z.string(), merchant: z.object({name: z.string(), email: z.string(), phone: z.string(), address: z.string(), website: z.string()})})), irregular: z.object({transactions_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string()})})}); export const savingsReport = z.object({total: z.number(), per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), is_whole_month: z.boolean(), amount: z.number()})), average: z.object({monthly: z.number(), quarterly: z.number(), annual: z.number()}), forecasted_average: z.object({next_month: z.number(), next_quarter: z.number(), next_year: z.number()}), runway: z.number(), expense_to_savings_rate: z.number(), stress_runway: z.number(), income_stability: z.number(), income_regularity: z.number(), income_to_expense_rate: z.number()}); export const expenseCategoriesReport = z.object({categories: z.array(z.object({category: z.string(), amount: z.number(), average: z.number(), amounts_per_month: z.array(z.object({month: z.string(), amount: z.number()}))}))}); export const incomeCategoriesReport = z.object({streams: z.array(z.object({regular_amount: z.number(), irregular_amount: z.number(), count: z.object({regular: z.number().int(), irregular: z.number().int()}), regular: z.array(z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amount: z.object({total: z.number(), average: z.number(), median: z.number(), stdev: z.number()}), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), frequency: z.string(), days_count: z.number().int(), category_code: z.string(), description: z.string(), merchant: z.object({name: z.string(), email: z.string(), phone: z.string(), address: z.string(), website: z.string()})})), irregular: z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), average: z.number()})}))}); export const inboundTransfersReport = z.object({streams: z.array(z.object({regular_amount: z.number(), irregular_amount: z.number(), count: z.object({regular: z.number().int(), irregular: z.number().int()}), regular: z.array(z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amount: z.object({total: z.number(), average: z.number(), median: z.number(), stdev: z.number()}), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), frequency: z.string(), days_count: z.number().int(), category_code: z.string(), description: z.string(), merchant: z.object({name: z.string(), email: z.string(), phone: z.string(), address: z.string(), website: z.string()})})), irregular: z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), average: z.number()})}))}); export const outboundTransfersReport = z.object({streams: z.array(z.object({regular_amount: z.number(), irregular_amount: z.number(), count: z.object({regular: z.number().int(), irregular: z.number().int()}), regular: z.array(z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amount: z.object({total: z.number(), average: z.number(), median: z.number(), stdev: z.number()}), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), frequency: z.string(), days_count: z.number().int(), category_code: z.string(), description: z.string(), merchant: z.object({name: z.string(), email: z.string(), phone: z.string(), address: z.string(), website: z.string()})})), irregular: z.object({transaction_count: z.number().int(), transaction_ids: z.array(z.string()), start_date: z.string(), end_date: z.string(), amounts_per_month: z.array(z.object({year: z.number().int(), month: z.number().int(), amount: z.number()})), average: z.number()})}))}); export const report = z.object({result: z.object({accounts: z.array(z.object({id: z.string(), name: z.string(), nature: z.enum(["account", "bonus", "card", "checking", "credit", "credit_card", "debit_card", "ewallet", "insurance", "investment", "loan", "mortgage", "savings"]), connection_id: z.string(), start_date: z.string(), end_date: z.string(), whole_months_count: z.number().int(), days_count: z.number().int(), monthly_average_transactions_count: z.object({total: z.number().int(), income: z.number().int(), expense: z.number().int()}), balance: balanceReport, income: incomeReport, expense: expenseReport, savings: savingsReport, expense_categories: expenseCategoriesReport, income_categories: incomeCategoriesReport, inbound_transfers: inboundTransfersReport, outbound_transfers: outboundTransfersReport})), accounts_summary: z.object({start_date: z.string(), end_date: z.string(), whole_months_count: z.number().int(), days_count: z.number().int(), transactions_count: z.number().int(), monthly_average_transactions_count: z.object({total: z.number().int(), income: z.number().int(), expense: z.number().int()}), balance: balanceReport, income: incomeReport, expense: expenseReport, savings: savingsReport, expense_categories: expenseCategoriesReport, income_categories: incomeCategoriesReport, inbound_transfers: inboundTransfersReport, outbound_transfers: outboundTransfersReport})}), customer_id: z.number().int(), connection_ids: z.array(z.string()), connections: z.array(z.object({id: z.string(), customer_id: z.number().int(), provider_code: z.string(), provider_name: z.string(), accounts: z.array(z.object({id: z.string(), name: z.string(), nature: z.enum(["account", "bonus", "card", "checking", "credit", "credit_card", "debit_card", "ewallet", "insurance", "investment", "loan", "mortgage", "savings"]), balance: z.number(), original_balance: z.number(), original_currency_code: z.string(), transactions: z.object({start_date: z.string(), end_date: z.string(), first_id: z.string(), last_id: z.string(), count: z.number().int()})})), holder_info: z.object({}), client_name: z.string()})), currency_code: z.string(), exchange_rates: z.object({}), report_id: z.number().int(), report_types: z.array(z.string()), status: z.enum(["initialized", "calculating", "success", "failed"]), from_date: z.string(), to_date: z.string()}); export const fullReport = z.object({id: z.string(), customer_id: z.string(), customer_identifier: z.string(), status: z.enum(["initialized", "calculating", "success", "failed"]), connection_ids: z.array(z.string()), include_account_natures: z.array(z.string()).optional(), currency_code: z.string(), from_date: z.string(), to_date: z.string(), report_types: z.array(z.string()), data: report, created_at: z.string(), updated_at: z.string()}); export const reportResponse = z.object({data: fullReport.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 }; /** * Show a report. * * GET /reports/{report_id} */ export const getApiReportsReportId = async (args: GetApiReportsReportIdArgs, options?: GetApiReportsReportIdOptions) => { const {baseUrl = "https://www.saltedge.com/api/v5", fetch: fetchFn = fetch, appId, secret} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (appId !== undefined) headers.set("App-id", appId) if (secret !== undefined) headers.set("Secret", secret) const url = `${baseUrl.replace(/\/+$/, '')}/reports/${encodeURIComponent(String(args.report_id))}${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(reportResponse, await res.json()) };