telegram-api-client-python 1.0.0__py3-none-any.whl

telegram-api-client-python/tools/groups.py

@@ -0,0 +1,274 @@
+from pathlib import Path
+from typing import List, TYPE_CHECKING
+
+import aiofiles
+
+from ..response import Response
+
+if TYPE_CHECKING:
+    from ..API import GreenApi
+
+
+class Groups:
+    def __init__(self, api: "GreenApi"):
+        self.api = api
+
+    def createGroup(self, groupName: str, chatIds: List[str]) -> Response:
+        """
+        The method is aimed for creating a group chat.
+
+        https://green-api.com/telegram/docs/api/groups/CreateGroup/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "createGroup/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+
+    async def createGroupAsync(self, groupName: str, chatIds: List[str]) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/createGroup/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def updateGroupName(self, chatId: str, groupName: str) -> Response:
+        """
+        The method changes a group chat name.
+
+        https://green-api.com/telegram/docs/api/groups/UpdateGroupName/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "updateGroupName/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def updateGroupNameAsync(self, chatId: str, groupName: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/updateGroupName/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def getGroupData(self, chatId: str) -> Response:
+        """
+        The method gets group chat data.
+
+        https://green-api.com/telegram/docs/api/groups/GetGroupData/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "getGroupData/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def getGroupDataAsync(self, chatId: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/getGroupData/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def addGroupParticipant(
+            self, chatId: str, participantChatId: str
+    ) -> Response:
+        """
+        The method adds a participant to a group chat.
+
+        https://green-api.com/telegram/docs/api/groups/AddGroupParticipant/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "addGroupParticipant/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def addGroupParticipantAsync(
+            self, chatId: str, participantChatId: str
+    ) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/addGroupParticipant/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def removeGroupParticipant(
+            self, chatId: str, participantChatId: str
+    ) -> Response:
+        """
+        The method removes a participant from a group chat.
+
+        https://green-api.com/telegram/docs/api/groups/RemoveGroupParticipant/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "removeGroupParticipant/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def removeGroupParticipantAsync(
+            self, chatId: str, participantChatId: str
+    ) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/removeGroupParticipant/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def setGroupAdmin(self, chatId: str, participantChatId: str) -> Response:
+        """
+        The method sets a group chat participant as an administrator.
+
+        https://green-api.com/telegram/docs/api/groups/SetGroupAdmin/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "setGroupAdmin/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def setGroupAdminAsync(self, chatId: str, participantChatId: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/setGroupAdmin/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def removeAdmin(self, chatId: str, participantChatId: str) -> Response:
+        """
+        The method removes a participant from group chat administration
+        rights.
+
+        https://green-api.com/telegram/docs/api/groups/RemoveAdmin/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "removeAdmin/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def removeAdminAsync(self, chatId: str, participantChatId: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/removeAdmin/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def setGroupPicture(self, chatId: str, path: str) -> Response:
+        """
+        The method sets a group picture.
+
+        https://green-api.com/telegram/docs/api/groups/SetGroupPicture/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        file_name = Path(path).name
+        files = {"file": (file_name, open(path, "rb"), "image/jpeg")}
+
+        request_body.pop("path")
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "setGroupPicture/{{apiTokenInstance}}"
+            ), request_body, files
+        )
+
+    async def setGroupPictureAsync(self, chatId: str, path: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        request_body.pop("path")
+        file_name = Path(path).name
+
+        async with aiofiles.open(path, "rb") as file:
+            file_data = await file.read()
+            files = {"file": (file_name, file_data, "image/jpeg")}
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/setGroupPicture/{{apiTokenInstance}}",
+            request_body, 
+            files=files
+        )
+
+    def leaveGroup(self, chatId: str) -> Response:
+        """
+        The method makes the current account user leave the group chat.
+
+        https://green-api.com/telegram/docs/api/groups/LeaveGroup/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "leaveGroup/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def leaveGroupAsync(self, chatId: str) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/leaveGroup/{{apiTokenInstance}}",
+            request_body
+        )
+
+    @classmethod
+    def __handle_parameters(cls, parameters: dict) -> dict:
+        handled_parameters = parameters.copy()
+
+        handled_parameters.pop("self")
+
+        for key, value in parameters.items():
+            if value is None:
+                handled_parameters.pop(key)
+
+        return handled_parameters

telegram-api-client-python/tools/journals.py

@@ -0,0 +1,126 @@
+from typing import Optional, TYPE_CHECKING
+
+from ..response import Response
+
+if TYPE_CHECKING:
+    from ..API import GreenApi
+
+class Journals:
+    def __init__(self, api: "GreenApi"):
+        self.api = api
+
+    def getChatHistory(
+            self, chatId: str, count: Optional[int] = None
+    ) -> Response:
+        """
+        The method returns the chat message history.
+
+        https://green-api.com/telegram/docs/api/journals/GetChatHistory/
+        """
+
+        request_body = locals()
+        if count is None:
+            request_body.pop("count")
+        request_body.pop("self")
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "getChatHistory/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def getChatHistoryAsync(
+            self, chatId: str, count: Optional[int] = None
+    ) -> Response:
+        request_body = locals()
+        if count is None:
+            request_body.pop("count")
+        request_body.pop("self")
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/getChatHistory/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def getMessage(self, chatId: str, idMessage: str) -> Response:
+        """
+        The method returns the chat message.
+
+        https://green-api.com/telegram/docs/api/journals/GetMessage/
+        """
+
+        request_body = locals()
+        request_body.pop("self")
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "getMessage/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def getMessageAsync(self, chatId: str, idMessage: str) -> Response:
+        request_body = locals()
+        request_body.pop("self")
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/getMessage/{{apiTokenInstance}}",
+            request_body
+        )
+
+    def lastIncomingMessages(self, minutes: Optional[int] = None) -> Response:
+        """
+        The method returns the last incoming messages of the account.
+
+        https://green-api.com/telegram/docs/api/journals/LastIncomingMessages/
+        """
+
+        append_minutes = ""
+        if minutes is not None:
+            append_minutes = f"?minutes={minutes}"
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "lastIncomingMessages/{{apiTokenInstance}}"+append_minutes
+            )
+        )
+
+    async def lastIncomingMessagesAsync(self, minutes: Optional[int] = None) -> Response:
+        params = {"minutes": minutes} if minutes else {}
+
+        return await self.api.requestAsync(
+            "GET", 
+            "{{host}}/waInstance{{idInstance}}/lastIncomingMessages/{{apiTokenInstance}}",
+            params
+        )
+
+    def lastOutgoingMessages(self, minutes: Optional[int] = None) -> Response:
+        """
+        The method returns the last outgoing messages of the account.
+
+        https://green-api.com/telegram/docs/api/journals/LastOutgoingMessages/
+        """
+
+        append_minutes = ""
+        if minutes is not None:
+            append_minutes = f"?minutes={minutes}"
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "lastOutgoingMessages/{{apiTokenInstance}}"+append_minutes
+            )
+        )
+
+    async def lastOutgoingMessagesAsync(self, minutes: Optional[int] = None) -> Response:
+        params = {"minutes": minutes} if minutes else {}
+
+        return await self.api.requestAsync(
+            "GET",
+            "{{host}}/waInstance{{idInstance}}/lastOutgoingMessages/{{apiTokenInstance}}",
+            params
+        )

telegram-api-client-python/tools/marking.py

@@ -0,0 +1,38 @@
+from typing import TYPE_CHECKING
+
+from ..response import Response
+
+if TYPE_CHECKING:
+    from ..API import GreenApi
+
+
+class Marking:
+    def __init__(self, api: "GreenApi"):
+        self.api = api
+
+    def readChat(self, chatId: str) -> Response:
+        """
+        The method is aimed for marking messages in a chat as read.
+
+        https://green-api.com/telegram/docs/api/marks/ReadChat/
+        """
+
+        request_body = locals()
+        request_body.pop("self")
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "readChat/{{apiTokenInstance}}"
+            ), request_body
+        )
+
+    async def readChatAsync(self, chatId: str) -> Response:
+        request_body = locals()
+        request_body.pop("self")
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/waInstance{{idInstance}}/readChat/{{apiTokenInstance}}",
+            request_body
+        )

telegram-api-client-python/tools/partner.py

@@ -0,0 +1,87 @@
+from typing import Dict, TYPE_CHECKING, Union
+
+from ..response import Response
+
+if TYPE_CHECKING:
+    from ..API import GreenApiPartner
+
+class Partner:
+    def __init__(self, api: "GreenApiPartner"):
+        self.api = api
+   
+    def getInstances(self) -> Response:
+        """
+        The method is aimed for getting all the account instances created by the partner.
+
+        https://green-api.com/telegram/docs/partners/getInstances/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/partner/"
+                "getInstances/{{partnerToken}}"
+            )
+        )
+
+    async def getInstancesAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/partner/getInstances/{{partnerToken}}"
+        )
+
+    def createInstance(self, requestBody: Dict[str, Union[int, str]]) -> Response:
+        """
+        The method is aimed for creating a messenger account instance on the partner's part.
+
+        https://green-api.com/telegram/docs/partners/createInstance/
+        """
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/partner/"
+                "createInstance/{{partnerToken}}"
+            ), requestBody
+        )
+
+    async def createInstanceAsync(self, requestBody: Dict[str, Union[int, str]]) -> Response:
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/partner/createInstance/{{partnerToken}}",
+            requestBody
+        )
+
+    def deleteInstanceAccount(self, idInstance: int) -> Response:
+        """
+        The method is aimed for deleting an instance of the partners's account.
+
+        https://green-api.com/telegram/docs/partners/deleteInstanceAccount/
+        """
+
+        request_body = self.__handle_parameters(locals())
+
+        return self.api.request(
+            "POST", (
+                "{{host}}/partner/"
+                "deleteInstanceAccount/{{partnerToken}}"
+            ), request_body
+        )
+
+    async def deleteInstanceAccountAsync(self, idInstance: int) -> Response:
+        request_body = self.__handle_parameters(locals())
+
+        return await self.api.requestAsync(
+            "POST",
+            "{{host}}/partner/deleteInstanceAccount/{{partnerToken}}",
+            request_body
+        )
+
+    @classmethod
+    def __handle_parameters(cls, parameters: dict) -> dict:
+        handled_parameters = parameters.copy()
+
+        handled_parameters.pop("self")
+
+        for key, value in parameters.items():
+            if value is None:
+                handled_parameters.pop(key)
+
+        return handled_parameters

