climify_api 1.0.26__tar.gz → 1.0.28__tar.gz

{climify_api-1.0.26 → climify_api-1.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: climify_api
-Version: 1.0.26
+Version: 1.0.28
 Summary: A wrapper library for the Climify REST API
 Author-email: Climify Aps <info@climify.com>
 Project-URL: Homepage, https://gitlab.climify.com/climify/python-api-lib

{climify_api-1.0.26 → climify_api-1.0.28}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "climify_api"
-version = "1.0.26"
+version = "1.0.28"
 keywords=['Climify','Environmental engineering']
 authors = [
   { name="Climify Aps", email="info@climify.com" },
@@ -50,7 +50,7 @@ Homepage = "https://gitlab.climify.com/climify/python-api-lib"
 Issues = "https://gitlab.climify.com/climify/python-api-lib/-/issues"
 
 [tool.bumpver]
-current_version = "1.0.26"
+current_version = "1.0.28"
 version_pattern = "MAJOR.MINOR.PATCH"
 commit_message  = "Bump version {old_version} -> {new_version}"
 commit          = true

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api/__init__.py

@@ -8,12 +8,12 @@
 
     Provides a REST endpoints for Climify applications and 3rd party solutions.  # noqa: E501
 
-    The version of the OpenAPI document: 1.0.26
+    The version of the OpenAPI document: 1.0.28
     Generated by: https://openapi-generator.tech
 """
 
 __name__ = 'climify_api'
-__version__ = "1.0.26"
+__version__ = "1.0.28"
 
 # import ApiClient
 from climify_api.api_client import ApiClient

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api/apis/v1/ApiController.py

@@ -7,6 +7,7 @@ from climify_api.apis.v1.paths import (
     GetOrganisationDevicesById,
     GetBuildingById,
     GetBuildingDevicesById,
+    GetBuildingMeteringPointsById,
     GetMapById,
     GetMapDevicesById,
     GetLocationById,
@@ -14,6 +15,7 @@ from climify_api.apis.v1.paths import (
     GetLocationSensorValuesById,
     GetFormResponsesFromLocationById,
     GetDeviceById,
+    GetMeteringPointValuesById,
 
     # POST
     SetLocationTemperatureById
@@ -26,6 +28,7 @@ class ApiController(
     GetOrganisationDevicesById,
     GetBuildingById,
     GetBuildingDevicesById,
+    GetBuildingMeteringPointsById,
     GetMapById,
     GetMapDevicesById,
     GetLocationById,
@@ -33,6 +36,7 @@ class ApiController(
     GetLocationSensorValuesById,
     GetFormResponsesFromLocationById,
     GetDeviceById,
+    GetMeteringPointValuesById,
     
     # POST
     SetLocationTemperatureById

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api/apis/v1/paths/__init__.py

@@ -5,6 +5,7 @@ from climify_api.apis.v1.paths.organisations_id_devices import GetOrganisationDe
 
 from climify_api.apis.v1.paths.buildings_id import GetBuildingById
 from climify_api.apis.v1.paths.buildings_id_devices import GetBuildingDevicesById
+from climify_api.apis.v1.paths.buildings_id_metering_points import GetBuildingMeteringPointsById
 
 from climify_api.apis.v1.paths.maps_id import GetMapById
 from climify_api.apis.v1.paths.maps_id_devices import GetMapDevicesById
@@ -17,4 +18,6 @@ from climify_api.apis.v1.paths.feedback_forms_id_locations_id_responses import G
 
 from climify_api.apis.v1.paths.devices_id import GetDeviceById
 
+from climify_api.apis.v1.paths.metering_points_id import GetMeteringPointValuesById
+
 from climify_api.apis.v1.paths.locations_id_change_temperature import SetLocationTemperatureById

climify_api-1.0.28/src/climify_api/apis/v1/paths/buildings_id_metering_points/__init__.py

@@ -0,0 +1 @@
+from climify_api.apis.v1.paths.buildings_id_metering_points.get import GetBuildingMeteringPointsById

climify_api-1.0.28/src/climify_api/apis/v1/paths/buildings_id_metering_points/get.py

@@ -0,0 +1,92 @@
+from dataclasses import dataclass
+import typing_extensions
+import urllib3
+from urllib3._collections import HTTPHeaderDict
+
+from climify_api import api_client, exceptions
+from datetime import date, datetime  # noqa: F401
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+from typing import List
+from pydantic import parse_raw_as
+
+
+from climify_api.apis.PathBase import PathBase  # noqa: F401
+
+from climify_api.exceptions import ApiValueError, ClimifyApiException
+from climify_api.api_client import ClimifyApiResponse, ClimifyApiResponseWithoutDeserialization
+from climify_api.models import MeteringPointDto
+
+PATH = 'buildings/{id}/metering-points'
+
+class GetBuildingMeteringPointsById(PathBase):
+    # this class is used by api classes that refer to endpoints with operationId fn names
+
+    def get_building_metering_points_by_id(
+        self,
+        building_id: int,
+        access_token: str = None,
+        stream: bool = False,
+        timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+        skip_deserialization: bool = False,
+    ) -> ClimifyApiResponse[List[MeteringPointDto]]:
+        """Returns the metering points associated with the provided building.
+
+        :param building_id: Building identifier
+        :type building_id: int
+        :param access_token: Access token to use for the request
+        :type access_token: str, optional
+        :param stream: Toggles streaming. Defaults to False.
+        :type stream: bool, optional
+        :param timeout: How long to wait for a request in seconds. Defaults to None.
+        :type timeout: typing.Optional[typing.Union[int, typing.Tuple]], optional
+        :param skip_deserialization: Toggles whether or not to skip deserialize of the byte response. Defaults to False.
+        :type skip_deserialization: bool, optional
+
+        :raises ApiValueError: Will be raised if invalid inputs are provided
+        :raises ClimifyApiException: Will be raised if an error occurred while calling the API
+
+        :return: A response with a body containing the list of metering points
+        :rtype: ClimifyApiResponse[List[MeteringPointDto]]
+        """
+        # Validate input
+        if building_id is None:
+            raise ApiValueError("Building id was given as None. A valid building id must be provided.")
+
+        # Make rest request
+        used_path = PATH.replace('{id}',str(building_id))
+
+        response = self.api_client.call_api(
+            resource_path=used_path,
+            method='GET',
+            access_token=access_token,
+            stream=stream,
+            timeout=timeout,
+        )
+
+        if not 200 <= response.status <= 299:
+            raise ClimifyApiException(
+                status=response.status,
+                reason=response.reason,
+                api_response=response
+            )
+        
+        if skip_deserialization:
+            api_response = ClimifyApiResponseWithoutDeserialization(response=response)
+        else:
+            # Deserialize response
+            deserialized_body = parse_raw_as(List[MeteringPointDto], response.data)
+            api_response = ClimifyApiResponse[List[MeteringPointDto]](
+                response=response,
+                status=response.status,
+                body=deserialized_body,
+                headers=response.headers
+            )
+
+
+        return api_response

climify_api-1.0.28/src/climify_api/apis/v1/paths/metering_points_id/__init__.py

@@ -0,0 +1 @@
+from climify_api.apis.v1.paths.metering_points_id.get import GetMeteringPointValuesById

climify_api-1.0.28/src/climify_api/apis/v1/paths/metering_points_id/get.py

@@ -0,0 +1,192 @@
+from collections import defaultdict
+from dataclasses import dataclass
+import typing_extensions
+import urllib3
+from urllib3._collections import HTTPHeaderDict
+
+from datetime import date, datetime, timedelta  # noqa: F401
+from dateutil.relativedelta import relativedelta
+import decimal  # noqa: F401
+import functools  # noqa: F401
+import io  # noqa: F401
+import re  # noqa: F401
+import typing  # noqa: F401
+import typing_extensions  # noqa: F401
+import uuid  # noqa: F401
+from pandas import DataFrame, concat
+from typing import List
+from pydantic import parse_raw_as
+from varname import nameof
+import pytz
+
+
+from climify_api.apis.PathBase import PathBase  # noqa: F401
+
+from climify_api.exceptions import ApiValueError, ClimifyApiException
+from climify_api.api_client import ClimifyApiResponse, ClimifyApiResponseWithoutDeserialization
+from climify_api.models import SensorDataExtDto
+
+PATH = 'metering-points/{id}'
+
+def convert_values_to_dataFrame(data: List[SensorDataExtDto]) -> DataFrame:
+    """Converts the sensor values to pandas DataFrames inplace.
+
+    :param data: List of sensor data DTOs with sensor data as list of Data models
+    :type data: List[SensorDataExtDto]
+    :return: The list of sensor data with the updated data values
+    :rtype: DataFrame
+    """
+    if len(data) == 0:
+        return data
+    
+    for sensor in data:
+        variables = list(sensor.data[0].values.keys())
+        columns = [nameof(sensor.data[0].time)] + variables
+        values = [[row.time] + [row.values[col] for col in variables] for row in sensor.data]
+        sensor.data = DataFrame(values, columns = columns)
+
+    return data
+
+class GetMeteringPointValuesById(PathBase):
+    def get_metering_point_values_by_id(
+        self,
+        metering_point_id: int,
+        from_datetime: datetime = datetime.today() - relativedelta(month=1),
+        to_datetime: datetime = datetime.today(),
+        as_dataframe: bool = False,
+        access_token: str = None,
+        stream: bool = False,
+        timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
+        skip_deserialization: bool = False,
+    ) -> ClimifyApiResponse[List[SensorDataExtDto]]:
+        """Returns metering values from devices associated with the given metering point.
+
+        from_datetime and to_datetime:
+            The default time period of the data is 3 months. 
+            Thus the sensor period is always the last 3 months unless *both* time period variables are specified.
+            The storage time is 3 years for the data, from_datetime must therefore be later than this point.
+
+        :param metering_point_id: Location identifier
+        :type metering_point_id: int
+        :param from_datetime: Start time for wanted sensor data period
+        :type from_datetime: datetime
+        :param to_datetime: End time for wanted sensor data period
+        :type to_datetime: datetime
+        :param as_dataframe: If True, will convert the data of the devices to pandas DataFrames, defaults to False.
+        :type as_dataframe: bool, optional
+        :param access_token: Access token to use for the request
+        :type access_token: str, optional
+        :param stream: Toggles streaming, defaults to False
+        :type stream: bool, optional
+        :param timeout: How long to wait for a request in seconds, defaults to None
+        :type timeout: typing.Optional[typing.Union[int, typing.Tuple]], optional
+        :param skip_deserialization: Toggles whether or not to skip deserialize of the byte response, defaults to False
+        :type skip_deserialization: bool, optional
+
+        :raises ApiValueError: Will be raised if invalid inputs are provided
+        :raises ClimifyApiException: Will be raised if an error occurred while calling the API
+
+        :return: A response with a body containing the list of devices with their data
+        :rtype: ClimifyApiResponse[List[SensorDataExtDto]]
+        """
+        # Validate input
+        if metering_point_id is None:
+            raise ApiValueError("Location id was given as None. A valid location id must be provided.")
+
+        if from_datetime > to_datetime:
+            raise ApiValueError(f'Given {nameof(from_datetime)} was later than the given {nameof(to_datetime)}. Please provide a valid time period.')
+
+        if from_datetime.tzinfo != pytz.UTC:
+            from_datetime = from_datetime.astimezone(pytz.UTC)
+        
+        if to_datetime.tzinfo != pytz.UTC:
+            to_datetime = to_datetime.astimezone(pytz.UTC)
+
+        if from_datetime < datetime.now(pytz.UTC) - relativedelta(years=3):
+            raise ApiValueError(f'The given value of {nameof(from_datetime)} is longer than 3 years ago. Data storage limit is 3 years, please provide a value within this limit.')
+
+        # Make rest request
+        usedPath = PATH.replace('{id}',str(metering_point_id))
+
+        requests = []
+        subRequestToTime = to_datetime
+        subRequestFromTime = max(subRequestToTime - relativedelta(months=3), from_datetime)
+
+        while subRequestFromTime >= from_datetime:
+            query_parameters = []
+            for name, value in (
+                ('dateTimeFrom', subRequestFromTime.replace(tzinfo=None).isoformat()+'Z' if subRequestFromTime else None), # Sets timezone to None, to remove +HH:MM
+                ('dateTimeTo', subRequestToTime.replace(tzinfo=None).isoformat()+'Z' if subRequestToTime else None)
+            ):
+                if value:
+                    query_parameters.append(f"{name}={value}")
+
+            if len(query_parameters) > 0:
+                requests.append("?" + "&".join(query_parameters))
+
+            if subRequestFromTime == from_datetime:
+                break
+
+            subRequestToTime = subRequestFromTime - relativedelta(seconds=1)
+            subRequestFromTime = max(subRequestToTime - relativedelta(months=3), from_datetime)
+            
+        bodies = []
+        for request in requests:
+            requestPath = usedPath+request
+            response = self.api_client.call_api(
+                resource_path=requestPath,
+                method='GET',
+                access_token=access_token,
+                stream=stream,
+                timeout=timeout
+            )
+
+            # Format response
+            if not 200 <= response.status <= 299:
+                raise ClimifyApiException(
+                    status=response.status,
+                    reason=response.reason,
+                    api_response=response
+                )
+        
+            if skip_deserialization:
+                bodies.append(response.data)
+                continue
+            
+            deserialized_body = parse_raw_as(List[SensorDataExtDto],response.data) if response.data\
+                                else []
+            
+            # Sort observations on time
+            for sensor in deserialized_body:
+                sensor.data = sorted(sensor.data, key=lambda x: x.time, reverse=True)
+
+            if as_dataframe:
+                deserialized_body = convert_values_to_dataFrame(deserialized_body)
+            
+            bodies.append(deserialized_body)
+
+        if skip_deserialization:
+            response.data = bodies
+            return ClimifyApiResponseWithoutDeserialization(response=response)
+
+        sensors = {}
+        for body in bodies:
+            for sensor in body:
+                if sensor.devId not in sensors:
+                    sensors[sensor.devId] = sensor
+                    continue
+
+                sensor_data = sensors[sensor.devId]
+                if as_dataframe:
+                    sensor_data.data = concat([sensor_data.data, sensor.data], ignore_index=True)
+                else:
+                    sensor_data.data += sensor.data
+
+        deserialized_body = list(sensors.values())
+
+        return ClimifyApiResponse[List[SensorDataExtDto]](
+            response=response,
+            status=response.status,
+            body=deserialized_body,
+            headers=response.headers
+        )

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api/models/__init__.py

@@ -183,6 +183,14 @@ class DeviceDto(BaseModel):
     resources: Optional[List[DeviceResourceDto]] = []
     historySyncedAt: Optional[datetime] = None
 
+class MeteringPointDto(BaseModel):
+    id: Optional[int] = None
+    externalId: constr(min_length=0, max_length=100)
+    deviceModel: DeviceModelDto
+    alias: Optional[constr(min_length=0, max_length=100)] = None
+    integration: Optional[IntegrationDto] = None
+    resources: Optional[List[DeviceResourceDto]] = []
+    historySyncedAt: Optional[datetime] = None
 
 class DeviceResourceDto(BaseModel):
     id: Optional[int] = None
@@ -207,6 +215,7 @@ LocationDto.update_forward_refs()
 LocationProfileDto.update_forward_refs()
 OrganisationDto.update_forward_refs()
 DeviceDto.update_forward_refs()
+MeteringPointDto.update_forward_refs()
 
 # Feedback forms
 class FormQuestionBase(BaseModel):

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: climify_api
-Version: 1.0.26
+Version: 1.0.28
 Summary: A wrapper library for the Climify REST API
 Author-email: Climify Aps <info@climify.com>
 Project-URL: Homepage, https://gitlab.climify.com/climify/python-api-lib

{climify_api-1.0.26 → climify_api-1.0.28}/src/climify_api.egg-info/SOURCES.txt

@@ -24,6 +24,8 @@ src/climify_api/apis/v1/paths/buildings_id/__init__.py
 src/climify_api/apis/v1/paths/buildings_id/get.py
 src/climify_api/apis/v1/paths/buildings_id_devices/__init__.py
 src/climify_api/apis/v1/paths/buildings_id_devices/get.py
+src/climify_api/apis/v1/paths/buildings_id_metering_points/__init__.py
+src/climify_api/apis/v1/paths/buildings_id_metering_points/get.py
 src/climify_api/apis/v1/paths/devices_id/__init__.py
 src/climify_api/apis/v1/paths/devices_id/get.py
 src/climify_api/apis/v1/paths/feedback_forms_id_locations_id_responses/__init__.py
@@ -40,6 +42,8 @@ src/climify_api/apis/v1/paths/maps_id/__init__.py
 src/climify_api/apis/v1/paths/maps_id/get.py
 src/climify_api/apis/v1/paths/maps_id_devices/__init__.py
 src/climify_api/apis/v1/paths/maps_id_devices/get.py
+src/climify_api/apis/v1/paths/metering_points_id/__init__.py
+src/climify_api/apis/v1/paths/metering_points_id/get.py
 src/climify_api/apis/v1/paths/organisations_id/__init__.py
 src/climify_api/apis/v1/paths/organisations_id/get.py
 src/climify_api/apis/v1/paths/organisations_id_devices/__init__.py