import {z} from 'zod' export type GetApiV1SecuritiesTickerFailsToDeliverArgs = {ticker: string, startDate?: string | undefined, endDate?: string | undefined, limit?: number | undefined, offset?: number | undefined}; export type GetApiV1SecuritiesTickerFailsToDeliverOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const listingNotice = z.object({status: z.string().nullable().optional(), ticker: z.string().nullable().optional(), delistedOn: z.string().nullable().optional(), successorTicker: z.string().nullable().optional()}); export const failToDeliverDto = z.object({settlementDate: z.string().optional(), quantity: z.number().int().optional(), price: z.number().optional(), value: z.number().optional()}); export const pageMeta = z.object({limit: z.number().int().optional(), offset: z.number().int().optional(), count: z.number().int().optional(), hasMore: z.boolean().optional(), total: z.number().int().nullable().optional()}); export const failToDeliverPagedResponse = z.object({coverageStartDate: z.string().nullable().optional(), listingNotice: listingNotice.optional(), data: z.array(failToDeliverDto).nullable().optional(), meta: pageMeta.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 }; /** * SEC fails-to-deliver (FTD) records for an exact listed stock or ETF, newest first. Each row is the aggregate outstanding fail position on its settlement date (a balance, not a flow) at the prior trading day's closing price; the SEC publishes FTD data in half-month batches with a roughly two-week lag. coverageStartDate is the first fully covered settlement date: from it onward, absent dates mean no reported fails; earlier dates are only partially covered, so their absence is not evidence of no fails. * * GET /v1/securities/{ticker}/fails-to-deliver */ export const getApiV1SecuritiesTickerFailsToDeliver = async (args: GetApiV1SecuritiesTickerFailsToDeliverArgs, options?: GetApiV1SecuritiesTickerFailsToDeliverOptions) => { 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 (args.startDate != null) query.append("startDate", String(args.startDate)) if (args.endDate != null) query.append("endDate", String(args.endDate)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/securities/${encodeURIComponent(String(args.ticker))}/fails-to-deliver${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(failToDeliverPagedResponse, await res.json()) };