import {z} from 'zod' export type GetApiApiV21CalendarRatingsAnalystsArgs = {page?: number | undefined, pageSize?: number | undefined, fields?: string | undefined, analyst?: string | undefined, analyst_name?: string | undefined, firm?: string | undefined, firm_name?: string | undefined, updated?: number | undefined}; export type GetApiApiV21CalendarRatingsAnalystsOptions = {baseUrl?: string | undefined, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank = z.object({rank: z.number().int().optional(), total: z.number().int().optional()}); export const gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRatingsAccuracy = z.object({"1m_average_return": z.string().optional(), "1m_gain_count": z.number().int().optional(), "1m_loss_count": z.number().int().optional(), "1m_smart_score": z.string().optional(), "1m_stdev": z.string().optional(), "1m_success_rate": z.string().optional(), "1y_average_return": z.string().optional(), "1y_gain_count": z.number().int().optional(), "1y_loss_count": z.number().int().optional(), "1y_smart_score": z.string().optional(), "1y_stdev": z.string().optional(), "1y_success_rate": z.string().optional(), "2y_average_return": z.string().optional(), "2y_gain_count": z.number().int().optional(), "2y_loss_count": z.number().int().optional(), "2y_smart_score": z.string().optional(), "2y_stdev": z.string().optional(), "2y_success_rate": z.string().optional(), "3m_average_return": z.string().optional(), "3m_gain_count": z.number().int().optional(), "3m_loss_count": z.number().int().optional(), "3m_smart_score": z.string().optional(), "3m_stdev": z.string().optional(), "3m_success_rate": z.string().optional(), "3y_average_return": z.string().optional(), "3y_gain_count": z.number().int().optional(), "3y_loss_count": z.number().int().optional(), "3y_smart_score": z.string().optional(), "3y_stdev": z.string().optional(), "3y_success_rate": z.string().optional(), "9m_average_return": z.string().optional(), "9m_gain_count": z.number().int().optional(), "9m_loss_count": z.number().int().optional(), "9m_smart_score": z.string().optional(), "9m_stdev": z.string().optional(), "9m_success_rate": z.string().optional(), overall_average_return: z.string().optional(), overall_avg_return_percentile: z.string().optional(), overall_gain_count: z.number().int().optional(), overall_loss_count: z.number().int().optional(), overall_stdev: z.string().optional(), overall_success_rate: z.string().optional(), smart_score: z.string().optional(), total_ratings: z.number().int().optional(), total_ratings_percentile: z.string().optional(), updated: z.number().int().optional()}); export const gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRatingsAnalyst = z.object({firm_id: z.string().optional(), firm_name: z.string().optional(), id: z.string().optional(), name_first: z.string().optional(), name_full: z.string().optional(), name_last: z.string().optional(), rank: z.object({"1m_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), "1y_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), "2y_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), "3m_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), "3y_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), "9m_smart_score_rank": gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional(), overall_smart_score_rank: gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRank.optional()}).optional(), ratings_accuracy: gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRatingsAccuracy.optional(), updated: z.number().int().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 }; /** * Ratings Analysts * * GET /api/v2.1/calendar/ratings/analysts */ export const getApiApiV21CalendarRatingsAnalysts = async (args: GetApiApiV21CalendarRatingsAnalystsArgs, options?: GetApiApiV21CalendarRatingsAnalystsOptions) => { 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.page != null) query.append("page", String(args.page)) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.fields != null) query.append("fields", String(args.fields)) if (args.analyst != null) query.append("analyst", String(args.analyst)) if (args.analyst_name != null) query.append("analyst_name", String(args.analyst_name)) if (args.firm != null) query.append("firm", String(args.firm)) if (args.firm_name != null) query.append("firm_name", String(args.firm_name)) if (args.updated != null) query.append("updated", String(args.updated)) if (ApiKeyAuth !== undefined) headers.set("Key", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2.1/calendar/ratings/analysts${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(gitlabBenzingaIoBenzingaBzgoPkgModelsCalendarApiRatingsAnalyst, await res.json()) };