chatgraph 0.3.0__py3-none-any.whl → 0.3.4__py3-none-any.whl

chatgraph/types/message_types.py

@@ -1,212 +1,108 @@
-from ..gRPC.gRPCCall import WhatsappServiceClient, UserStateServiceClient
+from typing import Optional, Union
 
-from dataclasses import dataclass
-from typing import Optional
-import json
+messageTypes = Union[str, float, int]
+MessageTypes = (str, float, int)
 
-@dataclass
-class UserState:
+class Message:
     """
-    Representa o estado de um usuário.
+    Representa uma mensagem enviada ou recebida pelo chatbot.
     
     Atributos:
-        customer_id (str): O ID do cliente.
-        menu (str): O menu atual.
-        lst_update (str): A última atualização do menu.
-        obs (dict): Observações adicionais sobre o estado do usuário.
+        message (str): O conteúdo textual da mensagem.
+        absolute_text (bool): Se True, o texto não será modificado.
     """
-    customer_id: str
-    menu: str
-    route: str
-    lst_update: str
-    obs: Optional[dict] = None
-
-
-@dataclass
-class Element:
-    """
-    Representa um elemento de uma lista de opções.
     
-    Atributos:
-        title (str): O título do elemento.
-        description (str): A descrição do elemento.
-    """
-    title: str
-    description: Optional[str] = None
-
-class UserCall:
-    """
-    Representa uma mensagem recebida ou enviada pelo chatbot.
-
-    Atributos:
-        type (str): O tipo da mensagem (por exemplo, texto, imagem, etc.).
-        text (str): O conteúdo textual da mensagem.
-        UserState (UserState): O estado do usuário.
-        channel (str): O canal pelo qual a mensagem foi enviada ou recebida (por exemplo, WhatsApp, SMS, etc.).
-        customer_phone (str): O número de telefone do cliente.
-        company_phone (str): O número de telefone da empresa que está enviando ou recebendo a mensagem.
-        status (Optional[str]): O status da mensagem (por exemplo, enviada, recebida, lida, etc.). Este campo é opcional.
-    """
     def __init__(
-        self,
-        type: str,
-        text: str,
-        user_state: UserState,
-        channel: str,
-        customer_phone: str,
-        company_phone: str,
-        grpc_uri: str,
-        status: Optional[str] = None,
-    ) -> None:
+        self, 
+        text:str,
+        absolute_text: bool = False,
+        ) -> None:
+        self.absolute_text = absolute_text
         
-        self.type = type
+        if not absolute_text:
+            text = text.replace('\t', '')
+            
         self.text = text
-        self.__user_state = user_state
-        self.channel = channel
-        self.customer_phone = customer_phone
-        self.company_phone = company_phone
-        self.status = status
-        
-        self.grpc_uri = grpc_uri
-        
-        self.__wpp_server_client = WhatsappServiceClient(self.grpc_uri)
-        self.__user_state_client = UserStateServiceClient(self.grpc_uri)
 
-    def send_text(self, text:str) -> None:
-        
-        response = self.__wpp_server_client.send_text(
-            {
-                "hook_id": self.company_phone,
-                "enterprise_id": self.customer_phone,
-                "unique_customer_id": self.__user_state.customer_id,
-                "message_text": text
-            }
-        )
-
-        if not response.status:
-            raise ValueError("Erro ao enviar mensagem de texto.")
+class Button:
+    """
+    Representa uma lista rápida de botões.
     
-    def send_button(
+    Atributos:
+        text (str): O texto da mensagem.
+        buttons (list[str]): A lista de botões.
+        title (str): O título da mensagem.
+        caption (str): A legenda da mensagem.
+        absolute_text (bool): Se True, o texto não será modificado.
+    
+    Limitações:
+        O número máximo de botões é 3.
+        O texto do botão deve ter no máximo 20 caracteres.
+    """
+    def __init__(
         self, 
         text:str, 
-        buttons:list, 
-        title: str|None = None,
-        caption: str|None = None,
+        buttons: list[str],
+        title: Optional[str] = None,
+        caption: Optional[str] = None,
+        absolute_text: bool = False,
         ) -> None:
-        if len(buttons) > 3:
-            raise ValueError("O número máximo de botões é 3.")
+        self.absolute_text = absolute_text
         
