0.5.4: Allow empty responses in message list

Author: nanomad

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "saic_ismart_client_ng"
 homepage = "https://github.com/SAIC-iSmart-API/saic-python-client-ng"
-version = "0.5.3"
+version = "0.5.4"
 description = "SAIC next gen client library (MG iSMART)"
 authors = [
     "Giovanni Condello <[email protected]>",

src/saic_ismart_client_ng/api/base.py

@@ -70,6 +70,7 @@ async def execute_api_call(
             out_type: Optional[Type[T]] = None,
             params: Optional[QueryParamTypes] = None,
             headers: Optional[HeaderTypes] = None,
+            allow_null_body: bool = False,
     ) -> Optional[T]:
         try:
             return await self.__execute_api_call(
@@ -79,7 +80,8 @@ async def execute_api_call(
                 form_body=form_body,
                 out_type=out_type,
                 params=params,
-                headers=headers
+                headers=headers,
+                allow_null_body=allow_null_body
             )
         except SaicApiException as e:
             raise e
@@ -96,12 +98,13 @@ async def __execute_api_call(
             out_type: Optional[Type[T]] = None,
             params: Optional[QueryParamTypes] = None,
             headers: Optional[HeaderTypes] = None,
+            allow_null_body: bool = False,
     ) -> Optional[T]:
         url = f"{self.__configuration.base_uri}{path[1:] if path.startswith('/') else path}"
         json_body = asdict(body) if body else None
         req = httpx.Request(method, url, params=params, headers=headers, data=form_body, json=json_body)
         response = await self.__api_client.send(req)
-        return await self.__deserialize(req, response, out_type)
+        return await self.__deserialize(req, response, out_type, allow_null_body)
 
     async def execute_api_call_with_event_id(
             self,
@@ -139,7 +142,8 @@ async def __deserialize(
             self,
             request: httpx.Request,
             response: httpx.Response,
-            data_class: Optional[Type[T]]
+            data_class: Optional[Type[T]],
+            allow_null_body: bool
     ) -> Optional[T]:
 
         try:
@@ -187,6 +191,8 @@ async def __deserialize(
                     return json_data['data']
                 else:
                     return dacite.from_dict(data_class, json_data['data'])
+            elif allow_null_body:
+                return None
             else:
                 raise SaicApiException(f"Failed to deserialize response, missing 'data' field: {response.text}")
 

src/saic_ismart_client_ng/api/message/__init__.py

@@ -5,16 +5,16 @@
 
 
 class SaicMessageApi(AbstractSaicApi):
-    async def get_alarm_list(self, *, page_num: int, page_size: int) -> MessageResp:
+    async def get_alarm_list(self, *, page_num: int, page_size: int) -> Optional[MessageResp]:
         return await self.get_message_list(page_num=page_num, page_size=page_size, message_group='ALARM')
 
-    async def get_command_list(self, *, page_num: int, page_size: int) -> MessageResp:
+    async def get_command_list(self, *, page_num: int, page_size: int) -> Optional[MessageResp]:
         return await self.get_message_list(page_num=page_num, page_size=page_size, message_group='COMMAND')
 
-    async def get_news_list(self, *, page_num: int, page_size: int) -> MessageResp:
+    async def get_news_list(self, *, page_num: int, page_size: int) -> Optional[MessageResp]:
         return await self.get_message_list(page_num=page_num, page_size=page_size, message_group='NEWS')
 
-    async def get_message_list(self, *, page_num: int, page_size: int, message_group: str) -> MessageResp:
+    async def get_message_list(self, *, page_num: int, page_size: int, message_group: str) -> Optional[MessageResp]:
         return await self.execute_api_call(
             "GET",
             "/message/list",
@@ -23,7 +23,8 @@ async def get_message_list(self, *, page_num: int, page_size: int, message_group
                 "pageSize": page_size,
                 "messageGroup": message_group,
             },
-            out_type=MessageResp
+            out_type=MessageResp,
+            allow_null_body=True
         )
 
     async def delete_all_alarms(self):
@@ -55,9 +56,10 @@ async def update_message_status(self, data: UpateMessageRequest):
             body=data,
         )
 
-    async def get_unread_messages_count(self) -> MessageResp:
+    async def get_unread_messages_count(self) -> Optional[MessageResp]:
         return await self.execute_api_call(
             "GET",
             "/message/unreadCount",
-            out_type=MessageResp
+            out_type=MessageResp,
+            allow_null_body=True
         )