import {z} from 'zod' export type GetApiApiV22CalendarDividendsArgs = {accept: 'application/json', page?: number | undefined, pagesize?: number | undefined, 'parameters[date]'?: unknown | undefined, 'parameters[date_from]'?: unknown | undefined, 'parameters[date_to]'?: unknown | undefined, 'parameters[date_sort]'?: ('announced' | 'ex' | 'payable' | 'record') | undefined, 'parameters[dividend_yield_operation]'?: ('gt' | 'gte' | 'eq' | 'lte' | 'lt') | undefined, 'parameters[dividend_yield]'?: number | undefined, 'parameters[importance]'?: (0 | 1 | 2 | 3 | 4 | 5) | undefined, 'parameters[tickers]'?: unknown | undefined, 'parameters[updated]'?: number | undefined}; export type GetApiApiV22CalendarDividendsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiDividend = z.object({confirmed: z.boolean().optional(), currency: z.string().optional(), cusip: z.string().optional(), date: z.string().optional(), dividend: z.string().optional(), dividend_prior: z.string().optional(), dividend_type: z.string().optional(), dividend_yield: z.string().optional(), end_regular_dividend: z.boolean().optional(), ex_dividend_date: z.string().optional(), exchange: z.string().optional(), frequency: z.number().int().optional(), id: z.string().optional(), importance: z.number().int().optional(), isin: z.string().optional(), name: z.string().optional(), notes: z.string().optional(), payable_date: z.string().optional(), period: z.string().optional(), record_date: z.string().optional(), ticker: z.string().optional(), updated: z.number().int().optional(), year: z.number().int().optional()}); export const apiDividendResponse = z.object({dividends: z.array(gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiDividend).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 }; /** * Dividends Events V2.2 * * GET /api/v2.2/calendar/dividends */ export const getApiApiV22CalendarDividends = async (args: GetApiApiV22CalendarDividendsArgs, options?: GetApiApiV22CalendarDividendsOptions) => { const {baseUrl = "https://api.benzinga.com", fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.accept != null) headers.set("accept", String(args.accept)) if (args.page != null) query.append("page", String(args.page)) if (args.pagesize != null) query.append("pagesize", String(args.pagesize)) if (args['parameters[date]'] != null) query.append("parameters[date]", String(args['parameters[date]'])) if (args['parameters[date_from]'] != null) query.append("parameters[date_from]", String(args['parameters[date_from]'])) if (args['parameters[date_to]'] != null) query.append("parameters[date_to]", String(args['parameters[date_to]'])) if (args['parameters[date_sort]'] != null) query.append("parameters[date_sort]", String(args['parameters[date_sort]'])) if (args['parameters[dividend_yield_operation]'] != null) query.append("parameters[dividend_yield_operation]", String(args['parameters[dividend_yield_operation]'])) if (args['parameters[dividend_yield]'] != null) query.append("parameters[dividend_yield]", String(args['parameters[dividend_yield]'])) if (args['parameters[importance]'] != null) query.append("parameters[importance]", String(args['parameters[importance]'])) if (args['parameters[tickers]'] != null) query.append("parameters[tickers]", String(args['parameters[tickers]'])) if (args['parameters[updated]'] != null) query.append("parameters[updated]", String(args['parameters[updated]'])) if (ApiKeyAuth !== undefined) headers.set("Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2.2/calendar/dividends${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(apiDividendResponse, await res.json()) };