-        response = self.__wpp_server_client.send_button(
-            {
-                "hook_id": self.company_phone,
-                "enterprise_id": self.customer_phone,
-                "unique_customer_id": self.__user_state.customer_id,
-                "message_text": text,
-                "button_title": title,
-                "message_caption": caption,
-                "message_title": title,
-                "options": [{"title": b} for b in buttons],
-            }
-        )
-
-        if not response.status:
-            raise ValueError("Erro ao enviar mensagem de botões.")
-
-    def send_list(
-        self, 
-        text:str,
-        title: str|None = None,
-        button_title: str|None = None,
-        element_list: list[Element] = None,
-        caption: str|None = None,
-        ) -> None:
+        if not absolute_text:
+            text = text.replace('\t', '')
         
-        if len(element_list) > 20:
-            raise ValueError("O número máximo de elementos é 20.")
+        assert len(buttons) <= 3, "O número máximo de botões é 3."
         
-        response = self.__wpp_server_client.send_list(
-            {
-                "hook_id": self.company_phone,
-                "enterprise_id": self.customer_phone,
-                "unique_customer_id": self.__user_state.customer_id,
-                "message_text": text,
-                "button_title": button_title,
-                "message_caption": caption,
-                "message_title": title,
-                "options": [{"title": e.title, "description": e.description} for e in element_list],
-            }
-        )
+        for button in buttons:
+            assert len(button) <= 20, "O texto do botão deve ter no máximo 20 caracteres."
+        
+        self.text = text
+        self.buttons = buttons
+        self.title = title
+        self.caption = caption
 
-        if not response.status:
-            raise ValueError("Erro ao enviar mensagem de lista.")
+class ListElements:
+    """
+    Representa uma lista de elementos.
     
-    def delete_user_state(self) -> None:
-        response = self.__user_state_client.delete_user_state(self.__user_state.customer_id)
-
-        if not response.status:
-            raise ValueError("Erro ao deletar estado do usuário.")
-
-    def update_user_state(
+    atributos:
+        text (str): O texto da mensagem.
+        title (str): O título da mensagem.
+        button_title (str): O título do botão.
+        elements (list[dict]): A lista de elementos.
+        caption (str): A legenda da mensagem.
+        absolute_text (bool): Se True, o texto não será modificado.
+    
+    Limitações:
+        O número máximo de elementos é 10.
+        O título do elemento deve ter no máximo 24 caracteres.
+        A descrição do elemento deve ter no máximo 72 caracteres.
+    """
+    def __init__(
         self, 
-        menu: str,
-        route: str,
-        obs: dict,
+        text:str,
+        title: Optional[str] = None,
+        button_title: Optional[str] = None,
+        elements: list[dict] = None,
+        caption: Optional[str] = None,
+        absolute_text: bool = False,
         ) -> None:
+        self.absolute_text = absolute_text
         
-        response = self.__user_state_client.update_user_state({
-            "user_id": self.__user_state.customer_id,
-            "menu_id": menu,
-            "route": route,
-            "obs": json.dumps(obs),
-        })
-
-        if not response.status:
-            raise ValueError("Erro ao atualizar estado do usuário.")
-        
-        self.__user_state.menu = menu
-        self.__user_state.route = route
-        self.__user_state.obs = obs
-    
-    @property
-    def menu(self):
-        return self.__user_state.menu
-    
-    @property
-    def route(self):
-        return self.__user_state.route
-    
-    @property
-    def obs(self):
-        return self.__user_state.obs
-    
-    @property
-    def customer_id(self):
-        return self.__user_state.customer_id
-    
-    @menu.setter
-    def menu(self, menu):
+        if not absolute_text:
+            text = text.replace('\t', '')
         
-        self.update_user_state(
-            menu, 
-            self.__user_state.route, 
-            self.__user_state.obs
-        )
-    
-    @route.setter
-    def route(self, route):
+        assert len(elements) <= 10, "O número máximo de elementos é 10."
         
-        self.update_user_state(
-            self.__user_state.menu, 
-            route, 
-            self.__user_state.obs
-        )
-    
-    @obs.setter
-    def obs(self, obs):
+        for key, value in elements.items():
+            assert len(key) <= 24, "O título do elemento deve ter no máximo 24 caracteres."
+            assert len(value) <= 72, "A descrição do elemento deve ter no máximo 72 caracteres."
         
-        self.update_user_state(
-            self.__user_state.menu, 
-            self.__user_state.route, 
-            obs
-        )
-    
+        self.text = text
+        self.title = title
+        self.button_title = button_title
+        self.elements = elements
+        self.caption = caption
+
+

chatgraph/types/request_types.py

