@vepler/sdk 2.42.0 → 2.45.0

package/src/funcs/energyGetSubstation.ts

@@ -0,0 +1,205 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Get substation by code
+ *
+ * @remarks
+ * Retrieve a single electricity substation by its unique code.
+ *
+ * Substation codes are prefixed with the operator identifier — for example `ukpn:PRI-1234` for a UK Power Networks primary substation, or `npg:12345` for a Northern Powergrid substation.
+ *
+ * The response includes the substation's current capacity ratings, peak demand, and available headroom (spare capacity for new connections).
+ */
+export function energyGetSubstation(
+  client: SDKCore,
+  request: operations.GetSubstationByCodeRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetSubstationByCodeSubstation,
+    | errors.GetSubstationByCodeResponseBody
+    | errors.GetSubstationByCodeEnergyResponseBody
+    | errors.GetSubstationByCodeEnergyResponseResponseBody
+    | errors.GetSubstationByCodeEnergyResponse429ResponseBody
+    | errors.GetSubstationByCodeEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetSubstationByCodeRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetSubstationByCodeSubstation,
+      | errors.GetSubstationByCodeResponseBody
+      | errors.GetSubstationByCodeEnergyResponseBody
+      | errors.GetSubstationByCodeEnergyResponseResponseBody
+      | errors.GetSubstationByCodeEnergyResponse429ResponseBody
+      | errors.GetSubstationByCodeEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetSubstationByCodeRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    code: encodeSimple("code", payload.code, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/energy/substations/{code}")(pathParams);
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "getSubstationByCode",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "404", "429", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.GetSubstationByCodeSubstation,
+    | errors.GetSubstationByCodeResponseBody
+    | errors.GetSubstationByCodeEnergyResponseBody
+    | errors.GetSubstationByCodeEnergyResponseResponseBody
+    | errors.GetSubstationByCodeEnergyResponse429ResponseBody
+    | errors.GetSubstationByCodeEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetSubstationByCodeSubstation$inboundSchema),
+    M.jsonErr(401, errors.GetSubstationByCodeResponseBody$inboundSchema),
+    M.jsonErr(403, errors.GetSubstationByCodeEnergyResponseBody$inboundSchema),
+    M.jsonErr(
+      404,
+      errors.GetSubstationByCodeEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.GetSubstationByCodeEnergyResponse429ResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.GetSubstationByCodeEnergyResponse500ResponseBody$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/energySearchConnectionQueue.ts

@@ -0,0 +1,213 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeJSON } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Search connection queue
+ *
+ * @remarks
+ * Search the national grid connection queue for projects awaiting or holding connection agreements to the electricity network.
+ *
+ * Covers both transmission-level connections (TEC Register) and distribution-level connections (Embedded Register) from NESO.
+ *
+ * **Available filters:**
+ * - `country` — filter by ISO 3166-1 alpha-2 country code
+ * - `operator` — filter by network operator code
+ * - `technologyType` — filter by canonical technology (e.g. `solar`, `battery`, `wind_onshore`)
+ * - `technologyCategory` — filter by category (generation, storage, thermal, demand)
+ * - `connectionStatus` — filter by lifecycle stage (e.g. `offer_accepted`, `connected`)
+ * - `networkLevel` — filter by voltage level (transmission, distribution)
+ * - `sourceDataset` — filter by source register (neso_tec, neso_embedded)
+ * - `substationCode` — filter by resolved substation
+ * - `minCapacityMw` / `maxCapacityMw` — filter by capacity range
+ *
+ * Results are ordered by capacity (largest first) and paginated using `limit` and `offset`.
+ */
+export function energySearchConnectionQueue(
+  client: SDKCore,
+  request?:
+    | operations.SearchConnectionQueueConnectionQueueSearchInput
+    | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SearchConnectionQueueResponseBody,
+    | errors.SearchConnectionQueueResponseBody
+    | errors.SearchConnectionQueueEnergyResponseBody
+    | errors.SearchConnectionQueueEnergyResponseResponseBody
+    | errors.SearchConnectionQueueEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?:
+    | operations.SearchConnectionQueueConnectionQueueSearchInput
+    | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SearchConnectionQueueResponseBody,
+      | errors.SearchConnectionQueueResponseBody
+      | errors.SearchConnectionQueueEnergyResponseBody
+      | errors.SearchConnectionQueueEnergyResponseResponseBody
+      | errors.SearchConnectionQueueEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SearchConnectionQueueConnectionQueueSearchInput$outboundSchema
+        .optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = payload === undefined
+    ? null
+    : encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v1/energy/connection-queue/query")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "searchConnectionQueue",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "429", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.SearchConnectionQueueResponseBody,
+    | errors.SearchConnectionQueueResponseBody
+    | errors.SearchConnectionQueueEnergyResponseBody
+    | errors.SearchConnectionQueueEnergyResponseResponseBody
+    | errors.SearchConnectionQueueEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.SearchConnectionQueueResponseBody$inboundSchema),
+    M.jsonErr(401, errors.SearchConnectionQueueResponseBody$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.SearchConnectionQueueEnergyResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.SearchConnectionQueueEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.SearchConnectionQueueEnergyResponse500ResponseBody$inboundSchema,
+    ),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}

