feat: POWER-4723 - Add support for fallback rating flag in Heimdall DLR and Circuit Rating

dotnet/HeimdallPower.Api.Client/HeimdallPower.Api.Client/CapacityMonitoring/Facilities/CircuitRatingDto.cs

@@ -23,4 +23,10 @@ public record CircuitRatingDto
     /// </summary>
     /// <example>00000000-0000-0000-0000-000000000000</example>
     public Guid? AtFacilityComponentId { get; init; }
+
+    /// <summary>
+    /// Indicates whether the Heimdall DLR is a fallback value. Only applies to grid owners opting in for this feature.
+    /// </summary>
+    /// <example>false</example>
+    public bool IsFallback { get; init; }
 }

dotnet/HeimdallPower.Api.Client/HeimdallPower.Api.Client/CapacityMonitoring/Lines/HeimdallDlrDto.cs

@@ -17,4 +17,10 @@ public record HeimdallDlrDto
     /// </summary>
     /// <example>375.4</example>
     public double Value { get; init; }
+
+    /// <summary>
+    /// Indicates whether the Heimdall DLR is a fallback value. Only applies to grid owners opting in for this feature.
+    /// </summary>
+    /// <example>false</example>
+    public bool IsFallback { get; init; }
 }

dotnet/examples/Api.Client.Examples/Program.cs

@@ -38,7 +38,7 @@
 var forecastDlr = await api.GetHeimdallDlrForecastsAsync(line.Id);
 var forecastAar = await api.GetHeimdallAarForecastsAsync(line.Id);
 
-Console.WriteLine($"- Heimdall DLR: {latestDlr.HeimdallDlr.Value} {latestDlr.Unit} at {latestDlr.HeimdallDlr.Timestamp}");
+Console.WriteLine($"- Heimdall DLR: {latestDlr.HeimdallDlr.Value} {latestDlr.Unit} at {latestDlr.HeimdallDlr.Timestamp} with IsFallback={latestDlr.HeimdallDlr.IsFallback}");
 Console.WriteLine($"- Heimdall AAR: {latestAar.HeimdallAar.Value} {latestAar.Unit} at {latestAar.HeimdallAar.Timestamp}");
 
 // Fetch Circuit Rating data
@@ -49,4 +49,4 @@
 var circuitRatingForecast = await api.GetCircuitRatingForecastsAsync(facility.Id);
 
 var limitingComponent = circuitRating.CircuitRating.AtFacilityComponentId?.ToString() ?? "none";
-Console.WriteLine($"- Circuit Rating: {circuitRating.CircuitRating.Value} {circuitRating.Unit} at {circuitRating.CircuitRating.Timestamp}, limiting component: {limitingComponent}");
+Console.WriteLine($"- Circuit Rating: {circuitRating.CircuitRating.Value} {circuitRating.Unit} at {circuitRating.CircuitRating.Timestamp}, limiting component: {limitingComponent}, IsFallback={circuitRating.CircuitRating.IsFallback}");

python/examples/print_circuit_rating.py

@@ -24,7 +24,10 @@
         circuit_rating_forecast = circuit_rating_forecast_response.data.circuit_rating_forecasts
         print(f"Facility: {facility.name}")
         print(f"    {circuit_rating_response.data.metric}, timestamp {circuit_rating.timestamp}\n")
-        print(f"        {circuit_rating.value} {circuit_rating_response.data.unit}, limited by {limiting_component}\n")
+        print(
+            f"        {circuit_rating.value} {circuit_rating_response.data.unit}, "
+            f"limited by {limiting_component}, isFallback = {circuit_rating.is_fallback}\n"
+        )
         forecast_data = circuit_rating_forecast_response.data
         print(f"    {forecast_data.metric}, updated at {forecast_data.updated_timestamp}:")
         for forecast in circuit_rating_forecast:

python/examples/print_heimdall_dlr.py

@@ -27,7 +27,7 @@
         print(f"Facility: {facility.name}")
         print(f"  Line: {line.name} (ID: {line.id})\n")
         print(f"    {dlr_response.data.metric}, timestamp {dlr.timestamp}\n")
-        print(f"        {dlr.value} {dlr_response.data.unit}\n")
+        print(f"        {dlr.value} {dlr_response.data.unit}, isFallback = {dlr.is_fallback}\n")
         print(f"    {dlr_forecast_response.data.metric}, updated at {dlr_forecast_response.data.updated_timestamp}:")
         for forecast in dlr_forecast:
             print(f"      {forecast.timestamp}: {forecast.prediction.value} {dlr_forecast_response.data.unit}")

python/heimdall_api_client/capacity_monitoring_api_client/__init__.py

@@ -1,5 +1,5 @@
-"""A client library for accessing Capacity Monitoring API"""
 