@@ -0,0 +1,265 @@
+from ..gRPC.gRPCCall import WhatsappServiceClient, UserStateServiceClient
+from .message_types import Message, Button, ListElements, messageTypes, MessageTypes
+from dataclasses import dataclass
+from typing import Optional
+import json
+
+@dataclass
+class UserState:
+    """
+    Representa o estado de um usuário.
+    
+    Atributos:
+        customer_id (str): O ID do cliente.
+        menu (str): O menu atual.
+        lst_update (str): A última atualização do menu.
+        obs (dict): Observações adicionais sobre o estado do usuário.
+    """
+    customer_id: str
+    menu: str
+    route: str
+    lst_update: str
+    obs: Optional[dict] = None
+
+
+class UserCall:
+    """
+    Representa uma mensagem recebida ou enviada pelo chatbot.
+
+    Atributos:
+        type (str): O tipo da mensagem (por exemplo, texto, imagem, etc.).
+        text (str): O conteúdo textual da mensagem.
+        UserState (UserState): O estado do usuário.
+        channel (str): O canal pelo qual a mensagem foi enviada ou recebida (por exemplo, WhatsApp, SMS, etc.).
+        customer_phone (str): O número de telefone do cliente.
+        company_phone (str): O número de telefone da empresa que está enviando ou recebendo a mensagem.
+        status (Optional[str]): O status da mensagem (por exemplo, enviada, recebida, lida, etc.). Este campo é opcional.
+    """
+    def __init__(
+        self,
+        type: str,
+        text: str,
+        user_state: UserState,
+        channel: str,
+        customer_phone: str,
+        company_phone: str,
+        grpc_uri: str,
+        status: Optional[str] = None,
+    ) -> None:
+        
+        self.type = type
+        self.text = text
+        self.__user_state = user_state
+        self.channel = channel
+        self.customer_phone = customer_phone
+        self.company_phone = company_phone
+        self.status = status
+        
+        self.grpc_uri = grpc_uri
+        
+        self.__wpp_server_client = WhatsappServiceClient(self.grpc_uri)
+        self.__user_state_client = UserStateServiceClient(self.grpc_uri)
+
+    def send(self, message: messageTypes|Message|Button|ListElements) -> None:
+        """
+        Envia uma mensagem ao cliente.
+
+        Args:
+            message (Message|Button|ListElements): A mensagem a ser enviada.
+        """
+        if isinstance(message, MessageTypes):
+            message = Message(message)
+        
+        if isinstance(message, Message):
+            self.__send_text(message.text, message.absolute_text)
+            
+        elif isinstance(message, Button):
+            self.__send_button(
+                message.text, 
+                message.buttons, 
+                message.title, 
+                message.caption
+            )
+            
+        elif isinstance(message, ListElements):
+            self.__send_list(
+                message.text, 
+                message.title, 
+                message.button_title, 
+                message.element_list, 
+                message.caption
+            )
+        else:
+            raise ValueError("Tipo de mensagem inválido.")
+    
+    def __send_text(self, text:str, abs_text:bool=False) -> None:
+        if not abs_text:
+            text = text.replace('\t', '')
+        
+        response = self.__wpp_server_client.send_text(
+            {
+                "hook_id": self.company_phone,
+                "enterprise_id": self.customer_phone,
+                "unique_customer_id": self.__user_state.customer_id,
+                "message_text": text,
+                "platform": self.channel,
+            }
+        )
+
+        if not response.status:
+            raise ValueError("Erro ao enviar mensagem de texto.")
+    
+    def __send_button(
+        self, 
+        text:str, 
+        buttons:list, 
+        title: str|None = None,
+        caption: str|None = None,
+        ) -> None:
+        if len(buttons) > 3:
+            raise ValueError("O número máximo de botões é 3.")
+        
+        response = self.__wpp_server_client.send_button(
+            {
+                "hook_id": self.company_phone,
+                "enterprise_id": self.customer_phone,
+                "unique_customer_id": self.__user_state.customer_id,
+                "message_text": text,
+                "button_title": title,
+                "message_caption": caption,
+                "message_title": title,
+                "options": [{"title": b} for b in buttons],
+            }
+        )
+
+        if not response.status:
+            raise ValueError("Erro ao enviar mensagem de botões.")
+
+    def __send_list(
+        self, 
+        text:str,
+        title: str|None = None,
+        button_title: str|None = None,
+        element_list: list[dict] = None,
+        caption: str|None = None,
+        ) -> None:
+        
+        if len(element_list) > 20:
+            raise ValueError("O número máximo de elementos é 20.")
+        
+        response = self.__wpp_server_client.send_list(
+            {
+                "hook_id": self.company_phone,
+                "enterprise_id": self.customer_phone,
+                "unique_customer_id": self.__user_state.customer_id,
+                "message_text": text,
+                "button_title": button_title,
+                "message_caption": caption,
+                "message_title": title,
+                "options": [{"title": k, "description": v} for k,v in element_list],
+            }
+        )
+
+        if not response.status:
+            raise ValueError("Erro ao enviar mensagem de lista.")
+    
+    def transfer_to_human(self, message:str, campaign_name:str) -> None:
+        response = self.__wpp_server_client.transfer_to_human(
+            {
+                "hook_id": self.company_phone,
+                "enterprise_id": self.customer_phone,
+                "unique_customer_id": self.__user_state.customer_id,
+                "message_text": message,
+                "platform": self.channel,
+                campaign_name: campaign_name,
+            }
+        )
+
+        if not response.status:
+            raise ValueError("Erro ao transferir chat para humano.")
+    
+    def end_chat(self, message:str, campaign_name:str) -> None:
+        response = self.__wpp_server_client.end_chat(
+            {
+                "hook_id": self.company_phone,
+                "enterprise_id": self.customer_phone,
+                "unique_customer_id": self.__user_state.customer_id,
+                "message_text": message,
+                "platform": self.channel,
+                campaign_name: campaign_name,
+            }
+        )
+
+        if not response.status:
+            raise ValueError("Erro ao encerrar chat.")
+    
+    def delete_user_state(self) -> None:
+        response = self.__user_state_client.delete_user_state(self.__user_state.customer_id)
+
+        if not response.status:
+            raise ValueError("Erro ao deletar estado do usuário.")
+
+    def update_user_state(
+        self, 
+        menu: str,
+        route: str,
+        obs: dict,
+        ) -> None:
+        
+        response = self.__user_state_client.update_user_state({
+            "user_id": self.__user_state.customer_id,
+            "menu_id": menu,
+            "route": route,
+            "obs": json.dumps(obs),
+        })
+
+        if not response.status:
+            raise ValueError("Erro ao atualizar estado do usuário.")
+        
+        self.__user_state.menu = menu
+        self.__user_state.route = route
+        self.__user_state.obs = obs
+    
+    @property
+    def menu(self):
+        return self.__user_state.menu
+    
+    @property
+    def route(self):
+        return self.__user_state.route
+    
+    @property
+    def obs(self):
+        return self.__user_state.obs
+    
+    @property
+    def customer_id(self):
+        return self.__user_state.customer_id
+    
+    @menu.setter
+    def menu(self, menu):
+        
+        self.update_user_state(
+            menu, 
+            self.__user_state.route, 
+            self.__user_state.obs
+        )
+    
+    @route.setter
+    def route(self, route):
+        
+        self.update_user_state(
+            self.__user_state.menu, 
+            route, 
+            self.__user_state.obs
+        )
+    
+    @obs.setter
+    def obs(self, obs):
+        
+        self.update_user_state(
+            self.__user_state.menu, 
+            self.__user_state.route, 
+            obs
+        )
+    

