Add execute_api_call_with_optional_result and disallow the usage of allow_null_body in execute_api_call

Author: nanomad

src/saic_ismart_client_ng/api/base.py

@@ -106,7 +106,6 @@ async def execute_api_call(
             out_type: type[T],
             params: QueryParamTypes | None = None,
             headers: HeaderTypes | None = None,
-            allow_null_body: bool = False,
     ) -> T:
         result = await self.__execute_api_call(
             method,
@@ -116,13 +115,35 @@ async def execute_api_call(
             out_type=out_type,
             params=params,
             headers=headers,
-            allow_null_body=allow_null_body,
+            allow_null_body=False,
         )
-        if result is None and not allow_null_body:
+        if result is None:
             msg = f"Failed to execute api call {method} {path}, was expecting a result of type {out_type} got None instead"
             raise SaicApiException(msg)
         return result
 
+    async def execute_api_call_with_optional_result(
+            self,
+            method: str,
+            path: str,
+            *,
+            body: Any | None = None,
+            form_body: Any | None = None,
+            out_type: type[T],
+            params: QueryParamTypes | None = None,
+            headers: HeaderTypes | None = None,
+    ) -> T | None:
+        return await self.__execute_api_call(
+            method,
+            path,
+            body=body,
+            form_body=form_body,
+            out_type=out_type,
+            params=params,
+            headers=headers,
+            allow_null_body=True,
+        )
+
     async def execute_api_call_no_result(
             self,
             method: str,
@@ -132,7 +153,6 @@ async def execute_api_call_no_result(
             form_body: Any | None = None,
             params: QueryParamTypes | None = None,
             headers: HeaderTypes | None = None,
-            allow_null_body: bool = False,
     ) -> None:
         await self.__execute_api_call(
             method,
@@ -141,7 +161,7 @@ async def execute_api_call_no_result(
             form_body=form_body,
             params=params,
             headers=headers,
-            allow_null_body=allow_null_body,
+            allow_null_body=True,
         )
 
     async def __execute_api_call(

src/saic_ismart_client_ng/api/message/__init__.py

@@ -39,7 +39,7 @@ async def get_news_list(
     async def get_message_list(
         self, *, page_num: int, page_size: int, message_group: str
     ) -> MessageResp | None:
-        return await self.execute_api_call(
+        return await self.execute_api_call_with_optional_result(
             "GET",
             "/message/list",
             params={
@@ -48,7 +48,6 @@ async def get_message_list(
                 "messageGroup": message_group,
             },
             out_type=MessageResp,
-            allow_null_body=True,
         )
 
     async def delete_all_alarms(self) -> None:
@@ -83,6 +82,6 @@ async def update_message_status(self, data: UpateMessageRequest) -> None:
         )
 
     async def get_unread_messages_count(self) -> MessageResp | None:
-        return await self.execute_api_call(
-            "GET", "/message/unreadCount", out_type=MessageResp, allow_null_body=True
+        return await self.execute_api_call_with_optional_result(
+            "GET", "/message/unreadCount", out_type=MessageResp
         )