(20241218) Can now send tags to apply with the payment request itself, and can even update tags later.

models/api/finstitutions/payments/request.py

@@ -37,7 +37,7 @@ sys.path.append("..")
 
 # For making data behaviour_models:
 from pydantic import BaseModel, Field, field_validator, PastDatetime
-from typing import Optional, Literal, Union
+from typing import Optional, Literal, Union, List, Any
 
 # My utils:
 from utils_v2.string import regex
@@ -188,6 +188,11 @@ class PGPaymentRequestData(BaseModel):
         frozen = True
     )
 
+    tags: List[Any] = Field(
+        description = "any no. of tags to apply to this payment record to make search and filtering easy later",
+        default = None
+    )
+
     # ┏┓    ┏•
     # ┃ ┏┓┏┓╋┓┏┓
     # ┗┛┗┛┛┗┛┗┗┫
@@ -213,6 +218,10 @@ class PGPaymentRequestData(BaseModel):
         if currency is None: raise ValueError("invalid currency code, please use iso 4217 standard")
         return value
 
+    @field_validator("tags", mode = "before")
+    def null_to_empty_list(cls, value):
+        return [] if value is None else value
+
 
 # ---------------------------------------------------------------------------------------------------------------------
 

models/api/finstitutions/payments/tags.py

@@ -0,0 +1,139 @@
+"""
+
+    AUTHOR:
+
+        Khushal P Soonderji
+
+    DATE:
+
+        Wednesday, 18th Dec., 2024.
+
+    OBJECTIVE:
+
+        To provide a structure to work with the tags on payment records.
+
+    REFERENCES:
+
+        N/A
+
+    DOWNLOADS:
+
+        N/A
+
+"""
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                   IMPORT                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# To make sibling directories accessible for imports:
+import sys
+sys.path.append(".")
+sys.path.append("..")
+
+# For making data behaviour_models:
+from pydantic import BaseModel, Field, field_validator, PastDatetime
+from typing import Optional, Literal, List, Any
+
+# My utils:
+from utils_v2.string import regex
+from utils_v2.date_time import date_time
+
+# To work with date and time:
+import datetime
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                           MACROS / ONE-TIME INIT                                              ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# RegEx Patterns:
+REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$"
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                VARIABLES                                                      ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+# --- Nothing Yet
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                                  FUNCTIONS                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+class PGPaymentUpdateTagsRequestHeaders(BaseModel):
+
+    sessionToken: str = Field(
+        description = "the session token of the user who is requesting the service",
+        pattern = REGEX_SESSION_TOKEN,
+        frozen = True,
+        alias = "X-Session-Token"
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "allow"
+
+    def model_dump(self, *args, **kwargs):
+        return super().model_dump(*args, by_alias = True, **kwargs)
+
+
+# ---------------------------------------------------------------------------------------------------------------------
+
+
+class PGPaymentUpdateTagsRequestData(BaseModel):
+
+    paymentId: str = Field(
+        description = "the identifier (Mongo ObjectId) of the document that holds the payment record",
+        frozen = True
+    )
+
+    unsetTags: List[Any] | None = Field(
+        description = "the list of tags to remove from the mail",
+        frozen = True,
+        default = None
+    )
+
+    setTags: List[Any] | None = Field(
+        description = "the list of tags to add to the mail",
+        frozen = True,
+        default = None
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "forbid"
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass