@vepler/sdk 2.42.0 → 2.45.0

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

@@ -0,0 +1,302 @@
+/*
+ * 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 FindNearestSubstationsRequest = {
+  /**
+   * Filter by country (ISO 3166-1 alpha-2)
+   */
+  country?: string | undefined;
+  /**
+   * Latitude of the search point (WGS84)
+   */
+  lat?: number | null | undefined;
+  /**
+   * Maximum number of substations to return
+   */
+  limit?: number | undefined;
+  /**
+   * Longitude of the search point (WGS84)
+   */
+  lon?: number | null | undefined;
+  /**
+   * Search radius in kilometres
+   */
+  radius?: number | undefined;
+  /**
+   * Only return substations of this type
+   */
+  substationType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type FindNearestSubstationsCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const FindNearestSubstationsEnergyObject = {
+  Substation: "substation",
+} as const;
+/**
+ * Object type identifier
+ */
+export type FindNearestSubstationsEnergyObject = ClosedEnum<
+  typeof FindNearestSubstationsEnergyObject
+>;
+
+/**
+ * A network operator substation with its current capacity and headroom data
+ */
+export type Substation = {
+  /**
+   * 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: FindNearestSubstationsCoordinates | null;
+  /**
+   * Human-readable substation name, where available
+   */
+  name: string | null;
+  /**
+   * Object type identifier
+   */
+  object: FindNearestSubstationsEnergyObject;
+  /**
+   * 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;
+};
+
+/**
+ * Object type identifier
+ */
+export const FindNearestSubstationsObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type FindNearestSubstationsObject = ClosedEnum<
+  typeof FindNearestSubstationsObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type FindNearestSubstationsResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<Substation>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: FindNearestSubstationsObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type FindNearestSubstationsRequest$Outbound = {
+  country?: string | undefined;
+  lat?: number | null | undefined;
+  limit: number;
+  lon?: number | null | undefined;
+  radius: number;
+  substationType?: string | undefined;
+};
+
+/** @internal */
+export const FindNearestSubstationsRequest$outboundSchema: z.ZodType<
+  FindNearestSubstationsRequest$Outbound,
+  z.ZodTypeDef,
+  FindNearestSubstationsRequest
+> = z.object({
+  country: z.string().optional(),
+  lat: z.nullable(z.number()).optional(),
+  limit: z.number().default(10),
+  lon: z.nullable(z.number()).optional(),
+  radius: z.number().default(5),
+  substationType: z.string().optional(),
+});
+
+export function findNearestSubstationsRequestToJSON(
+  findNearestSubstationsRequest: FindNearestSubstationsRequest,
+): string {
+  return JSON.stringify(
+    FindNearestSubstationsRequest$outboundSchema.parse(
+      findNearestSubstationsRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsCoordinates$inboundSchema: z.ZodType<
+  FindNearestSubstationsCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function findNearestSubstationsCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<FindNearestSubstationsCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindNearestSubstationsCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindNearestSubstationsCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof FindNearestSubstationsEnergyObject
+> = z.nativeEnum(FindNearestSubstationsEnergyObject);
+
+/** @internal */
+export const Substation$inboundSchema: z.ZodType<
+  Substation,
+  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(() => FindNearestSubstationsCoordinates$inboundSchema),
+  ),
+  name: z.nullable(z.string()),
+  object: FindNearestSubstationsEnergyObject$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 substationFromJSON(
+  jsonString: string,
+): SafeParseResult<Substation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Substation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Substation' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindNearestSubstationsObject$inboundSchema: z.ZodNativeEnum<
+  typeof FindNearestSubstationsObject
+> = z.nativeEnum(FindNearestSubstationsObject);
+
+/** @internal */
+export const FindNearestSubstationsResponseBody$inboundSchema: z.ZodType<
+  FindNearestSubstationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => Substation$inboundSchema)),
+  has_more: z.boolean(),
+  object: FindNearestSubstationsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function findNearestSubstationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<FindNearestSubstationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      FindNearestSubstationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindNearestSubstationsResponseBody' from JSON`,
+  );
+}

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

@@ -5,9 +5,6 @@
 import * as z from "zod/v3";
 
 export type FindSitesByPropertyRequest = {
-  /**
-   * Property location identifier
-   */
   locationId: string;
 };
 

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

