@vepler/sdk 2.42.0 → 2.45.0

package/src/funcs/energyGetConnectionQueueBySubstation.ts

@@ -0,0 +1,211 @@
+/*
+ * 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 connection queue entries for a substation
+ *
+ * @remarks
+ * Get all grid connection queue entries associated with a specific substation.
+ *
+ * Returns projects from both the TEC Register (transmission) and Embedded Register (distribution) that connect at this substation. Ordered by capacity (largest first).
+ */
+export function energyGetConnectionQueueBySubstation(
+  client: SDKCore,
+  request: operations.GetConnectionQueueBySubstationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetConnectionQueueBySubstationResponseBody,
+    | errors.GetConnectionQueueBySubstationResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponseResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetConnectionQueueBySubstationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetConnectionQueueBySubstationResponseBody,
+      | errors.GetConnectionQueueBySubstationResponseBody
+      | errors.GetConnectionQueueBySubstationEnergyResponseBody
+      | errors.GetConnectionQueueBySubstationEnergyResponseResponseBody
+      | errors.GetConnectionQueueBySubstationEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetConnectionQueueBySubstationRequest$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}/connection-queue")(
+    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: "getConnectionQueueBySubstation",
+    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", "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.GetConnectionQueueBySubstationResponseBody,
+    | errors.GetConnectionQueueBySubstationResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponseResponseBody
+    | errors.GetConnectionQueueBySubstationEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetConnectionQueueBySubstationResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      401,
+      errors.GetConnectionQueueBySubstationResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      403,
+      errors.GetConnectionQueueBySubstationEnergyResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors
+        .GetConnectionQueueBySubstationEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors
+        .GetConnectionQueueBySubstationEnergyResponse500ResponseBody$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/energyGetConnectionQueueEntry.ts

@@ -0,0 +1,218 @@
+/*
+ * 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 connection queue entry by project ID
+ *
+ * @remarks
+ * Retrieve a single connection queue entry by its project identifier.
+ *
+ * Returns the full entry including all technology components from the junction table. Multi-technology projects (e.g. solar + battery co-location) will include each technology as a separate item in the `technologies` array.
+ *
+ * Optionally pass `sourceDataset` as a query parameter to disambiguate entries that appear in both TEC and Embedded registers.
+ */
+export function energyGetConnectionQueueEntry(
+  client: SDKCore,
+  request: operations.GetConnectionQueueEntryRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetConnectionQueueEntryConnectionQueueEntry,
+    | errors.GetConnectionQueueEntryResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponseResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponse429ResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetConnectionQueueEntryRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetConnectionQueueEntryConnectionQueueEntry,
+      | errors.GetConnectionQueueEntryResponseBody
+      | errors.GetConnectionQueueEntryEnergyResponseBody
+      | errors.GetConnectionQueueEntryEnergyResponseResponseBody
+      | errors.GetConnectionQueueEntryEnergyResponse429ResponseBody
+      | errors.GetConnectionQueueEntryEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      operations.GetConnectionQueueEntryRequest$outboundSchema.parse(value),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = null;
+
+  const pathParams = {
+    projectId: encodeSimple("projectId", payload.projectId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+
+  const path = pathToFunc("/v1/energy/connection-queue/{projectId}")(
+    pathParams,
+  );
+
+  const query = encodeFormQuery({
+    "sourceDataset": payload.sourceDataset,
+  });
+
+  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: "getConnectionQueueEntry",
+    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", "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.GetConnectionQueueEntryConnectionQueueEntry,
+    | errors.GetConnectionQueueEntryResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponseResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponse429ResponseBody
+    | errors.GetConnectionQueueEntryEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(
+      200,
+      operations.GetConnectionQueueEntryConnectionQueueEntry$inboundSchema,
+    ),
+    M.jsonErr(401, errors.GetConnectionQueueEntryResponseBody$inboundSchema),
+    M.jsonErr(
+      403,
+      errors.GetConnectionQueueEntryEnergyResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      404,
+      errors.GetConnectionQueueEntryEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      429,
+      errors.GetConnectionQueueEntryEnergyResponse429ResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.GetConnectionQueueEntryEnergyResponse500ResponseBody$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/energyGetDFES.ts

@@ -0,0 +1,210 @@
+/*
+ * 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 future energy scenario forecasts
+ *
+ * @remarks
+ * Get energy scenario forecasts for a substation.
+ *
+ * Forecasts project how electricity demand, generation, and storage capacity will evolve at each substation over time. Each country's energy planning framework defines its own scenarios — for example, GB uses Distribution Future Energy Scenarios (DFES) with pathways such as:
+ *
+ * - **Leading the Way** — fastest decarbonisation, highest electrification
+ * - **Consumer Transformation** — consumer-led change with high energy efficiency
+ * - **System Transformation** — hydrogen-heavy, centralised generation
+ * - **Falling Short** — slowest progress towards net zero
+ * - **Best View** — the operator's central planning estimate
+ *
+ * Other countries define their own scenario sets. Optionally filter by scenario and/or year range.
+ */
+export function energyGetDFES(
+  client: SDKCore,
+  request: operations.GetSubstationDFESRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetSubstationDFESResponseBody,
+    | errors.GetSubstationDFESResponseBody
+    | errors.GetSubstationDFESEnergyResponseBody
+    | errors.GetSubstationDFESEnergyResponseResponseBody
+    | errors.GetSubstationDFESEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: SDKCore,
+  request: operations.GetSubstationDFESRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      operations.GetSubstationDFESResponseBody,
+      | errors.GetSubstationDFESResponseBody
+      | errors.GetSubstationDFESEnergyResponseBody
+      | errors.GetSubstationDFESEnergyResponseResponseBody
+      | errors.GetSubstationDFESEnergyResponse500ResponseBody
+      | SDKBaseError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) => operations.GetSubstationDFESRequest$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}/dfes")(pathParams);
+
+  const query = encodeFormQuery({
+    "scenario": payload.scenario,
+    "yearFrom": payload.yearFrom,
+    "yearTo": payload.yearTo,
+  });
+
+  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: "getSubstationDFES",
+    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.GetSubstationDFESResponseBody,
+    | errors.GetSubstationDFESResponseBody
+    | errors.GetSubstationDFESEnergyResponseBody
+    | errors.GetSubstationDFESEnergyResponseResponseBody
+    | errors.GetSubstationDFESEnergyResponse500ResponseBody
+    | SDKBaseError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, operations.GetSubstationDFESResponseBody$inboundSchema),
+    M.jsonErr(401, errors.GetSubstationDFESResponseBody$inboundSchema),
+    M.jsonErr(403, errors.GetSubstationDFESEnergyResponseBody$inboundSchema),
+    M.jsonErr(
+      429,
+      errors.GetSubstationDFESEnergyResponseResponseBody$inboundSchema,
+    ),
+    M.jsonErr(
+      500,
+      errors.GetSubstationDFESEnergyResponse500ResponseBody$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 }];
+}