import {z} from 'zod' export type GetApiTaxReturnsArgs = {entity_id?: number | undefined, external_entity_id?: string | undefined, tax_year?: number | undefined}; export type GetApiTaxReturnsOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const taxReturn = z.object({id: z.number().int().optional(), tax_return_name: z.string().nullable().optional(), tax_year: z.number().int().nullable().optional(), entity_id: z.number().int().optional(), entity_name: z.string().nullable().optional(), external_entity_id: z.string().nullable().optional(), entity_type: z.string().nullable().optional(), client_name: z.string().nullable().optional(), client_email: z.string().nullable().optional(), assigned_to: z.string().nullable().optional(), assigned_to_email: z.string().nullable().optional(), questionnaire_id: z.number().int().nullable().optional(), status: z.enum(["awaiting_upload", "action_required", "error", "finished", "invoice_paid", "processing", "sending", "sent", "filed"]).nullable().optional(), current_status: z.string().nullable().optional(), draft_status: z.string().nullable().optional(), all_signed: z.boolean().optional(), all_paid: z.boolean().nullable().optional(), can_mark_as_filed: z.boolean().optional(), signed_signature_count: z.number().int().optional(), total_signature_count: z.number().int().optional(), paid_payment_count: z.number().int().optional(), total_payment_count: z.number().int().optional(), outstanding_voucher_count: z.number().int().optional(), has_payment: z.boolean().optional(), payment_status: z.string().nullable().optional(), payment_amount: z.number().nullable().optional(), k1_distribution_status: z.string().nullable().optional(), reminder_disabled: z.boolean().optional(), last_sent_at: z.string().nullable().optional(), last_reminder_sent_at: z.string().nullable().optional(), sent_to_documents_at: z.string().nullable().optional(), created_at: z.string().optional(), updated_at: z.string().optional(), link: z.string().nullable().optional()}); export const getApiTaxReturnsResponse = z.array(taxReturn); 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 tax returns for an entity * * GET /tax_returns */ export const getApiTaxReturns = async (args: GetApiTaxReturnsArgs, options?: GetApiTaxReturnsOptions) => { const {baseUrl = "https://api.soraban.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.entity_id != null) query.append("entity_id", String(args.entity_id)) if (args.external_entity_id != null) query.append("external_entity_id", String(args.external_entity_id)) if (args.tax_year != null) query.append("tax_year", String(args.tax_year)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/tax_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(getApiTaxReturnsResponse, await res.json()) };