@vepler/sdk 2.42.0 → 2.45.0

package/src/sdk/models/operations/getsubstationbycode.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetSubstationByCodeRequest = {
+  code: string;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type GetSubstationByCodeCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationByCodeObject = {
+  Substation: "substation",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationByCodeObject = ClosedEnum<
+  typeof GetSubstationByCodeObject
+>;
+
+/**
+ * A network operator substation with its current capacity and headroom data
+ */
+export type GetSubstationByCodeSubstation = {
+  /**
+   * Unique substation identifier, prefixed with the operator code
+   */
+  code: string;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Available spare capacity for new demand connections, in megawatts (MW). Calculated as firm capacity minus peak demand
+   */
+  demandHeadroomMw: number | null;
+  /**
+   * Current peak electricity demand at this substation, in megawatts (MW)
+   */
+  demandMw: number | null;
+  /**
+   * Maximum firm capacity rating, in megawatts (MW). This is the guaranteed capacity available under all operating conditions
+   */
+  firmCapacityMw: number | null;
+  /**
+   * Available spare capacity for new generation connections (e.g. solar, wind), in megawatts (MW)
+   */
+  generationHeadroomMw: number | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  location: GetSubstationByCodeCoordinates | null;
+  /**
+   * Human-readable substation name, where available
+   */
+  name: string | null;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationByCodeObject;
+  /**
+   * Operating region name (e.g. 'UKPN (SPN)' in GB, or region name in other countries)
+   */
+  operatingRegion: string | null;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  operator: string;
+  /**
+   * Code of the parent substation in the network hierarchy (e.g. a primary's parent grid substation). Null for top-level GSPs
+   */
+  parentSubstationCode: string | null;
+  /**
+   * Maximum capacity for reverse power flow (generation exceeding local demand), in megawatts (MW)
+   */
+  reversePowerCapacityMw: number | null;
+  /**
+   * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
+   */
+  substationType: string | null;
+  /**
+   * Current utilisation as a percentage of firm capacity. Higher values indicate less available headroom
+   */
+  utilisationPct: number | null;
+  /**
+   * Operating voltage, in kilovolts (kV)
+   */
+  voltageKv: number | null;
+};
+
+/** @internal */
+export type GetSubstationByCodeRequest$Outbound = {
+  code: string;
+};
+
+/** @internal */
+export const GetSubstationByCodeRequest$outboundSchema: z.ZodType<
+  GetSubstationByCodeRequest$Outbound,
+  z.ZodTypeDef,
+  GetSubstationByCodeRequest
+> = z.object({
+  code: z.string(),
+});
+
+export function getSubstationByCodeRequestToJSON(
+  getSubstationByCodeRequest: GetSubstationByCodeRequest,
+): string {
+  return JSON.stringify(
+    GetSubstationByCodeRequest$outboundSchema.parse(getSubstationByCodeRequest),
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeCoordinates$inboundSchema: z.ZodType<
+  GetSubstationByCodeCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function getSubstationByCodeCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationByCodeCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationByCodeCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationByCodeCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationByCodeObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationByCodeObject
+> = z.nativeEnum(GetSubstationByCodeObject);
+
+/** @internal */
+export const GetSubstationByCodeSubstation$inboundSchema: z.ZodType<
+  GetSubstationByCodeSubstation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  country: z.string(),
+  demandHeadroomMw: z.nullable(z.number()),
+  demandMw: z.nullable(z.number()),
+  firmCapacityMw: z.nullable(z.number()),
+  generationHeadroomMw: z.nullable(z.number()),
+  location: z.nullable(
+    z.lazy(() => GetSubstationByCodeCoordinates$inboundSchema),
+  ),
+  name: z.nullable(z.string()),
+  object: GetSubstationByCodeObject$inboundSchema,
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  parentSubstationCode: z.nullable(z.string()),
+  reversePowerCapacityMw: z.nullable(z.number()),
+  substationType: z.nullable(z.string()),
+  utilisationPct: z.nullable(z.number()),
+  voltageKv: z.nullable(z.number()),
+});
+
+export function getSubstationByCodeSubstationFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationByCodeSubstation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationByCodeSubstation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationByCodeSubstation' from JSON`,
+  );
+}