@@ -0,0 +1,247 @@
+/*
+ * 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 FindSupplyAreaByPointRequest = {
+  /**
+   * Latitude of the query point (WGS84)
+   */
+  lat?: number | null | undefined;
+  /**
+   * Longitude of the query point (WGS84)
+   */
+  lon?: number | null | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type FindSupplyAreaByPointCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const FindSupplyAreaByPointEnergyObject = {
+  SupplyArea: "supply_area",
+} as const;
+/**
+ * Object type identifier
+ */
+export type FindSupplyAreaByPointEnergyObject = ClosedEnum<
+  typeof FindSupplyAreaByPointEnergyObject
+>;
+
+/**
+ * A geographic boundary defining the area served by a specific substation
+ */
+export type SupplyArea = {
+  /**
+   * Area of the supply boundary in square kilometres
+   */
+  areaSqkm: number | null;
+  /**
+   * Classification of supply area boundary. Each type corresponds to a level in the network hierarchy. Known values: 'gsp', 'bsp', 'grid', 'primary', 'distribution'. 'distribution' is the most granular, 'gsp' (Grid Supply Point) is the broadest.
+   */
+  areaType: string | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  centroid: FindSupplyAreaByPointCoordinates | null;
+  /**
+   * Unique supply area identifier, prefixed with the operator code
+   */
+  code: string;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Human-readable supply area name, where available
+   */
+  name: string | null;
+  /**
+   * Object type identifier
+   */
+  object: FindSupplyAreaByPointEnergyObject;
+  /**
+   * Operating region name
+   */
+  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 substation that serves this supply area
+   */
+  substationCode: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const FindSupplyAreaByPointObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type FindSupplyAreaByPointObject = ClosedEnum<
+  typeof FindSupplyAreaByPointObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type FindSupplyAreaByPointResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SupplyArea>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: FindSupplyAreaByPointObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type FindSupplyAreaByPointRequest$Outbound = {
+  lat?: number | null | undefined;
+  lon?: number | null | undefined;
+};
+
+/** @internal */
+export const FindSupplyAreaByPointRequest$outboundSchema: z.ZodType<
+  FindSupplyAreaByPointRequest$Outbound,
+  z.ZodTypeDef,
+  FindSupplyAreaByPointRequest
+> = z.object({
+  lat: z.nullable(z.number()).optional(),
+  lon: z.nullable(z.number()).optional(),
+});
+
+export function findSupplyAreaByPointRequestToJSON(
+  findSupplyAreaByPointRequest: FindSupplyAreaByPointRequest,
+): string {
+  return JSON.stringify(
+    FindSupplyAreaByPointRequest$outboundSchema.parse(
+      findSupplyAreaByPointRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const FindSupplyAreaByPointCoordinates$inboundSchema: z.ZodType<
+  FindSupplyAreaByPointCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function findSupplyAreaByPointCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSupplyAreaByPointCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSupplyAreaByPointCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSupplyAreaByPointCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSupplyAreaByPointEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof FindSupplyAreaByPointEnergyObject
+> = z.nativeEnum(FindSupplyAreaByPointEnergyObject);
+
+/** @internal */
+export const SupplyArea$inboundSchema: z.ZodType<
+  SupplyArea,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  areaSqkm: z.nullable(z.number()),
+  areaType: z.nullable(z.string()),
+  centroid: z.nullable(
+    z.lazy(() => FindSupplyAreaByPointCoordinates$inboundSchema),
+  ),
+  code: z.string(),
+  country: z.string(),
+  name: z.nullable(z.string()),
+  object: FindSupplyAreaByPointEnergyObject$inboundSchema,
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  substationCode: z.nullable(z.string()),
+});
+
+export function supplyAreaFromJSON(
+  jsonString: string,
+): SafeParseResult<SupplyArea, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SupplyArea$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SupplyArea' from JSON`,
+  );
+}
+
+/** @internal */
+export const FindSupplyAreaByPointObject$inboundSchema: z.ZodNativeEnum<
+  typeof FindSupplyAreaByPointObject
+> = z.nativeEnum(FindSupplyAreaByPointObject);
+
+/** @internal */
+export const FindSupplyAreaByPointResponseBody$inboundSchema: z.ZodType<
+  FindSupplyAreaByPointResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => SupplyArea$inboundSchema)),
+  has_more: z.boolean(),
+  object: FindSupplyAreaByPointObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function findSupplyAreaByPointResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<FindSupplyAreaByPointResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FindSupplyAreaByPointResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FindSupplyAreaByPointResponseBody' from JSON`,
+  );
+}

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

@@ -5,9 +5,6 @@
 import * as z from "zod/v3";
 
 export type GetCompaniesByLocationRequest = {
-  /**
-   * UPRN (Unique Property Reference Number) -- a numeric identifier assigned to every addressable location in Great Britain by the Ordnance Survey. Used to find all companies registered at a specific property.
-   */
   locationId: string;
 };