(20241202) Testing out the modified auth process.

models/data/mail/sync.py

@@ -6,12 +6,11 @@
 
     DATE:
 
-        Wednesday, 27th Nov., 2024.
+        Monday, 2nd Dec., 2024.
 
     OBJECTIVE:
 
-        To provide the structure for the request and response of the APIs that will be used to request OAuth2.0
-        authorization for mail services.
+        To provide the structure for the request that will come in to sync the mails of a particular user.
 
     REFERENCES:
 
@@ -37,11 +36,15 @@ sys.path.append(".")
 sys.path.append("..")
 
 # For making data behaviour_models:
-from pydantic import BaseModel, Field, field_validator
+from pydantic import BaseModel, Field, field_validator, PastDatetime
 from typing import Optional, Literal
 
 # My utils:
 from utils_v2.string import regex
+from utils_v2.date_time import date_time
+
+# To work with date and time:
+import datetime
 
 
 #   *****************************************************************************************************************
@@ -72,7 +75,7 @@ REGEX_SESSION_TOKEN = r"^[a-f0-9]{8}-[a-f0-9]{4}-[1-5][a-f0-9]{3}-[89ab][a-f0-9]
 #   *****************************************************************************************************************
 
 
-class OAuthMailAuthorizationRequestHeaders(BaseModel):
+class MailSyncRequestHeaders(BaseModel):
 
     sessionToken: str = Field(
         description = "the session token of the user who is requesting the service",
@@ -96,10 +99,23 @@ class OAuthMailAuthorizationRequestHeaders(BaseModel):
 # ---------------------------------------------------------------------------------------------------------------------
 
 
-class OAuthMailAuthorizationRequestData(BaseModel):
+class MailSyncRequestData(BaseModel):
 
-    mailClient: Literal["gmail"] = Field(
-        description = "the e-mail provider like 'gmail'",
+    maxCount: int = Field(
+        description = "the max. no. of e-mails to sync at a given time",
+        default = 100,
+        frozen = True
+    )
+
+    startDate: PastDatetime = Field(
+        description = "the starting date from which the user wants to sync their mail",
+        default_factory = lambda: date_time.get_current_utc_date_time() - datetime.timedelta(days = 1),
+        frozen = True
+    )
+
+    endDate: PastDatetime = Field(
+        description = "the ending date till which the user wants to sync their mail",
+        default_factory = lambda: date_time.get_current_utc_date_time() - datetime.timedelta(seconds = 1),
         frozen = True
     )
 
@@ -115,9 +131,13 @@ class OAuthMailAuthorizationRequestData(BaseModel):
     # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
     # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
 
-    @field_validator("mailClient", mode = "before")
-    def to_lowercase(cls, value):
-        if isinstance(value, str): value = value.strip().lower()
+    @field_validator("startDate", "endDate", mode = "before")
+    def to_datetime(cls, value):
+        if not isinstance(value, datetime.datetime):
+            value = date_time.parse_date_time(
+                input_value = value,
+                timezone = date_time.TIMEZONE_UTC
+            )
         return value