package/src/sdk/models/operations/getsubstationcapacity.ts

@@ -0,0 +1,227 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetSubstationCapacityRequest = {
+  code: string;
+  /**
+   * Start date for the time range (inclusive, ISO 8601)
+   */
+  from?: string | undefined;
+  /**
+   * End date for the time range (inclusive, ISO 8601)
+   */
+  to?: string | undefined;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationCapacityEnergyObject = {
+  CapacitySnapshot: "capacity_snapshot",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationCapacityEnergyObject = ClosedEnum<
+  typeof GetSubstationCapacityEnergyObject
+>;
+
+/**
+ * A quarterly snapshot of substation capacity and headroom. Use these to track how available capacity changes over time
+ */
+export type GetSubstationCapacityCapacitySnapshot = {
+  /**
+   * Battery-specific headroom, in megawatts (MW). Only available from some operators
+   */
+  batteryHeadroomMw: number | null;
+  /**
+   * Available demand headroom at this snapshot date, in megawatts (MW)
+   */
+  demandHeadroomMw: number | null;
+  /**
+   * Peak demand at this snapshot date, in megawatts (MW)
+   */
+  demandMw: number | null;
+  /**
+   * Electric vehicle charger-specific headroom, in megawatts (MW). Only available from some operators
+   */
+  evHeadroomMw: number | null;
+  /**
+   * Firm capacity rating at this snapshot date, in megawatts (MW)
+   */
+  firmCapacityMw: number | null;
+  /**
+   * Available generation headroom at this snapshot date, in megawatts (MW)
+   */
+  generationHeadroomMw: number | null;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationCapacityEnergyObject;
+  /**
+   * Date of this capacity snapshot, typically the start of a quarter (ISO 8601)
+   */
+  snapshotDate: string;
+  /**
+   * Identifier for the data source this snapshot was extracted from
+   */
+  snapshotSource: string;
+  /**
+   * Solar-specific headroom, in megawatts (MW). Only available from some operators
+   */
+  solarHeadroomMw: number | null;
+  /**
+   * Code of the substation this snapshot belongs to
+   */
+  substationCode: string;
+  /**
+   * Utilisation percentage at this snapshot date
+   */
+  utilisationPct: number | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationCapacityObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationCapacityObject = ClosedEnum<
+  typeof GetSubstationCapacityObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type GetSubstationCapacityResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<GetSubstationCapacityCapacitySnapshot>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationCapacityObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type GetSubstationCapacityRequest$Outbound = {
+  code: string;
+  from?: string | undefined;
+  to?: string | undefined;
+};
+
+/** @internal */
+export const GetSubstationCapacityRequest$outboundSchema: z.ZodType<
+  GetSubstationCapacityRequest$Outbound,
+  z.ZodTypeDef,
+  GetSubstationCapacityRequest
+> = z.object({
+  code: z.string(),
+  from: z.string().optional(),
+  to: z.string().optional(),
+});
+
+export function getSubstationCapacityRequestToJSON(
+  getSubstationCapacityRequest: GetSubstationCapacityRequest,
+): string {
+  return JSON.stringify(
+    GetSubstationCapacityRequest$outboundSchema.parse(
+      getSubstationCapacityRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationCapacityEnergyObject
+> = z.nativeEnum(GetSubstationCapacityEnergyObject);
+
+/** @internal */
+export const GetSubstationCapacityCapacitySnapshot$inboundSchema: z.ZodType<
+  GetSubstationCapacityCapacitySnapshot,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  batteryHeadroomMw: z.nullable(z.number()),
+  demandHeadroomMw: z.nullable(z.number()),
+  demandMw: z.nullable(z.number()),
+  evHeadroomMw: z.nullable(z.number()),
+  firmCapacityMw: z.nullable(z.number()),
+  generationHeadroomMw: z.nullable(z.number()),
+  object: GetSubstationCapacityEnergyObject$inboundSchema,
+  snapshotDate: z.string(),
+  snapshotSource: z.string(),
+  solarHeadroomMw: z.nullable(z.number()),
+  substationCode: z.string(),
+  utilisationPct: z.nullable(z.number()),
+});
+
+export function getSubstationCapacityCapacitySnapshotFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationCapacityCapacitySnapshot, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubstationCapacityCapacitySnapshot$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationCapacityCapacitySnapshot' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationCapacityObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationCapacityObject
+> = z.nativeEnum(GetSubstationCapacityObject);
+
+/** @internal */
+export const GetSubstationCapacityResponseBody$inboundSchema: z.ZodType<
+  GetSubstationCapacityResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(
+    z.lazy(() => GetSubstationCapacityCapacitySnapshot$inboundSchema),
+  ),
+  has_more: z.boolean(),
+  object: GetSubstationCapacityObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function getSubstationCapacityResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationCapacityResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationCapacityResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationCapacityResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getsubstationdfes.ts

@@ -0,0 +1,218 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+import { safeParse } from "../../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type GetSubstationDFESRequest = {
+  code: string;
+  /**
+   * Filter by energy planning scenario
+   */
+  scenario?: string | undefined;
+  /**
+   * Start year for the forecast range (inclusive)
+   */
+  yearFrom?: number | null | undefined;
+  /**
+   * End year for the forecast range (inclusive)
+   */
+  yearTo?: number | null | undefined;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationDFESEnergyObject = {
+  DfesForecast: "dfes_forecast",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationDFESEnergyObject = ClosedEnum<
+  typeof GetSubstationDFESEnergyObject
+>;
+
+/**
+ * A forecast from an energy planning framework (e.g. DFES in GB), projecting future demand, generation, and storage capacity under different energy transition pathways
+ */
+export type GetSubstationDFESDFESForecast = {
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Forecast value, in megawatts (MW), for this scenario, year, and technology
+   */
+  forecastMw: number | null;
+  /**
+   * Category of a forecast. Known values: 'demand', 'generation', 'storage'. 'demand' forecasts electricity consumption growth. 'generation' forecasts new renewable/distributed generation capacity. 'storage' forecasts battery and other storage deployment. New categories can be added as energy models evolve (e.g. flexibility, hydrogen).
+   */
+  forecastType: string;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationDFESEnergyObject;
+  /**
+   * Operating region this forecast applies to
+   */
+  operatingRegion: string;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  operator: string;
+  /**
+   * Energy planning scenario identifier. Each country's energy planning framework defines its own scenarios. Known GB scenarios: 'leading_the_way', 'consumer_transformation', 'system_transformation', 'falling_short', 'best_view', 'holistic_transition'. 'leading_the_way' assumes fastest decarbonisation. 'falling_short' assumes slowest progress. 'best_view' is the operator's most likely central estimate.
+   */
+  scenario: string;
+  /**
+   * Code of the substation this forecast applies to, if substation-level
+   */
+  substationCode: string | null;
+  /**
+   * Technology type being forecast (e.g. solar, EV, heat pump, battery)
+   */
+  technologyType: string | null;
+  /**
+   * Forecast year
+   */
+  year: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetSubstationDFESObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetSubstationDFESObject = ClosedEnum<
+  typeof GetSubstationDFESObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type GetSubstationDFESResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<GetSubstationDFESDFESForecast>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetSubstationDFESObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type GetSubstationDFESRequest$Outbound = {
+  code: string;
+  scenario?: string | undefined;
+  yearFrom?: number | null | undefined;
+  yearTo?: number | null | undefined;
+};
+
+/** @internal */
+export const GetSubstationDFESRequest$outboundSchema: z.ZodType<
+  GetSubstationDFESRequest$Outbound,
+  z.ZodTypeDef,
+  GetSubstationDFESRequest
+> = z.object({
+  code: z.string(),
+  scenario: z.string().optional(),
+  yearFrom: z.nullable(z.number()).optional(),
+  yearTo: z.nullable(z.number()).optional(),
+});
+
+export function getSubstationDFESRequestToJSON(
+  getSubstationDFESRequest: GetSubstationDFESRequest,
+): string {
+  return JSON.stringify(
+    GetSubstationDFESRequest$outboundSchema.parse(getSubstationDFESRequest),
+  );
+}
+
+/** @internal */
+export const GetSubstationDFESEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationDFESEnergyObject
+> = z.nativeEnum(GetSubstationDFESEnergyObject);
+
+/** @internal */
+export const GetSubstationDFESDFESForecast$inboundSchema: z.ZodType<
+  GetSubstationDFESDFESForecast,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  country: z.string(),
+  forecastMw: z.nullable(z.number()),
+  forecastType: z.string(),
+  object: GetSubstationDFESEnergyObject$inboundSchema,
+  operatingRegion: z.string(),
+  operator: z.string(),
+  scenario: z.string(),
+  substationCode: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+  year: z.number(),
+});
+
+export function getSubstationDFESDFESForecastFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationDFESDFESForecast, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationDFESDFESForecast$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationDFESDFESForecast' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubstationDFESObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetSubstationDFESObject
+> = z.nativeEnum(GetSubstationDFESObject);
+
+/** @internal */
+export const GetSubstationDFESResponseBody$inboundSchema: z.ZodType<
+  GetSubstationDFESResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => GetSubstationDFESDFESForecast$inboundSchema)),
+  has_more: z.boolean(),
+  object: GetSubstationDFESObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function getSubstationDFESResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubstationDFESResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetSubstationDFESResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubstationDFESResponseBody' from JSON`,
+  );
+}

