import {z} from 'zod' export type GetApiConstraintsConstraintIdStatsArgs = {constraint_id: string, aggregation_period: 'hour' | 'day' | 'month' | 'year', api_key?: (string | null) | undefined, dataset_id: string, timezone?: (string | null) | undefined, start_time?: (string | null) | undefined, end_time?: (string | null) | undefined, price_threshold?: (number | null) | undefined, contingency_id?: (string | null) | undefined, 'x-api-key'?: (string | null) | undefined}; export type GetApiConstraintsConstraintIdStatsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const constraintStatsIntervalResponse = z.object({interval_start_utc: z.string(), binding_intervals: z.number().int().nullable(), shadow_price_min: z.number().nullable(), shadow_price_mean: z.number().nullable(), shadow_price_median: z.number().nullable(), shadow_price_max: z.number().nullable(), absolute_cost: z.number().nullable()}); export const getApiConstraintsConstraintIdStatsResponse = z.array(constraintStatsIntervalResponse); 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 }; /** * List Constraint Stats By Interval * * GET /constraints/{constraint_id}/stats */ export const getApiConstraintsConstraintIdStats = async (args: GetApiConstraintsConstraintIdStatsArgs, options?: GetApiConstraintsConstraintIdStatsOptions) => { const {baseUrl = "https://api.gridstatus.io/v1", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.aggregation_period != null) query.append("aggregation_period", String(args.aggregation_period)) if (args.api_key != null) query.append("api_key", String(args.api_key)) if (args.dataset_id != null) query.append("dataset_id", String(args.dataset_id)) if (args.timezone != null) query.append("timezone", String(args.timezone)) if (args.start_time != null) query.append("start_time", String(args.start_time)) if (args.end_time != null) query.append("end_time", String(args.end_time)) if (args.price_threshold != null) query.append("price_threshold", String(args.price_threshold)) if (args.contingency_id != null) query.append("contingency_id", String(args.contingency_id)) if (args['x-api-key'] != null) headers.set("x-api-key", String(args['x-api-key'])) const url = `${baseUrl.replace(/\/+$/, '')}/constraints/${encodeURIComponent(String(args.constraint_id))}/stats${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(getApiConstraintsConstraintIdStatsResponse, await res.json()) };