@vepler/sdk 2.42.0 → 2.45.0

package/src/funcs/energyFindSupplyAreaByPoint.ts

@@ -0,0 +1,202 @@
+/*
+ * 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";
+
+/**
+ * Find supply areas by point
+ *
+ * @remarks
+ * Find all supply area boundaries that contain a given geographic point.
+ *
+ * A supply area defines the geographic region served by a specific substation. Multiple boundaries may overlap at a single point because the network is hierarchical — a location can fall within a distribution area, a primary area, a bulk supply point area, and a grid supply point area simultaneously.
+ *
+ * Results are returned from most specific (distribution) to broadest (grid supply point).
+ */
+export function energyFindSupplyAreaByPoint(
+  client: SDKCore,
+  request?: operations.FindSupplyAreaByPointRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.FindSupplyAreaByPointResponseBody,
+    | errors.FindSupplyAreaByPointResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponseResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request?: operations.FindSupplyAreaByPointRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.FindSupplyAreaByPointResponseBody,
+      | errors.FindSupplyAreaByPointResponseBody
+      | errors.FindSupplyAreaByPointEnergyResponseBody
+      | errors.FindSupplyAreaByPointEnergyResponseResponseBody
+      | errors.FindSupplyAreaByPointEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.FindSupplyAreaByPointRequest$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/supply-areas/by-point")();
+
+  const query = encodeFormQuery({
+    "lat": payload?.lat,
+    "lon": payload?.lon,
+  });
+
+  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: "findSupplyAreaByPoint",
+    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.FindSupplyAreaByPointResponseBody,
+    | errors.FindSupplyAreaByPointResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponseResponseBody
+    | errors.FindSupplyAreaByPointEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.FindSupplyAreaByPointResponseBody$inboundSchema),
+    M.jsonErr(401, errors.FindSupplyAreaByPointResponseBody$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.FindSupplyAreaByPointEnergyResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.FindSupplyAreaByPointEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.FindSupplyAreaByPointEnergyResponse500ResponseBody$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/energyGetByProperty.ts

@@ -0,0 +1,221 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery, 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 energy infrastructure for a property
+ *
+ * @remarks
+ * Get the complete energy infrastructure context for a specific property location.
+ *
+ * This endpoint resolves a property's coordinates to its serving electricity substation and supply area, then enriches the response with:
+ *
+ * - **Supply area** — the geographic boundary served by the substation
+ * - **Substation** — current capacity, demand, and available headroom
+ * - **Capacity history** — quarterly snapshots showing how headroom has changed
+ * - **Embedded connections** — registered generation and storage sites nearby
+ * - **Future forecasts** — projected demand and generation growth
+ * - **Connection queue** — grid connection queue entries at the serving substation
+ *
+ * The `lat` and `lon` query parameters specify the property's coordinates in WGS84.
+ *
+ * Use the `include` parameter to select which layers to return. Defaults to all layers (`supplyArea,substation,capacity,ecr,dfes,connections`). Omitting layers you don't need reduces response size and improves performance.
+ */
+export function energyGetByProperty(
+  client: SDKCore,
+  request: operations.GetEnergyForPropertyRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetEnergyForPropertyEnergyForProperty,
+    | errors.GetEnergyForPropertyResponseBody
+    | errors.GetEnergyForPropertyEnergyResponseBody
+    | errors.GetEnergyForPropertyEnergyResponseResponseBody
+    | errors.GetEnergyForPropertyEnergyResponse500ResponseBody
+    | errors.GetEnergyForPropertyEnergyResponse503ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetEnergyForPropertyRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetEnergyForPropertyEnergyForProperty,
+      | errors.GetEnergyForPropertyResponseBody
+      | errors.GetEnergyForPropertyEnergyResponseBody
+      | errors.GetEnergyForPropertyEnergyResponseResponseBody
+      | errors.GetEnergyForPropertyEnergyResponse500ResponseBody
+      | errors.GetEnergyForPropertyEnergyResponse503ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetEnergyForPropertyRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    locationId: encodeSimple("locationId", payload.locationId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/energy/by-property/{locationId}")(pathParams);
+
+  const query = encodeFormQuery({
+    "include": payload.include,
+    "lat": payload.lat,
+    "lon": payload.lon,
+  });
+
+  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: "getEnergyForProperty",
+    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", "503", "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.GetEnergyForPropertyEnergyForProperty,
+    | errors.GetEnergyForPropertyResponseBody
+    | errors.GetEnergyForPropertyEnergyResponseBody
+    | errors.GetEnergyForPropertyEnergyResponseResponseBody
+    | errors.GetEnergyForPropertyEnergyResponse500ResponseBody
+    | errors.GetEnergyForPropertyEnergyResponse503ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetEnergyForPropertyEnergyForProperty$inboundSchema),
+    M.jsonErr(401, errors.GetEnergyForPropertyResponseBody$inboundSchema),
+    M.jsonErr(403, errors.GetEnergyForPropertyEnergyResponseBody$inboundSchema),
+    M.jsonErr(
+      429,
+      errors.GetEnergyForPropertyEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.GetEnergyForPropertyEnergyResponse500ResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      503,
+      errors.GetEnergyForPropertyEnergyResponse503ResponseBody$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/energyGetCapacity.ts

@@ -0,0 +1,211 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { SDKCore } from "../core.js";
+import { encodeFormQuery, 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 capacity time-series
+ *
+ * @remarks
+ * Get historical capacity snapshots for a substation, ordered chronologically.
+ *
+ * Each snapshot records the substation's demand, firm capacity, and available headroom at a point in time (typically quarterly). Use this data to track how available capacity has changed and identify trends in network utilisation.
+ *
+ * **Headroom** is the spare capacity available for new connections:
+ * - **Demand headroom** — capacity available for new electricity consumers (e.g. data centres, EV charging)
+ * - **Generation headroom** — capacity available for new generators (e.g. solar farms, wind turbines)
+ *
+ * Optionally filter by date range using `from` and `to` parameters.
+ */
+export function energyGetCapacity(
+  client: SDKCore,
+  request: operations.GetSubstationCapacityRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetSubstationCapacityResponseBody,
+    | errors.GetSubstationCapacityResponseBody
+    | errors.GetSubstationCapacityEnergyResponseBody
+    | errors.GetSubstationCapacityEnergyResponseResponseBody
+    | errors.GetSubstationCapacityEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetSubstationCapacityRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetSubstationCapacityResponseBody,
+      | errors.GetSubstationCapacityResponseBody
+      | errors.GetSubstationCapacityEnergyResponseBody
+      | errors.GetSubstationCapacityEnergyResponseResponseBody
+      | errors.GetSubstationCapacityEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetSubstationCapacityRequest$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}/capacity")(pathParams);
+
+  const query = encodeFormQuery({
+    "from": payload.from,
+    "to": payload.to,
+  });
+
+  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: "getSubstationCapacity",
+    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.GetSubstationCapacityResponseBody,
+    | errors.GetSubstationCapacityResponseBody
+    | errors.GetSubstationCapacityEnergyResponseBody
+    | errors.GetSubstationCapacityEnergyResponseResponseBody
+    | errors.GetSubstationCapacityEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetSubstationCapacityResponseBody$inboundSchema),
+    M.jsonErr(401, errors.GetSubstationCapacityResponseBody$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.GetSubstationCapacityEnergyResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.GetSubstationCapacityEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.GetSubstationCapacityEnergyResponse500ResponseBody$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 }];
+}