@vepler/sdk 2.42.0 → 2.45.0

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

@@ -0,0 +1,385 @@
+/*
+ * 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 GetConnectionQueueBySubstationRequest = {
+  code: string;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type GetConnectionQueueBySubstationCoordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetConnectionQueueBySubstationEnergyObject = {
+  ConnectionQueueEntry: "connection_queue_entry",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetConnectionQueueBySubstationEnergyObject = ClosedEnum<
+  typeof GetConnectionQueueBySubstationEnergyObject
+>;
+
+/**
+ * A technology component of a multi-technology connection queue entry
+ */
+export type GetConnectionQueueBySubstationConnectionQueueTechnology = {
+  /**
+   * 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 ConnectionQueueEntry = {
+  /**
+   * 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: GetConnectionQueueBySubstationCoordinates | null;
+  /**
+   * Network voltage level: transmission, distribution, or interconnector
+   */
+  networkLevel: string | null;
+  /**
+   * Object type identifier
+   */
+  object: GetConnectionQueueBySubstationEnergyObject;
+  /**
+   * 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<GetConnectionQueueBySubstationConnectionQueueTechnology>
+    | undefined;
+  /**
+   * Primary technology category
+   */
+  technologyCategory: string | null;
+  /**
+   * Primary canonical technology type
+   */
+  technologyType: string | null;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetConnectionQueueBySubstationObject = {
+  List: "list",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetConnectionQueueBySubstationObject = ClosedEnum<
+  typeof GetConnectionQueueBySubstationObject
+>;
+
+/**
+ * Paginated list response
+ */
+export type GetConnectionQueueBySubstationResponseBody = {
+  /**
+   * Array of items
+   */
+  data: Array<ConnectionQueueEntry>;
+  /**
+   * Whether more items exist
+   */
+  hasMore: boolean;
+  /**
+   * Object type identifier
+   */
+  object: GetConnectionQueueBySubstationObject;
+  /**
+   * Total number of items available
+   */
+  totalCount?: number | undefined;
+  /**
+   * URL of the request
+   */
+  url: string;
+};
+
+/** @internal */
+export type GetConnectionQueueBySubstationRequest$Outbound = {
+  code: string;
+};
+
+/** @internal */
+export const GetConnectionQueueBySubstationRequest$outboundSchema: z.ZodType<
+  GetConnectionQueueBySubstationRequest$Outbound,
+  z.ZodTypeDef,
+  GetConnectionQueueBySubstationRequest
+> = z.object({
+  code: z.string(),
+});
+
+export function getConnectionQueueBySubstationRequestToJSON(
+  getConnectionQueueBySubstationRequest: GetConnectionQueueBySubstationRequest,
+): string {
+  return JSON.stringify(
+    GetConnectionQueueBySubstationRequest$outboundSchema.parse(
+      getConnectionQueueBySubstationRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const GetConnectionQueueBySubstationCoordinates$inboundSchema: z.ZodType<
+  GetConnectionQueueBySubstationCoordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function getConnectionQueueBySubstationCoordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConnectionQueueBySubstationCoordinates,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConnectionQueueBySubstationCoordinates$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetConnectionQueueBySubstationCoordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConnectionQueueBySubstationEnergyObject$inboundSchema:
+  z.ZodNativeEnum<typeof GetConnectionQueueBySubstationEnergyObject> = z
+    .nativeEnum(GetConnectionQueueBySubstationEnergyObject);
+
+/** @internal */
+export const GetConnectionQueueBySubstationConnectionQueueTechnology$inboundSchema:
+  z.ZodType<
+    GetConnectionQueueBySubstationConnectionQueueTechnology,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({
+    capacityMw: z.nullable(z.number()),
+    isPrimary: z.boolean(),
+    technologyCategory: z.nullable(z.string()),
+    technologyType: z.string(),
+  });
+
+export function getConnectionQueueBySubstationConnectionQueueTechnologyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConnectionQueueBySubstationConnectionQueueTechnology,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConnectionQueueBySubstationConnectionQueueTechnology$inboundSchema
+        .parse(JSON.parse(x)),
+    `Failed to parse 'GetConnectionQueueBySubstationConnectionQueueTechnology' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConnectionQueueEntry$inboundSchema: z.ZodType<
+  ConnectionQueueEntry,
+  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(() => GetConnectionQueueBySubstationCoordinates$inboundSchema),
+  ),
+  networkLevel: z.nullable(z.string()),
+  object: GetConnectionQueueBySubstationEnergyObject$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(() =>
+      GetConnectionQueueBySubstationConnectionQueueTechnology$inboundSchema
+    ),
+  ).optional(),
+  technologyCategory: z.nullable(z.string()),
+  technologyType: z.nullable(z.string()),
+});
+
+export function connectionQueueEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectionQueueEntry, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectionQueueEntry$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectionQueueEntry' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConnectionQueueBySubstationObject$inboundSchema:
+  z.ZodNativeEnum<typeof GetConnectionQueueBySubstationObject> = z.nativeEnum(
+    GetConnectionQueueBySubstationObject,
+  );
+
+/** @internal */
+export const GetConnectionQueueBySubstationResponseBody$inboundSchema:
+  z.ZodType<GetConnectionQueueBySubstationResponseBody, z.ZodTypeDef, unknown> =
+    z.object({
+      data: z.array(z.lazy(() => ConnectionQueueEntry$inboundSchema)),
+      has_more: z.boolean(),
+      object: GetConnectionQueueBySubstationObject$inboundSchema,
+      total_count: z.number().optional(),
+      url: z.string(),
+    }).transform((v) => {
+      return remap$(v, {
+        "has_more": "hasMore",
+        "total_count": "totalCount",
+      });
+    });
+
+export function getConnectionQueueBySubstationResponseBodyFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConnectionQueueBySubstationResponseBody,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConnectionQueueBySubstationResponseBody$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetConnectionQueueBySubstationResponseBody' from JSON`,
+  );
+}

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

@@ -0,0 +1,301 @@
+/*
+ * 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 GetConnectionQueueEntryRequest = {
+  projectId: string;
+  /**
+   * Source register to disambiguate (e.g. neso_tec, neso_embedded)
+   */
+  sourceDataset?: string | undefined;
+};
+
+/**
+ * WGS84 coordinate pair
+ */
+export type Coordinates = {
+  /**
+   * Latitude in decimal degrees
+   */
+  lat: number;
+  /**
+   * Longitude in decimal degrees
+   */
+  lng: number;
+};
+
+/**
+ * Object type identifier
+ */
+export const GetConnectionQueueEntryObject = {
+  ConnectionQueueEntry: "connection_queue_entry",
+} as const;
+/**
+ * Object type identifier
+ */
+export type GetConnectionQueueEntryObject = ClosedEnum<
+  typeof GetConnectionQueueEntryObject
+>;
+
+/**
+ * A technology component of a multi-technology connection queue entry
+ */
+export type ConnectionQueueTechnology = {
+  /**
+   * 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 GetConnectionQueueEntryConnectionQueueEntry = {
+  /**
+   * 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: Coordinates | null;
+  /**
+   * Network voltage level: transmission, distribution, or interconnector
+   */
+  networkLevel: string | null;
+  /**
+   * Object type identifier
+   */
+  object: GetConnectionQueueEntryObject;
+  /**
+   * 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<ConnectionQueueTechnology> | undefined;
+  /**
+   * Primary technology category
+   */
+  technologyCategory: string | null;
+  /**
+   * Primary canonical technology type
+   */
+  technologyType: string | null;
+};
+
+/** @internal */
+export type GetConnectionQueueEntryRequest$Outbound = {
+  projectId: string;
+  sourceDataset?: string | undefined;
+};
+
+/** @internal */
+export const GetConnectionQueueEntryRequest$outboundSchema: z.ZodType<
+  GetConnectionQueueEntryRequest$Outbound,
+  z.ZodTypeDef,
+  GetConnectionQueueEntryRequest
+> = z.object({
+  projectId: z.string(),
+  sourceDataset: z.string().optional(),
+});
+
+export function getConnectionQueueEntryRequestToJSON(
+  getConnectionQueueEntryRequest: GetConnectionQueueEntryRequest,
+): string {
+  return JSON.stringify(
+    GetConnectionQueueEntryRequest$outboundSchema.parse(
+      getConnectionQueueEntryRequest,
+    ),
+  );
+}
+
+/** @internal */
+export const Coordinates$inboundSchema: z.ZodType<
+  Coordinates,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  lat: z.number(),
+  lng: z.number(),
+});
+
+export function coordinatesFromJSON(
+  jsonString: string,
+): SafeParseResult<Coordinates, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Coordinates$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Coordinates' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConnectionQueueEntryObject$inboundSchema: z.ZodNativeEnum<
+  typeof GetConnectionQueueEntryObject
+> = z.nativeEnum(GetConnectionQueueEntryObject);
+
+/** @internal */
+export const ConnectionQueueTechnology$inboundSchema: z.ZodType<
+  ConnectionQueueTechnology,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  capacityMw: z.nullable(z.number()),
+  isPrimary: z.boolean(),
+  technologyCategory: z.nullable(z.string()),
+  technologyType: z.string(),
+});
+
+export function connectionQueueTechnologyFromJSON(
+  jsonString: string,
+): SafeParseResult<ConnectionQueueTechnology, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConnectionQueueTechnology$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConnectionQueueTechnology' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetConnectionQueueEntryConnectionQueueEntry$inboundSchema:
+  z.ZodType<
+    GetConnectionQueueEntryConnectionQueueEntry,
+    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(() => Coordinates$inboundSchema)),
+    networkLevel: z.nullable(z.string()),
+    object: GetConnectionQueueEntryObject$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(() => ConnectionQueueTechnology$inboundSchema))
+      .optional(),
+    technologyCategory: z.nullable(z.string()),
+    technologyType: z.nullable(z.string()),
+  });
+
+export function getConnectionQueueEntryConnectionQueueEntryFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetConnectionQueueEntryConnectionQueueEntry,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetConnectionQueueEntryConnectionQueueEntry$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetConnectionQueueEntryConnectionQueueEntry' from JSON`,
+  );
+}