✨ Add consumption breakdown

Author: MateoGreil

README.md

@@ -10,9 +10,11 @@ The client currently supports the following methods:
 - `get_authenticated_user(self)`: Retrieves information about the authenticated user.
 - `get_sites(self)`: Retrieves a list of sites associated with the authenticated user.
 - `get_site_networks_ts_time_ago(self, site_id, measure_kind = "VIRTUAL_QUANTITY", aggregation_level = "HOUR", aggregation_type = "SUM", time_ago_unit = "DAY", time_ago_value = 1)`: Retrieves the time series data for the networks of a specific site, based on the provided parameters.
+- `get_site_consumption_breakdown_time_ago(self, site_id, aggregation_level = "HOUR", time_ago_unit = "DAY", time_ago_value = 1)` Retrieves the consumption breakdown data for a specific site, based on the provided parameters.
 - `get_devices(self, site_id)`: Retrieves a list of devices for the specified site.
 - `get_device_ts_time_ago(self, device_id, measure_kind = "FLOW", aggregation_level = "HOUR", aggregation_type = "MAX", time_ago_unit = "DAY", time_ago_value = "1")`: Retrieves the time series data for a specific device, based on the provided parameters.
 
+
 ## Installation
 You can install the Comwatt Python Client using pip. Run the following command:
 
@@ -47,6 +49,10 @@ print(sites)
 networks_time_series_data = client.get_site_networks_ts_time_ago(sites[0]['id'])
 print(networks_time_series_data)
 
+# Get the consumption breakdown data for a specific site, based on the provided parameters.
+consumption_breakdown_data = client.get_site_consumption_breakdown_time_ago(sites[0]['id'])
+print(consumption_breakdown_data)
+
 # Get a list of devices for a specific site
 devices = client.get_devices(sites[0]['id'])
 print(devices)

src/client.py

@@ -89,84 +89,118 @@ def get_sites(self):
         else:
             raise Exception(f'Error retrieving sites: {response.sttaus_code}')
 
-    def get_devices(self, site_id):
+
+    def get_site_networks_ts_time_ago(self, site_id,
+            measure_kind = "VIRTUAL_QUANTITY",
+            aggregation_level = "HOUR",
+            aggregation_type = "SUM",
+            time_ago_unit = "DAY",
+            time_ago_value = 1):
         """
-        Retrieves a list of devices for the specified site.
+        Retrieves the time series data for the networks of a specific site, based on the provided parameters.
 
         Args:
             site_id (str): The ID of the site.
+            measure_kind (str): The kind of measure (default: "VIRTUAL_QUANTITY").
+            aggregation_level (str): The aggregation level (default: "HOUR").
+            aggregation_type (str): The aggregation type (default: "SUM").
+            time_ago_unit (str): The unit of time ago (default: "DAY").
+            time_ago_value (int): The value of time ago (default: 1).
 
         Returns:
-            list: A list of devices.
+            dict: The time series data.
 
         Raises:
-            Exception: If an error occurs while retrieving the devices.
+            Exception: If an error occurs while retrieving the data.
 
         """
 
-        url = f'{self.base_url}/devices?siteId={site_id}'
+        url = (f'{self.base_url}/aggregations/site-networks-ts-time-ago?'
+               f'siteId={site_id}&'
+               f'measureKind={measure_kind}&'
+               f'aggregationLevel={aggregation_level}&'
+               f'aggregationType={aggregation_type}&'
+               f'timeAgoUnit={time_ago_unit}&'
+               f'timeAgoValue={time_ago_value}')
 
         response = self.session.get(url)
         if response.status_code == 200:
             return response.json()
         else:
-            raise Exception(f'Error retrieving sites: {response.sttaus_code}')
+            raise Exception(f'Error retrieving aggregations: {response.status_code}')
 
-    def get_device_ts_time_ago(self, device_id,
-            measure_kind = "FLOW",
+    def get_site_consumption_breakdown_time_ago(self, site_id,
             aggregation_level = "HOUR",
-            aggregation_type = "MAX",
             time_ago_unit = "DAY",
-            time_ago_value = "1"):
+            time_ago_value = 1):
         """
-        Retrieves the time series data for a specific device, based on the provided parameters.
+        Retrieves the consumption breakdown data for a specific site, based on the provided parameters.
 
         Args:
-            device_id (str): The ID of the device.
-            measure_kind (str): The kind of measure (default: "FLOW").
+            site_id (str): The ID of the site.
             aggregation_level (str): The aggregation level (default: "HOUR").
-            aggregation_type (str): The aggregation type (default: "MAX").
             time_ago_unit (str): The unit of time ago (default: "DAY").
-            time_ago_value (str): The value of time ago (default: "1").
+            time_ago_value (int): The value of time ago (default: 1).
 
         Returns:
-            dict: The time series data.
+            dict: The consumption breakdown data.
 
         Raises:
             Exception: If an error occurs while retrieving the data.
 
         """
 
-        url = (f'{self.base_url}/aggregations/device-ts-time-ago?'
-               f'deviceId={device_id}&'
-               f'measureKind={measure_kind}&'
-               f'aggregationLevel={aggregation_level}&'
-               f'aggregationType={aggregation_type}&'
-               f'timeAgoUnit={time_ago_unit}&'
-               f'timeAgoValue={time_ago_value}')
+        url = (f'{self.base_url}/aggregations/consumption-breakdown-time-ago?'
+                f'siteId={site_id}&'
+                f'aggregationLevel={aggregation_level}&'
+                f'timeAgoUnit={time_ago_unit}&'
+                f'timeAgoValue={time_ago_value}')
 
         response = self.session.get(url)
         if response.status_code == 200:
             return response.json()
         else:
             raise Exception(f'Error retrieving aggregations: {response.status_code}')
 
-    def get_site_networks_ts_time_ago(self, site_id,
-            measure_kind = "VIRTUAL_QUANTITY",
+    def get_devices(self, site_id):
+        """
+        Retrieves a list of devices for the specified site.
+
+        Args:
+            site_id (str): The ID of the site.
+
+        Returns:
+            list: A list of devices.
+
+        Raises:
+            Exception: If an error occurs while retrieving the devices.
+
+        """
+
+        url = f'{self.base_url}/devices?siteId={site_id}'
+
+        response = self.session.get(url)
+        if response.status_code == 200:
+            return response.json()
+        else:
+            raise Exception(f'Error retrieving sites: {response.sttaus_code}')
+
+    def get_device_ts_time_ago(self, device_id,
+            measure_kind = "FLOW",
             aggregation_level = "HOUR",
-            aggregation_type = "SUM",
+            aggregation_type = "MAX",
             time_ago_unit = "DAY",
-            time_ago_value = 1):
+            time_ago_value = "1"):
         """
-        Retrieves the time series data for the networks of a specific site, based on the provided parameters.
+        Retrieves the time series data for a specific device, based on the provided parameters.
 
         Args:
-            site_id (str): The ID of the site.
-            measure_kind (str): The kind of measure (default: "VIRTUAL_QUANTITY").
+            device_id (str): The ID of the device.
+            measure_kind (str): The kind of measure (default: "FLOW").
             aggregation_level (str): The aggregation level (default: "HOUR").
-            aggregation_type (str): The aggregation type (default: "SUM").
+            aggregation_type (str): The aggregation type (default: "MAX").
             time_ago_unit (str): The unit of time ago (default: "DAY").
-            time_ago_value (int): The value of time ago (default: 1).
+            time_ago_value (str): The value of time ago (default: "1").
 
         Returns:
             dict: The time series data.
@@ -176,8 +210,8 @@ def get_site_networks_ts_time_ago(self, site_id,
 
         """
 
-        url = (f'{self.base_url}/aggregations/site-networks-ts-time-ago?'
-               f'siteId={site_id}&'
+        url = (f'{self.base_url}/aggregations/device-ts-time-ago?'
+               f'deviceId={device_id}&'
                f'measureKind={measure_kind}&'
                f'aggregationLevel={aggregation_level}&'
                f'aggregationType={aggregation_type}&'