import {z} from 'zod' export type GetApiV1StocksTickerGuidanceArgs = {ticker: string}; export type GetApiV1StocksTickerGuidanceOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const guidanceItemDto = z.object({filedDate: z.string().optional(), form: z.string().nullable().optional(), filingUrl: z.string().nullable().optional(), metric: z.string().nullable().optional(), metricKind: z.string().nullable().optional(), period: z.string().nullable().optional(), fiscalYear: z.number().int().nullable().optional(), fiscalQuarter: z.number().int().nullable().optional(), low: z.number().nullable().optional(), high: z.number().nullable().optional(), midpoint: z.number().nullable().optional(), unit: z.string().nullable().optional(), basis: z.string().nullable().optional(), fromTable: z.boolean().optional(), quote: z.string().nullable().optional(), periodEnded: z.boolean().nullable().optional(), actual: z.number().nullable().optional(), actualVerdict: z.string().nullable().optional(), actualIsDerived: z.boolean().optional(), priorActual: z.number().nullable().optional(), priorActualIsAnnual: z.boolean().optional(), midpointVsPriorPercent: z.number().nullable().optional(), changeVsPrior: z.string().nullable().optional()}); export const guidanceCoverageDto = z.object({documentsExamined: z.number().int().optional(), coverageStartDate: z.string().nullable().optional(), coverageEndDate: z.string().nullable().optional(), stalenessNote: z.string().nullable().optional()}); export const guidanceResponse = z.object({ticker: z.string().nullable().optional(), companyName: z.string().nullable().optional(), data: z.array(guidanceItemDto).nullable().optional(), coverage: guidanceCoverageDto.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 }; /** * A company's earnings guidance from its Item-2.02 8-K releases and earnings-call transcripts — each guided metric with its range, unit, GAAP/non-GAAP basis, period, the verbatim disclosure, and as-announced provenance, newest release first. Revenue and diluted-EPS guidance also carries the reported actual and an above/within/below verdict once the facts land. * * GET /v1/stocks/{ticker}/guidance */ export const getApiV1StocksTickerGuidance = async (args: GetApiV1StocksTickerGuidanceArgs, options?: GetApiV1StocksTickerGuidanceOptions) => { const {baseUrl = "https://api.equibles.com", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/stocks/${encodeURIComponent(String(args.ticker))}/guidance${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(guidanceResponse, await res.json()) };