(20250625) - Implemented the ecommerce shopify auth integration.

with multiple files added new API for get token details

models/api/common/integrations/auth_get.py

@@ -0,0 +1,141 @@
+"""
+
+    AUTHOR:
+
+        Omkar Khandare
+
+    DATE:
+
+        Wednesday, 25th June., 2025.
+
+    OBJECTIVE:
+
+        To provide a structure to allow users to disable their third-party integration accounts.
+
+    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 MongoDB:
+from bson.objectid import ObjectId
+
+# 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 AuthTokenGetRequestHeaders(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 AuthTokenGetRequestData(BaseModel):
+
+    tokenKey: ObjectId = Field(
+        description = "The token identifier that tell you which account needs to be disabled.",
+        frozen = True,
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "forbid"
+        arbitrary_types_allowed = True
+
+    # ┓┏  ┓• ┓   •
+    # ┃┃┏┓┃┓┏┫┏┓╋┓┏┓┏┓
+    # ┗┛┗┻┗┗┗┻┗┻┗┗┗┛┛┗
+
+    @field_validator("tokenKey", mode = "before")
+    def parse_oid(cls, value):
+        try: value = ObjectId(value)
+        except: value = None
+        return value
+
+
+#   *****************************************************************************************************************
+#  *****                                                                                                          ****
+# ***                                               MAIN PROGRAM                                                    ***
+#  *****                                                                                                          ****
+#   *****************************************************************************************************************
+
+
+if __name__ == "__main__":
+
+    pass

models/api/software/auth.py

@@ -42,7 +42,7 @@ from typing import Optional, Literal, Union
 # Other data models:
 from models.software.tcaoff_ai.auth import TheCAOfficeAIAuth
 from models.software.mikrotik.auth import MikroTikPPPoE1000Auth, MikroTikHotspot1000Auth
-
+from models.software.ecommerce.auth import ShopifyAuth
 # My utils:
 from utils_v2.string import regex
 from utils_v2.date_time import date_time
@@ -105,8 +105,8 @@ class SoftwareAuthRequestHeaders(BaseModel):
 
 class SoftwareAuthRequestData(BaseModel):
 
-    softwareClient: Literal["theCaOfficeAi", "mikrotikPPPoE1000", "mikrotikHotspot1000"] = Field(alias = "client")
-    auth: Union[TheCAOfficeAIAuth, MikroTikPPPoE1000Auth, MikroTikHotspot1000Auth]
+    softwareClient: Literal["theCaOfficeAi", "mikrotikPPPoE1000", "mikrotikHotspot1000", "shopify"] = Field(alias = "client")
+    auth: Union[TheCAOfficeAIAuth, MikroTikPPPoE1000Auth, MikroTikHotspot1000Auth, ShopifyAuth]
 
     # ┏┓    ┏•
     # ┃ ┏┓┏┓╋┓┏┓
@@ -127,7 +127,8 @@ class SoftwareAuthRequestData(BaseModel):
         harmony_map = {
             "theCaOfficeAi": TheCAOfficeAIAuth,
             "mikrotikPPPoE1000": MikroTikPPPoE1000Auth,
-            "mikrotikHotspot1000": MikroTikHotspot1000Auth
+            "mikrotikHotspot1000": MikroTikHotspot1000Auth,
+            "shopify": ShopifyAuth
         }
         if not isinstance(auth, harmony_map[client]):
             raise ValueError(f"incorrect 'auth' for selected client '{client}'")