Overview of available wrappers

The library groups its wrappers by the kind of common API data you receive. Use this map to find the relevant domain, then follow its links for the public API details.

Grid

Start with DeliveryArea and EnergyMarketCodeType. InvalidDeliveryArea, BaseDeliveryArea, and InvalidDeliveryAreaError cover invalid delivery-area data.

Metrics

The main types are Metric, MetricSample, MetricConnection, MetricConnectionCategory, Bounds, BoundsSet, AggregatedMetricValue, and AggregationMethod. The BaseBounds, InvalidBounds, InvalidBoundsError, InvalidBoundsSet, and InvalidBoundsSetError cover the base and invalid range variants.

Microgrid

Use Microgrid, MicrogridId, EnterpriseId, and Lifetime. BaseLifetime and InvalidLifetime represent the lifetime variants, while InvalidLifetimeError is raised by safe accessors.

Electrical components

The common base is ElectricalComponent, with ElectricalComponentId for component identities. Concrete categories include Battery and LiIonBattery/NaIonBattery, the Inverter family, the EvCharger family, Meter, and GridConnectionPoint.

Recovery types preserve data this version cannot classify, including UnspecifiedElectricalComponent, UnrecognizedElectricalComponent, UnspecifiedBattery, UnrecognizedBattery, and MismatchedCategoryElectricalComponent. See the API Reference for the complete component list.

Sensors

This namespace provides SensorId for sensor identities.

Common types

Use Location for location data; InvalidLatitude, InvalidLongitude, and InvalidCountryCode preserve invalid fields.

Streaming

Event is the event wrapper.

Pagination

PaginationInfo carries pagination details.

For every field, method, and remaining wrapper type, see the API Reference. The Client Developer Guide explains how client libraries return these wrappers.