chatgraph/types/route.py

@@ -23,6 +23,13 @@ class Route:
         self.routes = routes
         self.separator = separator
 
+    @property
+    def previous(self)->str:
+        """
+        Retorna a rota anterior a atual do usuário
+        """
+        return self.get_previous()
+    
     def get_previous(self) -> str:
         """
         Retorna o caminho anterior ao caminho atual.
@@ -39,7 +46,7 @@ class Route:
         previous_route = self.separator.join(self.current.split(self.separator)[:-1])
         return previous_route
 
-    def get_next(self, next_part: str) -> str:
+    def get_next(self, next_part: str) -> 'Route':
         """
         Monta e retorna o próximo caminho com base na parte fornecida.
 
@@ -50,13 +57,14 @@ class Route:
             RouteError: Se a próxima rota montada não estiver na lista de rotas disponíveis.
 
         Returns:
-            str: O próximo caminho construído a partir da rota atual e da parte fornecida.
+            Route: O próximo caminho montado.
         """
         next_part = next_part.strip().lower()
         next_route = f"{self.current.rstrip(self.separator)}{next_part}"
         if next_route not in self.routes:
             raise RouteError(f'Rota não encontrada: {next_route}')
-        return next_route
+        
+        return Route(next_route, self.routes, self.separator)
 
     def __str__(self):
         """