telegram-api-client-python/tools/queues.py

@@ -0,0 +1,111 @@
+from typing import TYPE_CHECKING
+
+from ..response import Response
+
+if TYPE_CHECKING:
+    from ..API import GreenApi
+
+
+class Queues:
+    def __init__(self, api: "GreenApi"):
+        self.api = api
+
+    def showMessagesQueue(self) -> Response:
+        """
+        The method is aimed for getting a list of messages in the queue
+        to be sent.
+
+        https://green-api.com/telegram/docs/api/queues/ShowMessagesQueue/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "showMessagesQueue/{{apiTokenInstance}}"
+            )
+        )
+
+    async def showMessagesQueueAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/waInstance{{idInstance}}/showMessagesQueue/{{apiTokenInstance}}"
+        )
+    
+    def getMessagesCount(self) -> Response:
+        """
+        The method is aimed for getting a list of messages in the queue
+        to be sent.
+
+        https://green-api.com/telegram/docs/api/queues/GetMessagesCount/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "getMessagesCount/{{apiTokenInstance}}"
+            )
+        )
+
+    async def getMessagesCountAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/waInstance{{idInstance}}/getMessagesCountAsync/{{apiTokenInstance}}"
+        )
+
+    def clearMessagesQueue(self) -> Response:
+        """
+        The method is aimed for clearing the queue of messages to be
+        sent.
+
+        https://green-api.com/telegram/docs/api/queues/ClearMessagesQueue/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "clearMessagesQueue/{{apiTokenInstance}}"
+            )
+        )
+
+    async def clearMessagesQueueAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/waInstance{{idInstance}}/clearMessagesQueue/{{apiTokenInstance}}"
+        )
+    
+    def getWebhooksCount(self) -> Response:
+        """
+        The method is aimed for getting a list of messages in the queue
+        to be sent.
+
+        https://green-api.com/telegram/docs/api/queues/GetWebhooksCount/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "getWebhooksCount/{{apiTokenInstance}}"
+            )
+        )
+
+    async def getWebhooksCountAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/waInstance{{idInstance}}/getWebhooksCountAsync/{{apiTokenInstance}}"
+        )
+
+    def clearWebhooksQueue(self) -> Response:
+        """
+        The method is aimed for clearing the queue of messages to be
+        sent.
+
+        https://green-api.com/telegram/docs/api/queues/clearWebhooksQueue/
+        """
+
+        return self.api.request(
+            "GET", (
+                "{{host}}/waInstance{{idInstance}}/"
+                "clearWebhooksQueue/{{apiTokenInstance}}"
+            )
+        )
+
+    async def clearWebhooksQueueAsync(self) -> Response:
+        return await self.api.requestAsync(
+            "GET", "{{host}}/waInstance{{idInstance}}/clearWebhooksQueue/{{apiTokenInstance}}"
+        )