feat(timeline): add endpoint to retrieve timeline of a household

Author: fabieu

surehub_api/entities/enums.py

@@ -84,6 +84,7 @@ class DoorSide(IntEnum):
 
 
 class DoorStatus(IntEnum):
+    VALUE_0 = 0
     VALUE_4 = 4
     VALUE_6 = 6
     VALUE_8 = 8

surehub_api/routers/households.py

@@ -5,7 +5,7 @@
 
 from surehub_api.entities import official
 from surehub_api.entities.openapi import Tags
-from surehub_api.services import households, reports
+from surehub_api.services import households, reports, timeline
 
 router = APIRouter(
     prefix="/households",
@@ -70,3 +70,9 @@ async def get_devices_of_household(household_id: int) -> List[official.Device]:
             response_model_exclude_none=True)
 async def get_device_of_household(household_id: int, device_id: int) -> official.Device:
     return households.get_device_of_household(household_id, device_id)
+
+
+@router.get("/{household_id}/timeline",
+            response_model_exclude_none=True)
+async def get_timeline_of_household(household_id: int) -> list[official.Timeline]:
+    return timeline.get_timeline_of_household(household_id)

surehub_api/services/timeline.py

@@ -1,17 +1,17 @@
 import math
-from typing import Any
 
 from fastapi import HTTPException
 
 from surehub_api.config import settings
+from surehub_api.entities import official
 from surehub_api.services import api
 from surehub_api.utils import response_handler
 
 
-def get_timeline_of_household(household_id: int) -> list[dict[str, Any]]:
+def get_timeline_of_household(household_id: int) -> list[official.Timeline]:
     uri = f"{settings.endpoint}/api/timeline/household/{household_id}"
 
-    result = []
+    result: list[official.Timeline] = []
     fetch_size = 100
 
     response = api.get(uri)
@@ -27,6 +27,6 @@ def get_timeline_of_household(household_id: int) -> list[dict[str, Any]]:
     for i in range(1, request_count + 1):
         payload = {'page_size': fetch_size, 'page': i}
         response2 = api.get(uri, params=payload)
-        result += response_handler.parse(response2)
+        result += response_handler.parse(response2, model=list[official.Timeline])
 
     return result