@vepler/sdk 2.42.0 → 2.46.0

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

@@ -0,0 +1,284 @@
+/*
+ * 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 SearchECRRequest = {
+  /**
+   * Filter by connection lifecycle status (e.g. connected, accepted, contracted, in_scoping)
+   */
+  connectionStatus?: string | undefined;
+  /**
+   * Filter by country (ISO 3166-1 alpha-2)
+   */
+  country?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: number | null | undefined;
+  /**
+   * Filter by operating region name
+   */
+  operatingRegion?: string | undefined;
+  /**
+   * Filter by network operator code
+   */
+  operator?: string | undefined;
+  /**
+   * Filter by technology type (e.g. solar, wind, battery)
+   */
+  technologyType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchECRCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchECREnergyObject = {
+  EcrEntry: "ecr_entry",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchECREnergyObject = ClosedEnum<typeof SearchECREnergyObject>;
+
+/**
+ * An entry from the Embedded Capacity Register (ECR) — a public record of all generation and storage connections to the distribution network
+ */
+export type SearchECRECREntry = {
+  /**
+   * Unique identifier for this ECR entry
+   */
+  code: string;
+  /**
+   * Date the connection was made or is expected (ISO 8601)
+   */
+  connectionDate: string | null;
+  /**
+   * Lifecycle status of a generation/storage connection. Known values: 'connected', 'accepted', 'contracted', 'in_scoping'. 'connected' is live and exporting. 'accepted' has a formal connection offer accepted. 'contracted' is under contract but not yet connected. 'in_scoping' is in early feasibility assessment. Different regulatory frameworks may define additional statuses.
+   */
+  connectionStatus: string | null;
+  /**
+   * Category of an embedded capacity register connection. Known values: 'generation', 'storage', 'generation_and_storage'. 'generation' covers solar, wind, gas, biomass, etc. 'storage' covers batteries. 'generation_and_storage' covers co-located sites. New types can be added as technologies evolve (e.g. hydrogen electrolysis, V2G).
+   */
+  connectionType: string | null;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Maximum export capacity agreed with the network operator, in megawatts (MW)
+   */
+  exportCapacityMw: number | null;
+  /**
+   * Total installed capacity of the connection, in megawatts (MW)
+   */
+  installedCapacityMw: number | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  location: SearchECRCoordinates | null;
+  /**
+   * Object type identifier
+   */
+  object: SearchECREnergyObject;
+  /**
+   * Operating region where this connection is located
+   */
+  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 this connection is registered against
+   */
+  substationCode: string | null;
+  /**
+   * Technology used for generation or storage (e.g. solar, wind, battery, gas, biomass)
+   */
+  technologyType: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchECRObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchECRObject = ClosedEnum<typeof SearchECRObject>;
+
+/**
+ * Paginated list response
+ */
+export type SearchECRResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SearchECRECREntry>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: SearchECRObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type SearchECRRequest$Outbound = {
+  connectionStatus?: string | undefined;
+  country?: string | undefined;
+  limit: number;
+  offset: number | null;
+  operatingRegion?: string | undefined;
+  operator?: string | undefined;
+  technologyType?: string | undefined;
+};
+
+/** @internal */
+export const SearchECRRequest$outboundSchema: z.ZodType<
+  SearchECRRequest$Outbound,
+  z.ZodTypeDef,
+  SearchECRRequest
+> = z.object({
+  connectionStatus: z.string().optional(),
+  country: z.string().optional(),
+  limit: z.number().default(100),
+  offset: z.nullable(z.number().default(0)),
+  operatingRegion: z.string().optional(),
+  operator: z.string().optional(),
+  technologyType: z.string().optional(),
+});
+
+export function searchECRRequestToJSON(
+  searchECRRequest: SearchECRRequest,
+): string {
+  return JSON.stringify(
+    SearchECRRequest$outboundSchema.parse(searchECRRequest),
+  );
+}
+
+/** @internal */
+export const SearchECRCoordinates$inboundSchema: z.ZodType<
+  SearchECRCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchECRCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchECREnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchECREnergyObject
+> = z.nativeEnum(SearchECREnergyObject);
+
+/** @internal */
+export const SearchECRECREntry$inboundSchema: z.ZodType<
+  SearchECRECREntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  code: z.string(),
+  connectionDate: z.nullable(z.string()),
+  connectionStatus: z.nullable(z.string()),
+  connectionType: z.nullable(z.string()),
+  country: z.string(),
+  exportCapacityMw: z.nullable(z.number()),
+  installedCapacityMw: z.nullable(z.number()),
+  location: z.nullable(z.lazy(() => SearchECRCoordinates$inboundSchema)),
+  object: SearchECREnergyObject$inboundSchema,
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  substationCode: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+});
+
+export function searchECRECREntryFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRECREntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRECREntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRECREntry' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchECRObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchECRObject
+> = z.nativeEnum(SearchECRObject);
+
+/** @internal */
+export const SearchECRResponseBody$inboundSchema: z.ZodType<
+  SearchECRResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => SearchECRECREntry$inboundSchema)),
+  has_more: z.boolean(),
+  object: SearchECRObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function searchECRResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchECRResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchECRResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchECRResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,320 @@
+/*
+ * 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 SearchSubstationsSearchSubstationsInput = {
+  /**
+   * Filter by country code
+   */
+  country?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+  /**
+   * Maximum demand headroom in MW
+   */
+  maxDemandHeadroomMw?: number | null | undefined;
+  /**
+   * Minimum demand headroom in MW
+   */
+  minDemandHeadroomMw?: number | null | undefined;
+  /**
+   * Minimum generation headroom in MW
+   */
+  minGenerationHeadroomMw?: number | null | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: number | null | undefined;
+  /**
+   * Filter by operating region name
+   */
+  operatingRegion?: string | undefined;
+  /**
+   * Filter by network operator code
+   */
+  operator?: string | undefined;
+  /**
+   * Filter by substation type
+   */
+  substationType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchSubstationsCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchSubstationsEnergyObject = {
+  Substation: "substation",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsEnergyObject = ClosedEnum<
+  typeof SearchSubstationsEnergyObject
+>;
+
+/**
+ * A network operator substation with its current capacity and headroom data
+ */
+export type SearchSubstationsSubstation = {
+  /**
+   * 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: SearchSubstationsCoordinates | null;
+  /**
+   * Human-readable substation name, where available
+   */
+  name: string | null;
+  /**
+   * Object type identifier
+   */
+  object: SearchSubstationsEnergyObject;
+  /**
+   * 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 SearchSubstationsObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchSubstationsObject = ClosedEnum<
+  typeof SearchSubstationsObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type SearchSubstationsResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SearchSubstationsSubstation>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: SearchSubstationsObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type SearchSubstationsSearchSubstationsInput$Outbound = {
+  country?: string | undefined;
+  limit: number;
+  maxDemandHeadroomMw?: number | null | undefined;
+  minDemandHeadroomMw?: number | null | undefined;
+  minGenerationHeadroomMw?: number | null | undefined;
+  offset: number | null;
+  operatingRegion?: string | undefined;
+  operator?: string | undefined;
+  substationType?: string | undefined;
+};
+
+/** @internal */
+export const SearchSubstationsSearchSubstationsInput$outboundSchema: z.ZodType<
+  SearchSubstationsSearchSubstationsInput$Outbound,
+  z.ZodTypeDef,
+  SearchSubstationsSearchSubstationsInput
+> = z.object({
+  country: z.string().optional(),
+  limit: z.number().default(100),
+  maxDemandHeadroomMw: z.nullable(z.number()).optional(),
+  minDemandHeadroomMw: z.nullable(z.number()).optional(),
+  minGenerationHeadroomMw: z.nullable(z.number()).optional(),
+  offset: z.nullable(z.number().default(0)),
+  operatingRegion: z.string().optional(),
+  operator: z.string().optional(),
+  substationType: z.string().optional(),
+});
+
+export function searchSubstationsSearchSubstationsInputToJSON(
+  searchSubstationsSearchSubstationsInput:
+    SearchSubstationsSearchSubstationsInput,
+): string {
+  return JSON.stringify(
+    SearchSubstationsSearchSubstationsInput$outboundSchema.parse(
+      searchSubstationsSearchSubstationsInput,
+    ),
+  );
+}
+
+/** @internal */
+export const SearchSubstationsCoordinates$inboundSchema: z.ZodType<
+  SearchSubstationsCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchSubstationsCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSubstationsEnergyObject
+> = z.nativeEnum(SearchSubstationsEnergyObject);
+
+/** @internal */
+export const SearchSubstationsSubstation$inboundSchema: z.ZodType<
+  SearchSubstationsSubstation,
+  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(() => SearchSubstationsCoordinates$inboundSchema),
+  ),
+  name: z.nullable(z.string()),
+  object: SearchSubstationsEnergyObject$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 searchSubstationsSubstationFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsSubstation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsSubstation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsSubstation' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchSubstationsObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchSubstationsObject
+> = z.nativeEnum(SearchSubstationsObject);
+
+/** @internal */
+export const SearchSubstationsResponseBody$inboundSchema: z.ZodType<
+  SearchSubstationsResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(z.lazy(() => SearchSubstationsSubstation$inboundSchema)),
+  has_more: z.boolean(),
+  object: SearchSubstationsObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function searchSubstationsResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchSubstationsResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchSubstationsResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchSubstationsResponseBody' from JSON`,
+  );
+}

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

