@vepler/sdk 2.39.0 → 2.45.0

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

@@ -0,0 +1,452 @@
+/*
+ * 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 SearchConnectionQueueConnectionQueueSearchInput = {
+  /**
+   * Filter by connection status
+   */
+  connectionStatus?: string | undefined;
+  /**
+   * Filter by country code
+   */
+  country?: string | undefined;
+  /**
+   * Maximum number of results to return
+   */
+  limit?: number | undefined;
+  /**
+   * Maximum capacity in MW
+   */
+  maxCapacityMw?: number | null | undefined;
+  /**
+   * Minimum capacity in MW
+   */
+  minCapacityMw?: number | null | undefined;
+  /**
+   * Filter by network level
+   */
+  networkLevel?: string | undefined;
+  /**
+   * Number of results to skip for pagination
+   */
+  offset?: number | null | undefined;
+  /**
+   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   */
+  operator?: string | undefined;
+  /**
+   * Filter by source dataset
+   */
+  sourceDataset?: string | undefined;
+  /**
+   * Filter by resolved substation code
+   */
+  substationCode?: string | undefined;
+  /**
+   * Filter by technology category
+   */
+  technologyCategory?: string | undefined;
+  /**
+   * Filter by technology type
+   */
+  technologyType?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type SearchConnectionQueueCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchConnectionQueueEnergyObject = {
+  ConnectionQueueEntry: "connection_queue_entry",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchConnectionQueueEnergyObject = ClosedEnum<
+  typeof SearchConnectionQueueEnergyObject
+>;
+
+/**
+ * A technology component of a multi-technology connection queue entry
+ */
+export type SearchConnectionQueueConnectionQueueTechnology = {
+  /**
+   * Capacity allocated to this technology, in megawatts (MW)
+   */
+  capacityMw: number | null;
+  /**
+   * Whether this is the primary technology for the project
+   */
+  isPrimary: boolean;
+  /**
+   * Technology grouping (generation, storage, thermal, demand, infrastructure, other)
+   */
+  technologyCategory: string | null;
+  /**
+   * Canonical technology type from the shared taxonomy
+   */
+  technologyType: string;
+};
+
+/**
+ * An entry from the national grid connection queue — representing a project awaiting or holding a connection agreement to the electricity network. Covers both transmission (TEC Register) and distribution (Embedded Register) connections
+ */
+export type SearchConnectionQueueConnectionQueueEntry = {
+  /**
+   * Date the connection offer was accepted (ISO 8601)
+   */
+  acceptanceDate: string | null;
+  /**
+   * Date the connection application was submitted (ISO 8601)
+   */
+  applicationDate: string | null;
+  /**
+   * Total connection capacity, in megawatts (MW)
+   */
+  capacityMw: number | null;
+  /**
+   * Agreed or expected connection date (ISO 8601)
+   */
+  connectionDate: string | null;
+  /**
+   * Raw connection site name from the source register
+   */
+  connectionSite: string | null;
+  /**
+   * Canonical connection lifecycle status
+   */
+  connectionStatus: string | null;
+  /**
+   * ISO 3166-1 alpha-2 country code
+   */
+  country: string;
+  /**
+   * Cumulative capacity of all projects ahead in the queue, in megawatts (MW)
+   */
+  cumulativeCapacityMw: number | null;
+  /**
+   * Name of the connecting customer or developer
+   */
+  customerName: string | null;
+  /**
+   * Maximum export capacity, in megawatts (MW)
+   */
+  exportCapacityMw: number | null;
+  /**
+   * Maximum import capacity, in megawatts (MW)
+   */
+  importCapacityMw: number | null;
+  /**
+   * WGS84 coordinate pair
+   */
+  location: SearchConnectionQueueCoordinates | null;
+  /**
+   * Network voltage level: transmission, distribution, or interconnector
+   */
+  networkLevel: string | null;
+  /**
+   * Object type identifier
+   */
+  object: SearchConnectionQueueEnergyObject;
+  /**
+   * Date the connection offer was made (ISO 8601)
+   */
+  offerDate: string | null;
+  /**
+   * Licence area or operating region
+   */
+  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;
+  /**
+   * Unique project identifier from the source register
+   */
+  projectId: string;
+  /**
+   * Human-readable project name
+   */
+  projectName: string | null;
+  /**
+   * Secondary project reference number
+   */
+  projectNumber: string | null;
+  /**
+   * Position in the connection queue, if available
+   */
+  queuePosition: number | null;
+  /**
+   * Source register identifier (e.g. neso_tec, neso_embedded)
+   */
+  sourceDataset: string;
+  /**
+   * Code of the resolved substation, if matched
+   */
+  substationCode: string | null;
+  /**
+   * All technology components for multi-technology projects
+   */
+  technologies?:
+    | Array<SearchConnectionQueueConnectionQueueTechnology>
+    | undefined;
+  /**
+   * Primary technology category
+   */
+  technologyCategory: string | null;
+  /**
+   * Primary canonical technology type
+   */
+  technologyType: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const SearchConnectionQueueObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type SearchConnectionQueueObject = ClosedEnum<
+  typeof SearchConnectionQueueObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type SearchConnectionQueueResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<SearchConnectionQueueConnectionQueueEntry>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: SearchConnectionQueueObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type SearchConnectionQueueConnectionQueueSearchInput$Outbound = {
+  connectionStatus?: string | undefined;
+  country?: string | undefined;
+  limit: number;
+  maxCapacityMw?: number | null | undefined;
+  minCapacityMw?: number | null | undefined;
+  networkLevel?: string | undefined;
+  offset: number | null;
+  operator?: string | undefined;
+  sourceDataset?: string | undefined;
+  substationCode?: string | undefined;
+  technologyCategory?: string | undefined;
+  technologyType?: string | undefined;
+};
+
+/** @internal */
+export const SearchConnectionQueueConnectionQueueSearchInput$outboundSchema:
+  z.ZodType<
+    SearchConnectionQueueConnectionQueueSearchInput$Outbound,
+    z.ZodTypeDef,
+    SearchConnectionQueueConnectionQueueSearchInput
+  > = z.object({
+    connectionStatus: z.string().optional(),
+    country: z.string().optional(),
+    limit: z.number().default(100),
+    maxCapacityMw: z.nullable(z.number()).optional(),
+    minCapacityMw: z.nullable(z.number()).optional(),
+    networkLevel: z.string().optional(),
+    offset: z.nullable(z.number().default(0)),
+    operator: z.string().optional(),
+    sourceDataset: z.string().optional(),
+    substationCode: z.string().optional(),
+    technologyCategory: z.string().optional(),
+    technologyType: z.string().optional(),
+  });
+
+export function searchConnectionQueueConnectionQueueSearchInputToJSON(
+  searchConnectionQueueConnectionQueueSearchInput:
+    SearchConnectionQueueConnectionQueueSearchInput,
+): string {
+  return JSON.stringify(
+    SearchConnectionQueueConnectionQueueSearchInput$outboundSchema.parse(
+      searchConnectionQueueConnectionQueueSearchInput,
+    ),
+  );
+}
+
+/** @internal */
+export const SearchConnectionQueueCoordinates$inboundSchema: z.ZodType<
+  SearchConnectionQueueCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function searchConnectionQueueCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchConnectionQueueCoordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchConnectionQueueCoordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchConnectionQueueCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchConnectionQueueEnergyObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchConnectionQueueEnergyObject
+> = z.nativeEnum(SearchConnectionQueueEnergyObject);
+
+/** @internal */
+export const SearchConnectionQueueConnectionQueueTechnology$inboundSchema:
+  z.ZodType<
+    SearchConnectionQueueConnectionQueueTechnology,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    capacityMw: z.nullable(z.number()),
+    isPrimary: z.boolean(),
+    technologyCategory: z.nullable(z.string()),
+    technologyType: z.string(),
+  });
+
+export function searchConnectionQueueConnectionQueueTechnologyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SearchConnectionQueueConnectionQueueTechnology,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchConnectionQueueConnectionQueueTechnology$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SearchConnectionQueueConnectionQueueTechnology' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchConnectionQueueConnectionQueueEntry$inboundSchema: z.ZodType<
+  SearchConnectionQueueConnectionQueueEntry,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  acceptanceDate: z.nullable(z.string()),
+  applicationDate: z.nullable(z.string()),
+  capacityMw: z.nullable(z.number()),
+  connectionDate: z.nullable(z.string()),
+  connectionSite: z.nullable(z.string()),
+  connectionStatus: z.nullable(z.string()),
+  country: z.string(),
+  cumulativeCapacityMw: z.nullable(z.number()),
+  customerName: z.nullable(z.string()),
+  exportCapacityMw: z.nullable(z.number()),
+  importCapacityMw: z.nullable(z.number()),
+  location: z.nullable(
+    z.lazy(() => SearchConnectionQueueCoordinates$inboundSchema),
+  ),
+  networkLevel: z.nullable(z.string()),
+  object: SearchConnectionQueueEnergyObject$inboundSchema,
+  offerDate: z.nullable(z.string()),
+  operatingRegion: z.nullable(z.string()),
+  operator: z.string(),
+  projectId: z.string(),
+  projectName: z.nullable(z.string()),
+  projectNumber: z.nullable(z.string()),
+  queuePosition: z.nullable(z.number()),
+  sourceDataset: z.string(),
+  substationCode: z.nullable(z.string()),
+  technologies: z.array(
+    z.lazy(() => SearchConnectionQueueConnectionQueueTechnology$inboundSchema),
+  ).optional(),
+  technologyCategory: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+});
+
+export function searchConnectionQueueConnectionQueueEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  SearchConnectionQueueConnectionQueueEntry,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      SearchConnectionQueueConnectionQueueEntry$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'SearchConnectionQueueConnectionQueueEntry' from JSON`,
+  );
+}
+
+/** @internal */
+export const SearchConnectionQueueObject$inboundSchema: z.ZodNativeEnum<
+  typeof SearchConnectionQueueObject
+> = z.nativeEnum(SearchConnectionQueueObject);
+
+/** @internal */
+export const SearchConnectionQueueResponseBody$inboundSchema: z.ZodType<
+  SearchConnectionQueueResponseBody,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(
+    z.lazy(() => SearchConnectionQueueConnectionQueueEntry$inboundSchema),
+  ),
+  has_more: z.boolean(),
+  object: SearchConnectionQueueObject$inboundSchema,
+  total_count: z.number().optional(),
+  url: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "has_more": "hasMore",
+    "total_count": "totalCount",
+  });
+});
+
+export function searchConnectionQueueResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<SearchConnectionQueueResponseBody, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SearchConnectionQueueResponseBody$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SearchConnectionQueueResponseBody' from JSON`,
+  );
+}