import {z} from 'zod' export type GetApiConstraintsConstraintIdIntervalsArgs = {constraint_id: string, dataset_id: string, contingency_id?: (string | null) | undefined, api_key?: (string | null) | undefined, 'x-api-key'?: (string | null) | undefined}; export type GetApiConstraintsConstraintIdIntervalsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const constraintIntervalDayResponse = z.object({day: z.number().int(), count: z.number().int(), times: z.array(z.string()).nullable().optional()}); export const constraintIntervalMonthResponse = z.object({month: z.number().int(), count: z.number().int(), days: z.array(constraintIntervalDayResponse).nullable().optional()}); export const constraintIntervalResponse = z.object({year: z.number().int(), count: z.number().int(), months: z.array(constraintIntervalMonthResponse).nullable().optional()}); export const getApiConstraintsConstraintIdIntervalsResponse = z.array(constraintIntervalResponse); 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 }; /** * Get Constraint Intervals * * GET /constraints/{constraint_id}/intervals */ export const getApiConstraintsConstraintIdIntervals = async (args: GetApiConstraintsConstraintIdIntervalsArgs, options?: GetApiConstraintsConstraintIdIntervalsOptions) => { 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.dataset_id != null) query.append("dataset_id", String(args.dataset_id)) if (args.contingency_id != null) query.append("contingency_id", String(args.contingency_id)) if (args.api_key != null) query.append("api_key", String(args.api_key)) 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))}/intervals${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(getApiConstraintsConstraintIdIntervalsResponse, await res.json()) };