@@ -3,8 +3,26 @@
  */
 
 import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export const Classification = {
+  Residential: "residential",
+  Commercial: "commercial",
+  All: "all",
+} as const;
+/**
+ * Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+ */
+export type Classification = ClosedEnum<typeof Classification>;
 
 export type SearchSuggestRequest = {
+  /**
+   * Filter address results by property classification. 'residential': dwellings including houses, flats, and HMOs. 'commercial': non-residential premises such as offices, retail, and warehouses. 'all': no filter — returns all address types. Defaults to 'residential'.
+   */
+  classification?: Classification | undefined;
   /**
    * Maximum number of results (1-100)
    */
@@ -23,8 +41,14 @@ export type SearchSuggestRequest = {
   source?: string | undefined;
 };
 
+/** @internal */
+export const Classification$outboundSchema: z.ZodNativeEnum<
+  typeof Classification
+> = z.nativeEnum(Classification);
+
 /** @internal */
 export type SearchSuggestRequest$Outbound = {
+  classification?: string | undefined;
   limit?: string | undefined;
   offset?: string | undefined;
   q: string;
@@ -37,6 +61,7 @@ export const SearchSuggestRequest$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SearchSuggestRequest
 > = z.object({
+  classification: Classification$outboundSchema.optional(),
   limit: z.string().optional(),
   offset: z.string().optional(),
   q: z.string(),