import {z} from 'zod' export type GetApiBalancingNonbmVolumesArgs = {from: string, to: string, settlementPeriodFrom?: number | undefined, settlementPeriodTo?: number | undefined, bmUnit?: Array | undefined, format?: ('json' | 'xml' | 'csv') | undefined}; export type GetApiBalancingNonbmVolumesOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const insightsApiModelsResponsesBalancingBalancingServicesVolume = z.object({settlementDate: z.string().optional(), settlementPeriod: z.number().int().optional(), bmUnitApplicableBalancingServicesVolume: z.number().optional(), nationalGridBmUnit: z.string().nullable().optional(), bmUnit: z.string().nullable().optional(), time: z.string().optional()}); export const insightsApiModelsMetadataApiResponseSourceMetadata = z.object({datasets: z.array(z.string()).nullable().optional()}); export const insightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingBalancingServicesVolume = z.object({data: z.array(insightsApiModelsResponsesBalancingBalancingServicesVolume).nullable().optional(), metadata: insightsApiModelsMetadataApiResponseSourceMetadata.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 }; /** * Balancing services volume (QAS) * * GET /balancing/nonbm/volumes */ export const getApiBalancingNonbmVolumes = async (args: GetApiBalancingNonbmVolumesArgs, options?: GetApiBalancingNonbmVolumesOptions) => { const {baseUrl = "https://data.elexon.co.uk/bmrs/api/v1", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.from != null) query.append("from", String(args.from)) if (args.to != null) query.append("to", String(args.to)) if (args.settlementPeriodFrom != null) query.append("settlementPeriodFrom", String(args.settlementPeriodFrom)) if (args.settlementPeriodTo != null) query.append("settlementPeriodTo", String(args.settlementPeriodTo)) for (const item of args.bmUnit ?? []) query.append("bmUnit", String(item)) if (args.format != null) query.append("format", String(args.format)) const url = `${baseUrl.replace(/\/+$/, '')}/balancing/nonbm/volumes${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(insightsApiModelsResponsesResponseWithMetadata1InsightsApiModelsResponsesBalancingBalancingServicesVolume, await res.json()) };