Merge pull request #2 from Ifechukwu001/feat/user-kyc

KYC and NOK Management

Author: Ifechukwu001

src/__init__.py

@@ -1,5 +1,5 @@
 __name__ = "df-wallet-user-service"
 __display_name__ = "DF Wallet User Service API"
 __description__ = "Developers Foundry Wallet System User Service RESTful API"
-__version__ = "1.1.0"
+__version__ = "1.2.0"
 __author__ = "Ogidi Ifechukwu ([email protected])"

src/api/constants/activity_types.py

@@ -17,6 +17,10 @@ class ActivityTypes(TypedDict):
     LIST_WITHDRAW_ACCOUNTS: str
     FETCH_WITHDRAW_ACCOUNT: str
     DELETE_WITHDRAW_ACCOUNT: str
+    FETCH_NOK: str
+    UPDATE_NOK: str
+    FETCH_KYC: str
+    UPDATE_KYC: str
 
 
 ACTIVITY_TYPES: ActivityTypes = {
@@ -35,6 +39,10 @@ class ActivityTypes(TypedDict):
     "LIST_WITHDRAW_ACCOUNTS": "List withdraw accounts",
     "FETCH_WITHDRAW_ACCOUNT": "Get withdraw account",
     "DELETE_WITHDRAW_ACCOUNT": "Delete withdraw account",
+    "FETCH_NOK": "Fetch Next Of Kin",
+    "UPDATE_NOK": "Update Next Of Kin",
+    "FETCH_KYC": "Fetch KYC Information",
+    "UPDATE_KYC": "Update KYC Information",
 }
 
 __all__ = ["ACTIVITY_TYPES"]

src/api/constants/messages.py

@@ -40,9 +40,20 @@ class AccountMessages(TypedDict):
     UPDATED: str
 
 
+class NextOfKinMessages(TypedDict):
+    FETCHED: str
+    UPDATED: str
+
+
+class KYCInformationMessages(TypedDict):
+    FETCHED: str
+    UPDATED: str
+
+
 class CommonMessages(TypedDict):
     INTERNAL_SERVER_ERROR: str
     JWT_GENERATED: str
+    VALIDATION_ERROR: str
 
 
 class Messages(TypedDict):
@@ -51,6 +62,8 @@ class Messages(TypedDict):
     OTP: OtpMessages
     USER: UserMessages
     ACCOUNT: AccountMessages
+    NOK: NextOfKinMessages
+    KYC: KYCInformationMessages
     COMMON: CommonMessages
 
 
@@ -104,13 +117,22 @@ class DynamicMessages(TypedDict):
         "SAVED": "Withdrawal account details saved succesfully",
         "UPDATED": "User Withdraw account updated successfully",
     },
+    "NOK": {
+        "FETCHED": "Next of Kin fetched successfully",
+        "UPDATED": "Next of Kin updated successfully",
+    },
+    "KYC": {
+        "FETCHED": "KYC Information fetched successfully",
+        "UPDATED": "KYC Information updated successfully",
+    },
     "COMMON": {
         "INTERNAL_SERVER_ERROR": "Something went wrong",
         "JWT_GENERATED": "JWT was generated",
+        "VALIDATION_ERROR": "Validation errors",
     },
 }
 
