Added links to docs

Author: Amele9

whatsapp_api_client_python/tools/account.py

@@ -14,6 +14,8 @@ def __init__(self, api: "GreenApi"):
     def getSettings(self) -> Response:
         """
         The method is aimed for getting the current account settings.
+
+        https://green-api.com/en/docs/api/account/GetSettings/
         """
 
         return self.api.request(
@@ -27,6 +29,8 @@ def getWaSettings(self) -> Response:
         """
         The method is aimed to get information about the WhatsApp
         account.
+
+        https://green-api.com/en/docs/api/account/GetWaSettings/
         """
 
         return self.api.request(
@@ -37,7 +41,11 @@ def getWaSettings(self) -> Response:
         )
 
     def setSettings(self, requestBody: Dict[str, Union[int, str]]) -> Response:
-        """The method is aimed for setting account settings."""
+        """
+        The method is aimed for setting account settings.
+
+        https://green-api.com/en/docs/api/account/SetSettings/
+        """
 
         return self.api.request(
             "POST", (
@@ -47,7 +55,11 @@ def setSettings(self, requestBody: Dict[str, Union[int, str]]) -> Response:
         )
 
     def getStateInstance(self) -> Response:
-        """The method is aimed for getting the account state."""
+        """
+        The method is aimed for getting the account state.
+
+        https://green-api.com/en/docs/api/account/GetStateInstance/
+        """
 
         return self.api.request(
             "GET", (
@@ -60,6 +72,8 @@ def getStatusInstance(self) -> Response:
         """
         The method is aimed for getting the status of the account
         instance socket connection with WhatsApp.
+
+        https://green-api.com/en/docs/api/account/GetStatusInstance/
         """
 
         return self.api.request(
@@ -70,7 +84,11 @@ def getStatusInstance(self) -> Response:
         )
 
     def reboot(self) -> Response:
-        """The method is aimed for rebooting an account."""
+        """
+        The method is aimed for rebooting an account.
+
+        https://green-api.com/en/docs/api/account/Reboot/
+        """
 
         return self.api.request(
             "GET", (
@@ -79,7 +97,11 @@ def reboot(self) -> Response:
         )
 
     def logout(self) -> Response:
-        """The method is aimed for logging out an account."""
+        """
+        The method is aimed for logging out an account.
+
+        https://green-api.com/en/docs/api/account/Logout/
+        """
 
         return self.api.request(
             "GET", (
@@ -88,14 +110,22 @@ def logout(self) -> Response:
         )
 
     def qr(self) -> Response:
-        """The method is aimed for getting QR code."""
+        """
+        The method is aimed for getting QR code.
+
+        https://green-api.com/en/docs/api/account/QR/
+        """
 
         return self.api.request(
             "GET", "{{host}}/waInstance{{idInstance}}/qr/{{apiTokenInstance}}"
         )
 
     def setProfilePicture(self, path: str) -> Response:
-        """The method is aimed for setting an account picture."""
+        """
+        The method is aimed for setting an account picture.
+
+        https://green-api.com/en/docs/api/account/SetProfilePicture/
+        """
 
         file_name = Path(path).name
         files = {"file": (file_name, open(path, "rb"), "image/jpeg")}

whatsapp_api_client_python/tools/device.py

@@ -14,6 +14,8 @@ def getDeviceInfo(self) -> Response:
         """
         The method is aimed for getting information about the device
         (phone) running WhatsApp Business application.
+
+        https://green-api.com/en/docs/api/phone/GetDeviceInfo/
         """
 
         return self.api.request(

whatsapp_api_client_python/tools/groups.py

@@ -12,7 +12,11 @@ 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."""
+        """
+        The method is aimed for creating a group chat.
+
+        https://green-api.com/en/docs/api/groups/CreateGroup/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -24,7 +28,11 @@ def createGroup(self, groupName: str, chatIds: List[str]) -> Response:
         )
 
     def updateGroupName(self, groupId: str, groupName: str) -> Response:
-        """The method changes a group chat name."""
+        """
+        The method changes a group chat name.
+
+        https://green-api.com/en/docs/api/groups/UpdateGroupName/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -36,7 +44,11 @@ def updateGroupName(self, groupId: str, groupName: str) -> Response:
         )
 
     def getGroupData(self, groupId: str) -> Response:
-        """The method gets group chat data."""
+        """
+        The method gets group chat data.
+
+        https://green-api.com/en/docs/api/groups/GetGroupData/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -50,7 +62,11 @@ def getGroupData(self, groupId: str) -> Response:
     def addGroupParticipant(
             self, groupId: str, participantChatId: str
     ) -> Response:
-        """The method adds a participant to a group chat."""
+        """
+        The method adds a participant to a group chat.
+
+        https://green-api.com/en/docs/api/groups/AddGroupParticipant/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -64,7 +80,11 @@ def addGroupParticipant(
     def removeGroupParticipant(
             self, groupId: str, participantChatId: str
     ) -> Response:
-        """The method removes a participant from a group chat."""
+        """
+        The method removes a participant from a group chat.
+
+        https://green-api.com/en/docs/api/groups/RemoveGroupParticipant/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -78,6 +98,8 @@ def removeGroupParticipant(
     def setGroupAdmin(self, groupId: str, participantChatId: str) -> Response:
         """
         The method sets a group chat participant as an administrator.
+
+        https://green-api.com/en/docs/api/groups/SetGroupAdmin/
         """
 
         request_body = self.__handle_parameters(locals())
@@ -93,6 +115,8 @@ def removeAdmin(self, groupId: str, participantChatId: str) -> Response:
         """
         The method removes a participant from group chat administration
         rights.
+
+        https://green-api.com/en/docs/api/groups/RemoveAdmin/
         """
 
         request_body = self.__handle_parameters(locals())
@@ -105,7 +129,11 @@ def removeAdmin(self, groupId: str, participantChatId: str) -> Response:
         )
 
     def setGroupPicture(self, groupId: str, path: str) -> Response:
-        """The method sets a group picture."""
+        """
+        The method sets a group picture.
+
+        https://green-api.com/en/docs/api/groups/SetGroupPicture/
+        """
 
         request_body = self.__handle_parameters(locals())
 
@@ -124,6 +152,8 @@ def setGroupPicture(self, groupId: str, path: str) -> Response:
     def leaveGroup(self, groupId: str) -> Response:
         """
         The method makes the current account user leave the group chat.
+
+        https://green-api.com/en/docs/api/groups/LeaveGroup/
         """
 
         request_body = self.__handle_parameters(locals())

whatsapp_api_client_python/tools/journals.py

@@ -13,7 +13,11 @@ def __init__(self, api: "GreenApi"):
     def getChatHistory(
             self, chatId: str, count: Optional[int] = None
     ) -> Response:
-        """The method returns the chat message history."""
+        """
+        The method returns the chat message history.
+
+        https://green-api.com/en/docs/api/journals/GetChatHistory/
+        """
 
         request_body = locals()
         if count is None:
@@ -28,7 +32,11 @@ def getChatHistory(
         )
 
     def getMessage(self, chatId: str, idMessage: str) -> Response:
-        """The method returns the chat message."""
+        """
+        The method returns the chat message.
+
+        https://green-api.com/en/docs/api/journals/GetMessage/
+        """
 
         request_body = locals()
         request_body.pop("self")
@@ -43,6 +51,8 @@ def getMessage(self, chatId: str, idMessage: str) -> Response:
     def lastIncomingMessages(self, minutes: Optional[int] = None) -> Response:
         """
         The method returns the last incoming messages of the account.
+
+        https://green-api.com/en/docs/api/journals/LastIncomingMessages/
         """
 
         request_body = None
@@ -59,6 +69,8 @@ def lastIncomingMessages(self, minutes: Optional[int] = None) -> Response:
     def lastOutgoingMessages(self, minutes: Optional[int] = None) -> Response:
         """
         The method returns the last outgoing messages of the account.
+
+        https://green-api.com/en/docs/api/journals/LastOutgoingMessages/
         """
 
         request_body = None

whatsapp_api_client_python/tools/marking.py

@@ -15,6 +15,8 @@ def readChat(
     ) -> Response:
         """
         The method is aimed for marking messages in a chat as read.
+
+        https://green-api.com/en/docs/api/marks/ReadChat/
         """
 
         request_body = locals()

whatsapp_api_client_python/tools/queues.py

@@ -14,6 +14,8 @@ def showMessagesQueue(self) -> Response:
         """
         The method is aimed for getting a list of messages in the queue
         to be sent.
+
+        https://green-api.com/en/docs/api/queues/ShowMessagesQueue/
         """
 
         return self.api.request(
@@ -27,6 +29,8 @@ def clearMessagesQueue(self) -> Response:
         """
         The method is aimed for clearing the queue of messages to be
         sent.
+
+        https://green-api.com/en/docs/api/queues/ClearMessagesQueue/
         """
 
         return self.api.request(

whatsapp_api_client_python/tools/receiving.py

@@ -14,6 +14,8 @@ def receiveNotification(self) -> Response:
         """
         The method is aimed for receiving one incoming notification
         from the notifications queue.
+
+        https://green-api.com/en/docs/api/receiving/technology-http-api/ReceiveNotification/
         """
 
         return self.api.request(
@@ -27,6 +29,8 @@ def deleteNotification(self, receiptId: int) -> Response:
         """
         The method is aimed for deleting an incoming notification from
         the notification queue.
+
+        https://green-api.com/en/docs/api/receiving/technology-http-api/DeleteNotification/
         """
 
         url = (
@@ -39,6 +43,8 @@ def deleteNotification(self, receiptId: int) -> Response:
     def downloadFile(self, chatId: str, idMessage: str) -> Response:
         """
         The method is aimed for downloading incoming and outgoing files.
+
+        https://green-api.com/en/docs/api/receiving/files/DownloadFile/
         """
 
         request_body = locals()