package/src/sdk/models/operations/getv1safetycrimestats.ts

@@ -14,7 +14,7 @@ export type GetV1SafetyCrimeStatsRequest = {
    */
   longitude: string;
   /**
-   * Number of months to analyse
+   * Number of months to analyse (1-36)
    */
   months?: string | undefined;
   /**

package/src/sdk/models/operations/index.ts

@@ -6,8 +6,10 @@ export * from "./checkareareferencehealth.js";
 export * from "./checkavmhealth.js";
 export * from "./checkepchealth.js";
 export * from "./checklistingshealth.js";
+export * from "./findnearestsubstations.js";
 export * from "./findsitesbypoint.js";
 export * from "./findsitesbyproperty.js";
+export * from "./findsupplyareabypoint.js";
 export * from "./getareacoverage.js";
 export * from "./getareasbyfieldandids.js";
 export * from "./getareaswithinradius.js";
@@ -17,8 +19,11 @@ export * from "./getcompaniesbylocation.js";
 export * from "./getcompany.js";
 export * from "./getcompanyofficers.js";
 export * from "./getcompanypscs.js";
+export * from "./getconnectionqueuebysubstation.js";
+export * from "./getconnectionqueueentry.js";
 export * from "./getconnectivityscores.js";
 export * from "./getcouncilbyproviderid.js";
+export * from "./getenergyforproperty.js";
 export * from "./getepcbylocationid.js";
 export * from "./getlistingbyid.js";
 export * from "./getlistingbysource.js";
@@ -47,6 +52,9 @@ export * from "./getschoolbyurn.js";
 export * from "./getschoolmetrics.js";
 export * from "./getsitebyid.js";
 export * from "./getsitetiles.js";
+export * from "./getsubstationbycode.js";
+export * from "./getsubstationcapacity.js";
+export * from "./getsubstationdfes.js";
 export * from "./getv1safetycrime.js";
 export * from "./getv1safetycrimestats.js";
 export * from "./getv1titledeedstitlenumberdocuments.js";
@@ -61,8 +69,11 @@ export * from "./querylistings.js";
 export * from "./querylistingsbysource.js";
 export * from "./resolveaddress.js";
 export * from "./reversegeocode.js";
+export * from "./searchconnectionqueue.js";
+export * from "./searchecr.js";
 export * from "./searchplanningpolicy.js";
 export * from "./searchschoolsnearby.js";
 export * from "./searchschoolswithin.js";
+export * from "./searchsubstations.js";
 export * from "./searchsuggest.js";
 export * from "./validatepostcode.js";