(20250121) With APIs to send, list, and update tags on WhatsApp messages (through Nimbus).

2025-01-21 15:27:53 +05:30
parent f94d9e1a4b
commit cadbc19f28
13 changed files with 498 additions and 182 deletions
@@ -36,6 +36,7 @@ sys.path.append(".")
 sys.path.append("..")

 # My async utils:
+from utils_v2.database.async_mysql_v2 import AsyncMySQL
 from utils_v2.database.async_mongo_v2 import AsyncMongo
 from utils_v2.cache.async_redis_cache_v2 import AsyncRedisCache

@@ -44,16 +45,14 @@ from controllers_v2.core.message import CoreMessageController

 # Models:
 from models.core.auth_token import CoreAuthTokenModel
-from models.api.message.sms.send import (
-    NimbusSMSIndiaMessage,
-    SavvyBulkSMSKenyaMessage,
-    SMSSendOneResult,
-    SMSSendManyResults
+from models.message.chat.send import (
+    NimbusWhatsAppMessage,
+    ChatSendOneResult,
+    ChatSendManyResults
 )

-# SMS clients:
-from utils_v2.sms.india.nimbus.controllers.async_nimbus import AsyncNimbusSMS
-from utils_v2.sms.kenya.savvy_bulk_sms.controllers.async_savvy_bulk_sms import AsyncSavvyBulkSMS
+# Chat clients:
+from utils_v2.whatsapp.nimbus.controllers.async_nimbus_whatsapp import AsyncNimbusWhatsapp

 # To work with datatypes:
 from typing import List, Any
@@ -61,6 +60,9 @@ from typing import List, Any
 # To make HTTP requests:
 import httpx

+# to work with MongoDB:
+from bson.objectid import ObjectId
+
 # To make abstract classes:
 from abc import ABC, abstractmethod

@@ -135,7 +137,7 @@ class ChatController(CoreMessageController, ABC):
        # Prepare the combined base filter:
        sms_filter = {}
        for k, v in (base_filter or {}).items(): sms_filter[k] = v
-        sms_filter["serviceType"] = "sms"
+        sms_filter["serviceType"] = "chat"

        # Invoke the parent's constructor:
        CoreMessageController.__init__(
@@ -149,6 +151,94 @@ class ChatController(CoreMessageController, ABC):
            debug_only_errors = debug_only_errors
        )

+    # ┏┓     ┓  ┳┳┓
+    # ┗┓┏┓┏┓┏┫  ┃┃┃┏┓┏┏┏┓┏┓┏┓┏
+    # ┗┛┗ ┛┗┗┻  ┛ ┗┗ ┛┛┗┻┗┫┗ ┛
+    #                     ┛
+
+    @abstractmethod
+    async def send_one_message(
+            self,
+            sql_conn: AsyncMySQL,
+            mongo_data_conn: AsyncMongo,
+            auth_token: CoreAuthTokenModel,
+            client: AsyncNimbusWhatsapp,
+            message: NimbusWhatsAppMessage,
+            tags: List[Any]
+    ) -> ChatSendOneResult:
+
+        """
+        To send one message from the third-party client.
+        :param sql_conn: The connection to the database to use for this operation.
+        :param mongo_data_conn: The connection to the database to use for this operation.
+        :param auth_token: The auth-token model for the account from which the message has to be sent.
+        :param client: The connection/instance of the third-party client to use to perform this operation.
+        :param message: The message that you want to send to the recipient.
+        :param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
+        :return: The structured response model to describe the operation.
+        """
+
+        pass
+
+    @abstractmethod
+    async def send_many_messages(
+            self,
+            sql_conn: AsyncMySQL,
+            mongo_data_conn: AsyncMongo,
+            http_client: httpx.AsyncClient,
+            auth_token: CoreAuthTokenModel,
+            client: AsyncNimbusWhatsapp | None,
+            messages: List[NimbusWhatsAppMessage],
+            tags: List[Any]
+    ) -> ChatSendManyResults:
+
+        """
+        To send many chat messages in one go.
+        :param sql_conn: The connection to the database to use for this operation.
+        :param mongo_data_conn: The connection to the database to use for this operation.
+        :param http_client: An HTTP client to use to make API calls through the third-party client's class.
+        :param auth_token: The auth-token model for the account from which the message has to be sent.
+        :param client: The connection/instance of the third-party client to use to perform this operation.
+        :param messages: The messages that you want to send to the recipients.
+        :param tags: Any tags that you would like to attach to the message. To be used later for internal filtering.
+        :return: The structured response model to describe the operation.
+        """
+
+        pass
+
+    # ┳┳   ┓       ┏┳┓
+    # ┃┃┏┓┏┫┏┓╋┏┓   ┃ ┏┓┏┓┏
+    # ┗┛┣┛┗┻┗┻┗┗    ┻ ┗┻┗┫┛
+    #   ┛                ┛
+
+    # We cannot modify the SMS messages themselves, but we can set/unset tags on them for internal referencing and
+    # filtering. This will help the users organize their inboxes well.
+
+    async def update_chat_message_tags(
+            self,
+            mongo_data_conn: AsyncMongo,
+            message_id: ObjectId | str,
+            unset_tags: List[str] = None,
+            set_tags: List[str] = None
+    ) -> bool:
+
+        """
+        To set and unset tags on one chat message.
+        :param mongo_data_conn: The database connection to use to perform this action.
+        :param message_id: The ObjectId of the document in MongoDb that holds the message.
+        :param unset_tags: The list of tags to unset (done before setting new tags).
+        :param set_tags: The list of tags to set (done after unsetting old tags).
+        :return: True if successful, else False.
+        """
+
+        # Simply call the core model:
+        return await self.update_message_tags(
+            mongo_data_conn = mongo_data_conn,
+            message_id = message_id,
+            unset_tags = unset_tags,
+            set_tags = set_tags
+        )
+

 #   *****************************************************************************************************************
 #  *****                                                                                                          ****