fix(1139): rename forest client integration schema, refs: #1139

server/admin_management/api/app/integration/forest_client_integration.py

@@ -1,8 +1,10 @@
 import logging
 from http import HTTPStatus
+from typing import List
 
 import requests
 from api.config import config
+from api.app.schemas import ForestClientIntegrationFindResponse
 
 LOGGER = logging.getLogger(__name__)
 
@@ -30,7 +32,7 @@ def __init__(self):
         self.session = requests.Session()
         self.session.headers.update(self.headers)
 
-    def find_by_client_number(self, p_client_number: str):
+    def find_by_client_number(self, p_client_number: str) -> List[ForestClientIntegrationFindResponse]:
         """
         Find Forest Client(s) information based on p_client_number search query field.
 

server/admin_management/api/app/schemas.py

@@ -272,8 +272,8 @@ class AdminUserAccessResponse(BaseModel):
     model_config = ConfigDict(from_attributes=True)
 
 
-# ------------------------------------- Forest Client Validator ---------------------------------------- #
-class ForestClientValidationResponse(BaseModel):
+# ------------------------------------- Forest Client API Integraion ---------------------------------------- #
+class ForestClientIntegrationFindResponse(BaseModel):
     clientNumber: str
     clientName: str
     clientStatusCode: str

server/admin_management/api/app/services/validator/forest_client_validator.py

@@ -2,21 +2,21 @@
 from typing import List, Union
 
 from api.app.constants import FOREST_CLIENT_STATUS
-from api.app.schemas import ForestClientValidationResponse
+from api.app.schemas import ForestClientIntegrationFindResponse
 
 
 LOGGER = logging.getLogger(__name__)
 
 
 def forest_client_number_exists(
-    forest_client_find_result: List[ForestClientValidationResponse],
+    forest_client_find_result: List[ForestClientIntegrationFindResponse],
 ) -> bool:
     # Exact client number search - should only contain 1 result.
     return len(forest_client_find_result) == 1
 
 
 def forest_client_active(
-    forest_client_find_result: List[ForestClientValidationResponse],
+    forest_client_find_result: List[ForestClientIntegrationFindResponse],
 ) -> bool:
     return (
         (
@@ -29,7 +29,7 @@ def forest_client_active(
 
 
 def get_forest_client_status(
-    forest_client_find_result: List[ForestClientValidationResponse],
+    forest_client_find_result: List[ForestClientIntegrationFindResponse],
 ) -> Union[str, None]:
     return (
         forest_client_find_result[0][FOREST_CLIENT_STATUS["KEY"]]