import {z} from 'zod' export type GetApiV1EfileFilingsArgs = {page?: number | undefined, per_page?: number | undefined, file_number?: Array | undefined, committee_id?: Array | undefined, min_receipt_date?: string | undefined, max_receipt_date?: string | undefined, q_filer?: Array | undefined, form_type?: Array | undefined, sort?: string | undefined, sort_hide_null?: boolean | undefined, sort_null_only?: boolean | undefined, sort_nulls_last?: boolean | undefined, api_key?: string | undefined}; export type GetApiV1EfileFilingsOptions = {baseUrl: string, ApiKeyHeaderAuth?: string | undefined, ApiKeyQueryAuth?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const offsetInfo = z.object({count: z.number().int().optional(), is_count_exact: z.boolean().optional(), page: z.number().int().optional(), pages: z.number().int().optional(), per_page: z.number().int().optional()}); export const eFilings = z.object({amended_by: z.number().int().optional(), amendment_chain: z.array(z.number().int()).optional(), amendment_number: z.number().int().nullable().optional(), amends_file: z.number().int().nullable().optional(), beginning_image_number: z.string().optional(), committee_id: z.string().nullable().optional(), committee_name: z.string().nullable().optional(), coverage_end_date: z.string().nullable().optional(), coverage_start_date: z.string().nullable().optional(), csv_url: z.string().optional(), document_description: z.string().optional(), ending_image_number: z.string().optional(), fec_file_id: z.string().optional(), fec_url: z.string().optional(), file_number: z.number().int().optional(), filed_date: z.string().nullable().optional(), form_type: z.string().nullable().optional(), html_url: z.string().optional(), is_amended: z.boolean().optional(), load_timestamp: z.string().nullable().optional(), most_recent: z.boolean().optional(), most_recent_filing: z.number().int().optional(), pdf_url: z.string().optional(), receipt_date: z.string().nullable().optional()}); export const eFilingsPage = z.object({pagination: offsetInfo.optional(), results: z.array(eFilings).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 }; /** * Basic information about electronic files coming into the FEC, posted as they are received. * * GET /v1/efile/filings/ */ export const getApiV1EfileFilings = async (args: GetApiV1EfileFilingsArgs, options: GetApiV1EfileFilingsOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKeyHeaderAuth, ApiKeyQueryAuth, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.page != null) query.append("page", String(args.page)) if (args.per_page != null) query.append("per_page", String(args.per_page)) for (const item of args.file_number ?? []) query.append("file_number", String(item)) for (const item of args.committee_id ?? []) query.append("committee_id", String(item)) if (args.min_receipt_date != null) query.append("min_receipt_date", String(args.min_receipt_date)) if (args.max_receipt_date != null) query.append("max_receipt_date", String(args.max_receipt_date)) for (const item of args.q_filer ?? []) query.append("q_filer", String(item)) for (const item of args.form_type ?? []) query.append("form_type", String(item)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.sort_hide_null != null) query.append("sort_hide_null", String(args.sort_hide_null)) if (args.sort_null_only != null) query.append("sort_null_only", String(args.sort_null_only)) if (args.sort_nulls_last != null) query.append("sort_nulls_last", String(args.sort_nulls_last)) if (args.api_key != null) query.append("api_key", String(args.api_key)) if (ApiKeyHeaderAuth !== undefined) headers.set("X-Api-Key", ApiKeyHeaderAuth) if (ApiKeyQueryAuth !== undefined) query.set("api_key", ApiKeyQueryAuth) if (apiKey !== undefined) query.set("api_key", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/v1/efile/filings/${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(eFilingsPage, await res.json()) };