(20250116) Started upgrading the mail module (to eventually work on cron).

models/finstitutions/trading/symbols.py

@@ -220,6 +220,45 @@ class TradingSymbol(BaseModel):
         return value
 
 
+# ---------------------------------------------------------------------------------------------------------------------
+
+
+class TradingSymbolListBrokerResponse(BaseModel):
+
+    success: bool = Field(
+        description = "whether, or not, the symbol list request was successful",
+        default = False,
+        frozen = False
+    )
+
+    message: str = Field(
+        description = "a brief message to help debug in failed cases",
+        default = "",
+        frozen = False
+    )
+
+    data: List[TradingSymbol] | None = Field(
+        description = "the actual response from the broker with his list of tradeable symbols",
+        default = None,
+        frozen = False
+    )
+
+    exception: Exception | None = Field(
+        description = "if something goes wrong, the exception will be held here",
+        default = None,
+        frozen = False
+    )
+
+    # ┏┓    ┏•
+    # ┃ ┏┓┏┓╋┓┏┓
+    # ┗┛┗┛┛┗┛┗┗┫
+    #          ┛
+
+    class Config:
+        extra = "forbid"
+        arbitrary_types_allowed = True
+
+
 #   *****************************************************************************************************************
 #  *****                                                                                                          ****
 # ***                                               MAIN PROGRAM                                                    ***