import {z} from 'zod' export type BasePeriod = 'annual' | 'quarter'; export type GetApiApiFootnotesBusinessSegmentationArgs = {symbol?: string | undefined, cik?: number | undefined, cusip?: string | undefined, composite_figi?: string | undefined, share_class_figi?: string | undefined, period?: BasePeriod | undefined, limit?: number | undefined, includeSubtotals?: boolean | undefined}; export type GetApiApiFootnotesBusinessSegmentationOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const baseFiscalPeriod = z.enum(["FY", "Q1", "Q2", "Q3", "Q4"]); export const getApiApiFootnotesBusinessSegmentationResponse = z.array(z.object({period: z.string().optional(), fiscalYear: z.number().int().optional(), fiscalPeriod: baseFiscalPeriod.optional(), unit: z.string().optional(), segments: z.array(z.object({member: z.string().optional(), name: z.string().optional(), role: z.enum(["segment", "elimination", "reconciling", "subtotal"]).optional(), metrics: z.object({revenue: z.number().optional(), operatingIncome: z.number().optional(), grossProfit: z.number().optional(), assets: z.number().optional(), goodwill: z.number().optional(), depreciationAmortization: z.number().optional(), capex: z.number().optional(), netIncome: z.number().optional()}).optional()})).optional(), dateFiled: z.string().nullable().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 }; /** * Business Segmentation * * GET /api/footnotes/business-segmentation */ export const getApiApiFootnotesBusinessSegmentation = async (args: GetApiApiFootnotesBusinessSegmentationArgs, options?: GetApiApiFootnotesBusinessSegmentationOptions) => { const {baseUrl = "https://api.stockfit.io/v1", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.symbol != null) query.append("symbol", String(args.symbol)) if (args.cik != null) query.append("cik", String(args.cik)) if (args.cusip != null) query.append("cusip", String(args.cusip)) if (args.composite_figi != null) query.append("composite_figi", String(args.composite_figi)) if (args.share_class_figi != null) query.append("share_class_figi", String(args.share_class_figi)) if (args.period != null) query.append("period", String(args.period)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.includeSubtotals != null) query.append("includeSubtotals", String(args.includeSubtotals)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/footnotes/business-segmentation${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(getApiApiFootnotesBusinessSegmentationResponse, await res.json()) };