-DYNAMIC_MESSSAGES: DynamicMessages = {
+DYNAMIC_MESSAGES: DynamicMessages = {
     "COMMON": {
         "FETCHED_SUCCESS": lambda x: f"{x} fetched successfully",
         "FETCHED_FAILED": lambda x: f"{x} fetch failed",
@@ -122,4 +144,4 @@ class DynamicMessages(TypedDict):
     },
 }
 
-__all__ = ["DYNAMIC_MESSSAGES", "MESSAGES"]
+__all__ = ["DYNAMIC_MESSAGES", "MESSAGES"]

src/api/controllers/UserController.py

@@ -3,6 +3,7 @@
 
 from src.utils.svcs import Service
 from src.utils.logger import Logger
+from src.api.constants.messages import MESSAGES, DYNAMIC_MESSAGES
 from src.api.services.UserService import UserService
 from src.api.utils.response_format import error_response, success_response
 from src.api.models.payload.requests.Pin import Pin
@@ -21,17 +22,17 @@ async def get_user(self, id: str) -> tuple:
         user = await self.user_service.get_user_information(id)
         if not user:
             return error_response(
-                message="User does not exists", status_code=HTTPStatus.NOT_FOUND
+                message=MESSAGES["USER"]["DOESNT_EXIST"],
+                status_code=HTTPStatus.NOT_FOUND,
             )
         return success_response(
-            message="Successfully retrieved user detail",
+            message=DYNAMIC_MESSAGES["COMMON"]["FETCHED_SUCCESS"]("User"),
             data=user,
             status_code=HTTPStatus.OK,
         )
 
     async def update_user(self, id: str, user_data: UpdateUserRequest) -> tuple:
-        user_data._id = id
-        updated_user = await self.user_service.update(user_data)
+        updated_user = await self.user_service.update(id, user_data)
         if not updated_user["is_success"]:
             return error_response(
                 message=updated_user["message"], status_code=HTTPStatus.BAD_REQUEST

src/api/controllers/UserKYCController.py

@@ -0,0 +1,38 @@
+from http import HTTPStatus
+from typing import Annotated
+
+from src.utils.svcs import Service
+from src.utils.logger import Logger
+from src.api.constants.messages import DYNAMIC_MESSAGES
+from src.api.utils.response_format import error_response, success_response
+from src.api.services.UserKYCService import UserKYCService
+from src.api.models.payload.requests.UserKYCRequest import UserKYCRequest
+
+
+@Service()
+class UserKYCController:
+    def __init__(
+        self,
+        logger: Annotated[Logger, "UserKYCController"],
+        kyc_service: UserKYCService,
+    ) -> None:
+        self.logger = logger
+        self.kyc_service = kyc_service
+
+    async def get_user_kyc(self, user_id: str) -> tuple:
+        kyc = await self.kyc_service.fetch_details(user_id)
+        return success_response(
+            message=DYNAMIC_MESSAGES["COMMON"]["FETCHED_SUCCESS"]("KYC Information"),
+            data=kyc,
+            status_code=HTTPStatus.OK,
+        )
+
+    async def update_user_kyc(self, user_id: str, kyc_details: UserKYCRequest) -> tuple:
+        updated_kyc = await self.kyc_service.update_details(user_id, kyc_details)
+        if not updated_kyc["is_success"]:
+            return error_response(
+                message=updated_kyc["message"], status_code=HTTPStatus.BAD_REQUEST
+            )
+        return success_response(
+            message=updated_kyc["message"], status_code=HTTPStatus.OK
+        )

src/api/controllers/UserNOKController.py

@@ -0,0 +1,38 @@
+from http import HTTPStatus
+from typing import Annotated
+
+from src.utils.svcs import Service
+from src.utils.logger import Logger
+from src.api.constants.messages import DYNAMIC_MESSAGES
+from src.api.utils.response_format import error_response, success_response
+from src.api.services.UserNOKService import UserNOKService
+from src.api.models.payload.requests.UserNOKRequest import UserNOKRequest
+
+
+@Service()
+class UserNOKController:
+    def __init__(
+        self,
+        logger: Annotated[Logger, "UserNOKController"],
+        nok_service: UserNOKService,
+    ) -> None:
+        self.logger = logger
+        self.nok_service = nok_service
+
+    async def get_user_nok(self, user_id: str) -> tuple:
+        nok = await self.nok_service.fetch_details(user_id)
+        return success_response(
+            message=DYNAMIC_MESSAGES["COMMON"]["FETCHED_SUCCESS"]("Next of Kin"),
+            data=nok,
+            status_code=HTTPStatus.OK,
+        )
+
+    async def update_user_nok(self, user_id: str, nok_details: UserNOKRequest) -> tuple:
+        updated_nok = await self.nok_service.update_details(user_id, nok_details)
+        if not updated_nok["is_success"]:
+            return error_response(
+                message=updated_nok["message"], status_code=HTTPStatus.BAD_REQUEST
+            )
+        return success_response(
+            message=updated_nok["message"], status_code=HTTPStatus.OK
+        )

src/api/models/payload/requests/UpdateUserRequest.py

@@ -4,7 +4,6 @@
 
 
 class UpdateUserRequest(BaseModel):
-    _id: str
     first_name: str | None = None
     last_name: str | None = None
     address: str | None = None

src/api/models/payload/requests/UserKYCRequest.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+from src.api.enums.DocumentType import DocumentType
+
+
+class UserKYCRequest(BaseModel):
+    bvn: str | None = None
+    document_type: DocumentType | None = None
+    document_id: str | None = None

src/api/models/payload/requests/UserNOKRequest.py

@@ -0,0 +1,12 @@
+from pydantic import EmailStr, BaseModel
+
+from src.api.enums.NextOfKinRelationship import NextOfKinRelationship
+
+
+class UserNOKRequest(BaseModel):
+    first_name: str | None = None
+    last_name: str | None = None
+    address: str | None = None
+    phone_number: str | None = None
+    email: EmailStr | None = None
+    relationship: NextOfKinRelationship | None = None

src/api/models/payload/responses/UserKYC.py

@@ -0,0 +1,23 @@
+from ninja import ModelSchema
+
+from src.api.models.postgres import UserKYCInformation
+
+
+class UserKYCResponse(ModelSchema):
+    class Meta:
+        model = UserKYCInformation
+        fields = (
+            "id",
+            "bvn",
+            "is_bvn_verified",
+            "document_type",
+            "document_id",
+            "is_document_verified",
+        )
+        fields_optional = (
+            "bvn",
+            "is_bvn_verified",
+            "document_type",
+            "document_id",
+            "is_document_verified",
+        )