package/src/funcs/energySearchECR.ts

@@ -0,0 +1,203 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import * as M from "../lib/matchers.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../sdk/models/errors/httpclienterrors.js";
+import * as errors from "../sdk/models/errors/index.js";
+import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js";
+import { SDKBaseError } from "../sdk/models/errors/sdkbaseerror.js";
+import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js";
+import * as operations from "../sdk/models/operations/index.js";
+import { APICall, APIPromise } from "../sdk/types/async.js";
+import { Result } from "../sdk/types/fp.js";
+
+/**
+ * Search embedded capacity register
+ *
+ * @remarks
+ * Search the Embedded Capacity Register (ECR) for generation and storage connections to the electricity distribution network.
+ *
+ * The ECR is a public record of all distributed generation (solar, wind, gas, biomass) and storage (battery) sites connected to the distribution network. Each entry includes the installed capacity, technology type, connection status, and location.
+ *
+ * **Available filters:**
+ * - `operator` — limit to a specific network operator
+ * - `operatingRegion` — limit to a specific operating region
+ * - `country` — filter by ISO 3166-1 alpha-2 country code
+ * - `technologyType` — filter by technology (e.g. `solar`, `wind`, `battery`)
+ * - `connectionStatus` — filter by lifecycle stage (e.g. `connected`, `accepted`)
+ *
+ * Results are ordered by installed capacity (largest first) and paginated using `limit` and `offset`.
+ */
+export function energySearchECR(
+  client: SDKCore,
+  request?: operations.SearchECRRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.SearchECRResponseBody,
+    | errors.SearchECRResponseBody
+    | errors.SearchECREnergyResponseBody
+    | errors.SearchECREnergyResponseResponseBody
+    | errors.SearchECREnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?: operations.SearchECRRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.SearchECRResponseBody,
+      | errors.SearchECRResponseBody
+      | errors.SearchECREnergyResponseBody
+      | errors.SearchECREnergyResponseResponseBody
+      | errors.SearchECREnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.SearchECRRequest$outboundSchema.optional().parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const path = pathToFunc("/v1/energy/ecr")();
+
+  const query = encodeFormQuery({
+    "connectionStatus": payload?.connectionStatus,
+    "country": payload?.country,
+    "limit": payload?.limit,
+    "offset": payload?.offset,
+    "operatingRegion": payload?.operatingRegion,
+    "operator": payload?.operator,
+    "technologyType": payload?.technologyType,
+  });
+
+  const headers = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+
+  const secConfig = await extractSecurity(client._options.apiKeyAuth);
+  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client._options,
+    baseURL: options?.serverURL ?? client._baseURL ?? "",
+    operationID: "searchECR",
+    oAuth2Scopes: null,
+
+    resolvedSecurity: requestSecurity,
+
+    securitySource: client._options.apiKeyAuth,
+    retryConfig: options?.retries
+      || client._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"],
+  };
+
+  const requestRes = client._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    query: query,
+    body: body,
+    userAgent: client._options.userAgent,
+    timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req = requestRes.value;
+
+  const doResult = await client._do(req, {
+    context,
+    errorCodes: ["401", "403", "429", "4XX", "500", "5XX"],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req }];
+  }
+  const response = doResult.value;
+
+  const responseFields = {
+    HttpMeta: { Response: response, Request: req },
+  };
+
+  const [result] = await M.match<
+    operations.SearchECRResponseBody,
+    | errors.SearchECRResponseBody
+    | errors.SearchECREnergyResponseBody
+    | errors.SearchECREnergyResponseResponseBody
+    | errors.SearchECREnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.SearchECRResponseBody$inboundSchema),
+    M.jsonErr(401, errors.SearchECRResponseBody$inboundSchema),
+    M.jsonErr(403, errors.SearchECREnergyResponseBody$inboundSchema),
+    M.jsonErr(429, errors.SearchECREnergyResponseResponseBody$inboundSchema),
+    M.jsonErr(500, errors.SearchECREnergyResponse500ResponseBody$inboundSchema),
+    M.fail("4XX"),
+    M.fail("5XX"),
+  )(response, req, { extraFields: responseFields });
+  if (!result.ok) {
+    return [result, { status: "complete", request: req, response }];
+  }
+
+  return [result, { status: "complete", request: req, response }];
+}