@vepler/sdk 2.46.0 → 2.50.3

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

@@ -10,16 +10,19 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GetEnergyForPropertyRequest = {
   /**
-   * Comma-separated list of layers to include in the response. Available layers: supplyArea, substation, capacity, ecr, dfes, connections. Defaults to all layers if omitted
+   * Comma-separated list of layers to include (defaults to all)
    */
   include?: string | undefined;
   /**
-   * Latitude of the property location (WGS84)
+   * Latitude of the property location
    */
   lat?: number | null | undefined;
+  /**
+   * Unique location identifier (e.g. UPRN in the UK)
+   */
   locationId: string;
   /**
-   * Longitude of the property location (WGS84)
+   * Longitude of the property location
    */
   lon?: number | null | undefined;
 };
@@ -92,7 +95,7 @@ export type CapacitySnapshot = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the connection site, if available
  */
 export type GetEnergyForPropertyCoordinates = {
   /**
@@ -189,7 +192,7 @@ export type GetEnergyForPropertyConnectionQueueEntry = {
    */
   importCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the connection site, if available
    */
   location: GetEnergyForPropertyCoordinates | null;
   /**
@@ -209,7 +212,7 @@ export type GetEnergyForPropertyConnectionQueueEntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator managing this connection
    */
   operator: string;
   /**
@@ -278,7 +281,7 @@ export type DfesForecast = {
    */
   forecastMw: number | null;
   /**
-   * Category of a forecast. Known values: 'demand', 'generation', 'storage'. 'demand' forecasts electricity consumption growth. 'generation' forecasts new renewable/distributed generation capacity. 'storage' forecasts battery and other storage deployment. New categories can be added as energy models evolve (e.g. flexibility, hydrogen).
+   * Whether this forecasts demand, generation, or storage capacity
    */
   forecastType: string;
   /**
@@ -290,11 +293,11 @@ export type DfesForecast = {
    */
   operatingRegion: string;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that published this forecast
    */
   operator: string;
   /**
-   * Energy planning scenario identifier. Each country's energy planning framework defines its own scenarios. Known GB scenarios: 'leading_the_way', 'consumer_transformation', 'system_transformation', 'falling_short', 'best_view', 'holistic_transition'. 'leading_the_way' assumes fastest decarbonisation. 'falling_short' assumes slowest progress. 'best_view' is the operator's most likely central estimate.
+   * Energy planning scenario pathway
    */
   scenario: string;
   /**
@@ -312,7 +315,7 @@ export type DfesForecast = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the generation or storage site
  */
 export type GetEnergyForPropertyEnergyCoordinates = {
   /**
@@ -350,11 +353,11 @@ export type EcrEntry = {
    */
   connectionDate: string | null;
   /**
-   * Lifecycle status of a generation/storage connection. Known values: 'connected', 'accepted', 'contracted', 'in_scoping'. 'connected' is live and exporting. 'accepted' has a formal connection offer accepted. 'contracted' is under contract but not yet connected. 'in_scoping' is in early feasibility assessment. Different regulatory frameworks may define additional statuses.
+   * Current lifecycle status of this connection
    */
   connectionStatus: string | null;
   /**
-   * Category of an embedded capacity register connection. Known values: 'generation', 'storage', 'generation_and_storage'. 'generation' covers solar, wind, gas, biomass, etc. 'storage' covers batteries. 'generation_and_storage' covers co-located sites. New types can be added as technologies evolve (e.g. hydrogen electrolysis, V2G).
+   * Whether this is a generation, storage, or combined connection
    */
   connectionType: string | null;
   /**
@@ -370,7 +373,7 @@ export type EcrEntry = {
    */
   installedCapacityMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the generation or storage site
    */
   location: GetEnergyForPropertyEnergyCoordinates | null;
   /**
@@ -382,7 +385,7 @@ export type EcrEntry = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that published this ECR data
    */
   operator: string;
   /**
@@ -409,7 +412,7 @@ export type GetEnergyForPropertyObject = ClosedEnum<
 >;
 
 /**
- * WGS84 coordinate pair
+ * Geographic location of the substation
  */
 export type GetEnergyForPropertyEnergyResponseCoordinates = {
   /**
@@ -438,7 +441,7 @@ export type GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodyObje
   >;
 
 /**
- * A network operator substation with its current capacity and headroom data
+ * The substation that serves this property, with current capacity and headroom. Null if no serving substation could be resolved. Omitted if not requested via `include`
  */
 export type GetEnergyForPropertySubstation = {
   /**
@@ -466,7 +469,7 @@ export type GetEnergyForPropertySubstation = {
    */
   generationHeadroomMw: number | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic location of the substation
    */
   location: GetEnergyForPropertyEnergyResponseCoordinates | null;
   /**
@@ -483,7 +486,7 @@ export type GetEnergyForPropertySubstation = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that owns and operates this substation
    */
   operator: string;
   /**
@@ -495,7 +498,7 @@ export type GetEnergyForPropertySubstation = {
    */
   reversePowerCapacityMw: number | null;
   /**
-   * Classification of substation within the electricity network hierarchy. Known values: 'gsp', 'bulk_supply', 'grid', 'primary', 'distribution'. 'gsp' (Grid Supply Point) connects to the national transmission grid. 'bulk_supply' and 'grid' operate at intermediate voltages. 'primary' steps down to 11kV for local distribution. 'distribution' serves end customers at low voltage.
+   * Classification of this substation in the network hierarchy
    */
   substationType: string | null;
   /**
@@ -509,7 +512,7 @@ export type GetEnergyForPropertySubstation = {
 };
 
 /**
- * WGS84 coordinate pair
+ * Geographic centre point of the supply area
  */
 export type GetEnergyForPropertyEnergyResponse200Coordinates = {
   /**
@@ -538,7 +541,7 @@ export type GetEnergyForPropertyEnergyResponse200ApplicationJSONResponseBodySupp
   >;
 
 /**
- * A geographic boundary defining the area served by a specific substation
+ * The supply area boundary containing this property. Null if the property falls outside known supply area polygons. Omitted if not requested via `include`
  */
 export type GetEnergyForPropertySupplyArea = {
   /**
@@ -546,11 +549,11 @@ export type GetEnergyForPropertySupplyArea = {
    */
   areaSqkm: number | null;
   /**
-   * Classification of supply area boundary. Each type corresponds to a level in the network hierarchy. Known values: 'gsp', 'bsp', 'grid', 'primary', 'distribution'. 'distribution' is the most granular, 'gsp' (Grid Supply Point) is the broadest.
+   * Level of this boundary in the network hierarchy. More specific types cover smaller geographic areas
    */
   areaType: string | null;
   /**
-   * WGS84 coordinate pair
+   * Geographic centre point of the supply area
    */
   centroid: GetEnergyForPropertyEnergyResponse200Coordinates | null;
   /**
@@ -575,7 +578,7 @@ export type GetEnergyForPropertySupplyArea = {
    */
   operatingRegion: string | null;
   /**
-   * Network operator identifier. Known values include: 'ukpn', 'npg', 'nged', 'ssen', 'spen', 'enw', 'neso'. New operators can be added without code changes.
+   * Network operator that manages this supply area
    */
   operator: string;
   /**
@@ -619,11 +622,11 @@ export type GetEnergyForPropertyEnergyForProperty = {
    */
   object: GetEnergyForPropertyObject;
   /**
-   * A network operator substation with its current capacity and headroom data
+   * The substation that serves this property, with current capacity and headroom. Null if no serving substation could be resolved. Omitted if not requested via `include`
    */
   substation?: GetEnergyForPropertySubstation | null | undefined;
   /**
-   * A geographic boundary defining the area served by a specific substation
+   * The supply area boundary containing this property. Null if the property falls outside known supply area polygons. Omitted if not requested via `include`
    */
   supplyArea?: GetEnergyForPropertySupplyArea | null | undefined;
 };