+""" A client library for accessing Capacity Monitoring API """
 from .client import AuthenticatedClient, Client
 
 __all__ = (

python/heimdall_api_client/capacity_monitoring_api_client/api/__init__.py

@@ -1 +1 @@
-"""Contains methods for accessing the API"""
+""" Contains methods for accessing the API """

python/heimdall_api_client/capacity_monitoring_api_client/api/facility/__init__.py

@@ -1 +1 @@
-"""Contains endpoint functions for accessing the API"""
+""" Contains endpoint functions for accessing the API """

python/heimdall_api_client/capacity_monitoring_api_client/api/facility/capacity_monitoring_v1_facilities_get_latest_circuit_rating.py

@@ -1,49 +1,56 @@
 from http import HTTPStatus
 from typing import Any, cast
 from urllib.parse import quote
-from uuid import UUID
 
 import httpx
 
-from ... import errors
 from ...client import AuthenticatedClient, Client
-from ...models.capacity_monitoring_v1_facilities_get_latest_circuit_rating_response_200 import (
-    CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200,
-)
-from ...models.capacity_monitoring_v1_facilities_get_latest_circuit_rating_x_region import (
-    CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion,
-)
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.capacity_monitoring_v1_facilities_get_latest_circuit_rating_response_200 import CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200
+from ...models.capacity_monitoring_v1_facilities_get_latest_circuit_rating_x_region import CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
 from ...models.problem_details import ProblemDetails
-from ...types import Response, Unset
+from ...types import UNSET, Unset
+from typing import cast
+from uuid import UUID
+
 
 
 def _get_kwargs(
     facility_id: UUID,
     *,
-    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
-    | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+
 ) -> dict[str, Any]:
     headers: dict[str, Any] = {}
     if not isinstance(x_region, Unset):
         headers["x-region"] = str(x_region)
 
+
+
+
+
+
+
+
     _kwargs: dict[str, Any] = {
         "method": "get",
-        "url": "/capacity_monitoring/v1/facilities/{facility_id}/circuit_ratings/latest".format(
-            facility_id=quote(str(facility_id), safe=""),
-        ),
+        "url": "/capacity_monitoring/v1/facilities/{facility_id}/circuit_ratings/latest".format(facility_id=quote(str(facility_id), safe=""),),
     }
 
+
     _kwargs["headers"] = headers
     return _kwargs
 
 
-def _parse_response(
-    *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails | None:
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails | None:
     if response.status_code == 200:
         response_200 = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200.from_dict(response.json())
 
+
+
         return response_200
 
     if response.status_code == 401:
@@ -53,6 +60,8 @@ def _parse_response(
     if response.status_code == 403:
         response_403 = ProblemDetails.from_dict(response.json())
 
+
+
         return response_403
 
     if response.status_code == 404:
@@ -62,6 +71,8 @@ def _parse_response(
     if response.status_code == 500:
         response_500 = ProblemDetails.from_dict(response.json())
 
+
+
         return response_500
 
     if client.raise_on_unexpected_status:
@@ -70,9 +81,7 @@ def _parse_response(
         return None
 
 
-def _build_response(
-    *, client: AuthenticatedClient | Client, response: httpx.Response
-) -> Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]:
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]:
     return Response(
         status_code=HTTPStatus(response.status_code),
         content=response.content,
@@ -85,10 +94,10 @@ def sync_detailed(
     facility_id: UUID,
     *,
     client: AuthenticatedClient | Client,
-    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
-    | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+
 ) -> Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]:
-    """Get latest circuit rating
+    """ Get latest circuit rating
 
      This endpoint returns the most recent circuit rating for the facility, including the limiting
     facility component.
@@ -121,11 +130,13 @@ def sync_detailed(
 
     Returns:
         Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]
-    """
+     """
+
 
     kwargs = _get_kwargs(
         facility_id=facility_id,
-        x_region=x_region,
+x_region=x_region,
+
     )
 
     response = client.get_httpx_client().request(
@@ -134,15 +145,14 @@ def sync_detailed(
 
     return _build_response(client=client, response=response)
 
-
 def sync(
     facility_id: UUID,
     *,
     client: AuthenticatedClient | Client,
-    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
-    | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+
 ) -> Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails | None:
-    """Get latest circuit rating
+    """ Get latest circuit rating
 
      This endpoint returns the most recent circuit rating for the facility, including the limiting
     facility component.
@@ -175,23 +185,24 @@ def sync(
 
     Returns:
         Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails
-    """
+     """
+
 
     return sync_detailed(
         facility_id=facility_id,
-        client=client,
-        x_region=x_region,
-    ).parsed
+client=client,
+x_region=x_region,
 
+    ).parsed
 
 async def asyncio_detailed(
     facility_id: UUID,
     *,
     client: AuthenticatedClient | Client,
-    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
-    | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+
 ) -> Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]:
-    """Get latest circuit rating
+    """ Get latest circuit rating
 
      This endpoint returns the most recent circuit rating for the facility, including the limiting
     facility component.
@@ -224,26 +235,29 @@ async def asyncio_detailed(
 
     Returns:
         Response[Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails]
-    """
+     """
+
 
     kwargs = _get_kwargs(
         facility_id=facility_id,
-        x_region=x_region,
+x_region=x_region,
+
     )
 
-    response = await client.get_async_httpx_client().request(**kwargs)
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
 
     return _build_response(client=client, response=response)
 
-
 async def asyncio(
     facility_id: UUID,
     *,
     client: AuthenticatedClient | Client,
-    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion
-    | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+    x_region: CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion | Unset = CapacityMonitoringV1FacilitiesGetLatestCircuitRatingXRegion.EU,
+
 ) -> Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails | None:
-    """Get latest circuit rating
+    """ Get latest circuit rating
 
      This endpoint returns the most recent circuit rating for the facility, including the limiting
     facility component.
@@ -276,12 +290,12 @@ async def asyncio(
 
     Returns:
         Any | CapacityMonitoringV1FacilitiesGetLatestCircuitRatingResponse200 | ProblemDetails
-    """
-
-    return (
-        await asyncio_detailed(
-            facility_id=facility_id,
-            client=client,
-            x_region=x_region,
-        )
-    ).parsed
+     """
+
+
+    return (await asyncio_detailed(
+        facility_id=facility_id,
+client=client,
+x_region=x_region,
+
+    )).parsed