import {z} from 'zod' export type GetApiGbModoBenchmarkingMonthlyLeaderboardArgs = {date_from: string, date_to: string, asset_name?: string | undefined, group_by?: string | undefined, is_bmu?: ('Yes' | 'No') | undefined, overall_units?: ('GBP per hour per mw' | 'GBP per month per mw' | 'GBP per year per mw' | 'GBP per hour per mwh' | 'GBP per month per mwh' | 'GBP per year per mwh') | undefined, is_long_term?: ('Yes' | 'No') | undefined, limit?: number | undefined, offset?: number | undefined}; export type GetApiGbModoBenchmarkingMonthlyLeaderboardOptions = {baseUrl?: string | undefined, apiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const monthyLeaderboardBreakdown = z.object({date: z.string().optional(), asset: z.string().nullable().optional(), owner: z.string().nullable().optional(), operator: z.string().nullable().optional(), is_bmu: z.boolean(), is_long_term: z.boolean(), wholesale: z.number().optional(), dcl: z.number().optional(), dml: z.number().optional(), dmh: z.number().optional(), drl: z.number().optional(), drh: z.number().optional(), bm: z.number().optional(), efr: z.number().optional(), wffr: z.number().optional(), mffr: z.number().optional(), dch: z.number().optional(), cm: z.number().optional(), triads: z.number().optional(), imbalance: z.number().optional(), soc: z.number().optional(), br: z.number().optional(), rank: z.number().int().gte(-2147483648).lte(2147483647), previous_rank: z.number().int().optional(), rated_power_mw: z.number(), energy_capacity_mwh: z.number(), bmu: z.boolean(), contracted_power: z.number(), cycles_per_day: z.number(), change_on_last_month: z.number().optional(), monthly_revenue: z.number(), merchant: z.number(), current_month: z.number(), previous_month: z.number().optional(), ytd: z.number().optional(), overall_units: z.string().optional(), qr: z.string().optional(), sr: z.string().optional()}); export const getApiGbModoBenchmarkingMonthlyLeaderboardResponse = z.object({count: z.number().int(), next: z.string().nullable().optional(), previous: z.string().nullable().optional(), results: z.array(monthyLeaderboardBreakdown)}); 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 }; /** * Monthly Leaderboard - GB * * GET /gb/modo/benchmarking/monthly-leaderboard */ export const getApiGbModoBenchmarkingMonthlyLeaderboard = async (args: GetApiGbModoBenchmarkingMonthlyLeaderboardArgs, options?: GetApiGbModoBenchmarkingMonthlyLeaderboardOptions) => { const {baseUrl = "https://api.modoenergy.com/pub/v1", fetch: fetchFn = fetch, apiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.date_from != null) query.append("date_from", String(args.date_from)) if (args.date_to != null) query.append("date_to", String(args.date_to)) if (args.asset_name != null) query.append("asset_name", String(args.asset_name)) if (args.group_by != null) query.append("group_by", String(args.group_by)) if (args.is_bmu != null) query.append("is_bmu", String(args.is_bmu)) if (args.overall_units != null) query.append("overall_units", String(args.overall_units)) if (args.is_long_term != null) query.append("is_long_term", String(args.is_long_term)) 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("X-Token", apiKey) const url = `${baseUrl.replace(/\/+$/, '')}/gb/modo/benchmarking/monthly-leaderboard${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(getApiGbModoBenchmarkingMonthlyLeaderboardResponse, await res.json()) };