Merge branch 'master' into SW-3437

prostraction · web-flow · commit 96ef8c0f0f81 · 2025-02-23T00:04:16.000+05:00
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -11,7 +11,7 @@ on:
 jobs:
   build:
     name: ${{ matrix.python-version }}
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: [ "3.7", "3.8", "3.9", "3.10", "3.11", "3.12" ]
@@ -30,9 +30,9 @@ jobs:
       - name: Lint with ruff
         run: |
           # stop the build if there are Python syntax errors or undefined names
-          ruff --output-format=github --select=E9,F63,F7,F82 --target-version=py37 .
+          ruff check --output-format=github --select=E9,F63,F7,F82 --target-version=py37 .
           # default set of ruff rules with GitHub Annotations
-          ruff --output-format=github --target-version=py37 .
+          ruff check --output-format=github --target-version=py37 .
       - name: Test with pytest
         run: |
           pytest
diff --git a/README.md b/README.md
@@ -255,11 +255,16 @@ print(response.data)
 | `serviceMethods.getContacts`           | The method is designed to get a list of contacts of the current account                                                  | [GetContacts](https://green-api.com/en/docs/api/service/GetContacts/)                                       |
 | `serviceMethods.getContactInfo`        | The method is designed to obtain information about the contact                                                           | [GetContactInfo](https://green-api.com/en/docs/api/service/GetContactInfo/)                                 |
 | `serviceMethods.deleteMessage`         | The method deletes the message from chat                                                                                 | [DeleteMessage](https://green-api.com/en/docs/api/service/deleteMessage/)                                   |
+| `serviceMethods.editMessage`           | The method edits the message in chat                                                                                     | [EditMessage](https://green-api.com/en/docs/api/service/editMessage/)                                   |
 | `serviceMethods.archiveChat`           | The method archives the chat                                                                                             | [ArchiveChat](https://green-api.com/en/docs/api/service/archiveChat/)                                       |
 | `serviceMethods.unarchiveChat`         | The method unarchives the chat                                                                                           | [UnarchiveChat](https://green-api.com/en/docs/api/service/unarchiveChat/)                                   |
 | `serviceMethods.setDisappearingChat`   | The method is designed to change the settings of disappearing messages in chats                                          | [SetDisappearingChat](https://green-api.com/en/docs/api/service/SetDisappearingChat/)                       |
 | `webhooks.startReceivingNotifications` | The method is designed to start receiving new notifications                                                              |                                                                                                             |
 | `webhooks.stopReceivingNotifications`  | The method is designed to stop receiving new notifications                                                               |                                                                                                             |
+| `partner.GetInstances`   | The method is for getting all the account instances created by the partner.                                           | [GetInstances](https://green-api.com/en/docs/partners/getInstances/)                       |
+| `partner.CreateInstance`   | The method is for creating an instance.                                           | [CreateInstance](https://green-api.com/en/docs/partners/createInstance/)                       |
+| `partner.DeleteInstanceAccount`   | The method is for deleting an instance.                                           | [DeleteInstanceAccount](https://green-api.com/en/docs/partners/deleteInstanceAccount/)                       |
+
 
 ## Service methods documentation
 
diff --git a/docs/README.md b/docs/README.md
@@ -215,11 +215,15 @@ print(response.data)
 | `serviceMethods.getContacts`           | Метод предназначен для получения списка контактов текущего аккаунта                                                       | [GetContacts](https://green-api.com/docs/api/service/GetContacts/)                                       |
 | `serviceMethods.getContactInfo`        | Метод предназначен для получения информации о контакте                                                                    | [GetContactInfo](https://green-api.com/docs/api/service/GetContactInfo/)                                 |
 | `serviceMethods.deleteMessage`         | Метод удаляет сообщение из чата                                                                                           | [DeleteMessage](https://green-api.com/docs/api/service/deleteMessage/)                                   |
+| `serviceMethods.editMessage`           | Метод изменяет сообщение в чате                                                                                           | [EditMessage](https://green-api.com/docs/api/service/editMessage/)                                   |
 | `serviceMethods.archiveChat`           | Метод архивирует чат                                                                                                      | [ArchiveChat](https://green-api.com/docs/api/service/archiveChat/)                                       |
 | `serviceMethods.unarchiveChat`         | Метод разархивирует чат                                                                                                   | [UnarchiveChat](https://green-api.com/docs/api/service/unarchiveChat/)                                   |
 | `serviceMethods.setDisappearingChat`   | Метод предназначен для изменения настроек исчезающих сообщений в чатах                                                    | [SetDisappearingChat](https://green-api.com/docs/api/service/SetDisappearingChat/)                       |
 | `webhooks.startReceivingNotifications` | Метод предназначен для старта получения новых уведомлений                                                                 |                                                                                                          |
 | `webhooks.stopReceivingNotifications`  | Метод предназначен для остановки получения новых уведомлений                                                              |                                                                                                          |
+| `partner.GetInstances`   | Метод предназначен для получения всех инстансов аккаунтов созданных партнёром.                                           | [GetInstances](https://green-api.com/docs/partners/getInstances/)                       |
+| `partner.CreateInstance`   | Метод предназначен для создания инстанса от имени партнёра.                                           | [CreateInstance](https://green-api.com/docs/partners/createInstance/)                       |
+| `partner.DeleteInstanceAccount`   | Метод предназначен для удаления инстанса аккаунта партнёра.                                           | [DeleteInstanceAccount](https://green-api.com/docs/partners/deleteInstanceAccount/)                       |
 
 ## Документация по методам сервиса
 
diff --git a/examples/lastMessages.py b/examples/lastMessages.py
@@ -0,0 +1,21 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenAPI(
+    "1101000001", "d75b3a66374942c5b3c019c698abc2067e151558acbd412345"
+)
+
+
+def main():
+    # If no argument, the messages for 24 hours are returned.
+
+    print("Incoming messages in the last 72 hours:")
+    response = greenAPI.journals.lastIncomingMessages(4320)
+    print(response.data)
+
+    print("Outgoing messages in the last 72 hours:")
+    response = greenAPI.journals.lastOutgoingMessages(4320)
+    print(response.data)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/partherMethods/CreateInstance.py b/examples/partherMethods/CreateInstance.py
@@ -0,0 +1,34 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenApiPartner(
+    "gac.abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrst"
+)
+
+
+def main():
+    settings = {
+        "name": "Created by Python SDK",
+        "webhookUrl": "https://webhook.url",
+        "webhookUrlToken": "auth_token",
+        "delaySendMessagesMilliseconds": 5000,
+        "markIncomingMessagesReaded": "yes",
+        "markIncomingMessagesReadedOnReply": "yes",
+        "outgoingWebhook": "yes",
+        "outgoingMessageWebhook": "yes",
+        "outgoingAPIMessageWebhook": "yes",
+        "stateWebhook": "yes",
+        "incomingWebhook": "yes",
+        "deviceWebhook": "yes",
+        "keepOnlineStatus": "yes",
+        "pollMessageWebhook": "yes",
+        "incomingBlockWebhook": "yes",
+        "incomingCallWebhook": "yes",
+        "editedMessageWebhook": "yes",
+        "deletedMessageWebhook": "yes"
+    }
+
+    response = greenAPI.partner.createInstance(settings)
+    print(response.data)
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/partherMethods/DeleteInstanceAccount.py b/examples/partherMethods/DeleteInstanceAccount.py
@@ -0,0 +1,14 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenApiPartner(
+    "gac.abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrst"
+)
+
+
+def main():
+    response = greenAPI.partner.deleteInstanceAccount(1103123456)
+    print(response.data)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/partherMethods/GetInstances.py b/examples/partherMethods/GetInstances.py
@@ -0,0 +1,13 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenApiPartner(
+    "gac.abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrst"
+)
+
+
+def main():
+    response = greenAPI.partner.getInstances()
+    print(response.data)
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/serviceMethods.py b/examples/serviceMethods.py
@@ -0,0 +1,20 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenAPI(
+    "1101000001", "d75b3a66374942c5b3c019c698abc2067e151558acbd412345"
+)
+
+
+def main():
+    # DeleteMessage for sender
+    response = greenAPI.serviceMethods.deleteMessage("11001234567@c.us", "BAE52A7F04F452F9", True)
+
+    # DeleteMessage for all (default)
+    response = greenAPI.serviceMethods.deleteMessage("11001234567@c.us", "BAE5558FFC7565C2")
+
+    # EditMessage
+    response = greenAPI.serviceMethods.editMessage("11001234567@c.us", "BAE5F793F61411D0", "New text")
+    print(response.data) # new idMessage
+
+if __name__ == '__main__':
+    main()
diff --git a/examples/setSettings.py b/examples/setSettings.py
@@ -0,0 +1,34 @@
+from whatsapp_api_client_python import API
+
+greenAPI = API.GreenAPI(
+    "1101000001", "d75b3a66374942c5b3c019c698abc2067e151558acbd412345"
+)
+
+
+def main():
+    settings = {
+        "webhookUrl": "https://webhook.url",
+        "webhookUrlToken": "auth_token",
+        "delaySendMessagesMilliseconds": 5000,
+        "markIncomingMessagesReaded": "yes",
+        "markIncomingMessagesReadedOnReply": "yes",
+        "outgoingWebhook": "yes",
+        "outgoingMessageWebhook": "yes",
+        "outgoingAPIMessageWebhook": "yes",
+        "stateWebhook": "yes",
+        "incomingWebhook": "yes",
+        "deviceWebhook": "yes",
+        "keepOnlineStatus": "yes",
+        "pollMessageWebhook": "yes",
+        "incomingBlockWebhook": "yes",
+        "incomingCallWebhook": "yes",
+        "editedMessageWebhook": "yes",
+        "deletedMessageWebhook": "yes"
+    }
+
+    response = greenAPI.account.setSettings(settings)
+    print(response.data)
+
+
+if __name__ == '__main__':
+    main()
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
-requests==2.31.0
+requests>=2.31.0
diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 setup(
     name="whatsapp-api-client-python",
-    version="0.0.45",
+    version="0.0.50",
     description=(
         "This library helps you easily create"
         " a Python application with WhatsApp API."
@@ -43,6 +43,6 @@
         "Creative Commons Attribution-NoDerivatives 4.0 International"
         " (CC BY-ND 4.0)"
     ),
-    install_requires=["requests==2.31.0"],
+    install_requires=["requests>=2.31.0"],
     python_requires=">=3.7"
 )
diff --git a/whatsapp_api_client_python/API.py b/whatsapp_api_client_python/API.py
@@ -17,6 +17,7 @@
     sending,
     serviceMethods,
     webhooks,
+    partner,
     statuses
 )
 
@@ -34,13 +35,19 @@ def __init__(
             debug_mode: bool = False,
             raise_errors: bool = False,
             host: str = "https://api.green-api.com",
-            media: str = "https://media.green-api.com"
+            media: str = "https://media.green-api.com",
+            host_timeout: float = 180, # sec per retry
+            media_timeout: float = 10800, # sec per retry
     ):
         self.host = host
         self.media = media
         self.debug_mode = debug_mode
         self.raise_errors = raise_errors
 
+        # Change default values in init() if required
+        self.host_timeout = host_timeout
+        self.media_timeout = media_timeout
+
         self.idInstance = idInstance
         self.apiTokenInstance = apiTokenInstance
 
@@ -74,14 +81,18 @@ def request(
         url = url.replace("{{idInstance}}", self.idInstance)
         url = url.replace("{{apiTokenInstance}}", self.apiTokenInstance)
 
+        headers = {
+            'User-Agent': 'GREEN-API_SDK_PY/1.0'
+        }
+
         try:
             if not files:
                 response = self.session.request(
-                    method=method, url=url, json=payload
+                    method=method, url=url, json=payload, timeout=self.host_timeout, headers=headers
                 )
             else:
                 response = self.session.request(
-                    method=method, url=url, data=payload, files=files
+                    method=method, url=url, data=payload, files=files, timeout=self.media_timeout, headers=headers
                 )
         except Exception as error:
             error_message = f"Request was failed with error: {error}."
@@ -174,3 +185,33 @@ class GreenAPI(GreenApi):
 
 class GreenAPIError(Exception):
     pass
+
+class GreenApiPartner(GreenApi):
+    def __init__(
+            self,
+            partnerToken: str,
+            email: str = None,
+            host: str = "https://api.green-api.com"
+    ):
+
+        super().__init__(
+            idInstance="",
+            apiTokenInstance="",
+            host=host
+        )
+        
+        self.partnerToken = partnerToken
+        self.email = email
+        self.partner = partner.Partner(self)
+
+    def request(
+            self,
+            method: str,
+            url: str,
+            payload: Optional[dict] = None,
+            files: Optional[dict] = None
+    ) -> GreenAPIResponse:
+
+        url = url.replace("{{partnerToken}}", self.partnerToken)
+
+        return super().request(method, url, payload, files)
diff --git a/whatsapp_api_client_python/response.py b/whatsapp_api_client_python/response.py
@@ -10,6 +10,9 @@ class Response:
     def __init__(self, code: Optional[int], text: str):
         self.code = code
         if self.code == 200:
-            self.data = loads(text)
+            try:
+                self.data = loads(text)
+            except Exception:
+                self.data = "[]"
         else:
             self.error = text
diff --git a/whatsapp_api_client_python/tools/journals.py b/whatsapp_api_client_python/tools/journals.py
@@ -55,15 +55,15 @@ def lastIncomingMessages(self, minutes: Optional[int] = None) -> Response:
         https://green-api.com/en/docs/api/journals/LastIncomingMessages/
         """
 
-        request_body = None
+        append_minutes = ""
         if minutes is not None:
-            request_body = {"minutes": minutes}
+            append_minutes = f"?minutes={minutes}"
 
         return self.api.request(
             "GET", (
                 "{{host}}/waInstance{{idInstance}}/"
-                "lastIncomingMessages/{{apiTokenInstance}}"
-            ), request_body
+                "lastIncomingMessages/{{apiTokenInstance}}"+append_minutes
+            )
         )
 
     def lastOutgoingMessages(self, minutes: Optional[int] = None) -> Response:
@@ -73,13 +73,13 @@ def lastOutgoingMessages(self, minutes: Optional[int] = None) -> Response:
         https://green-api.com/en/docs/api/journals/LastOutgoingMessages/
         """
 
-        request_body = None
+        append_minutes = ""
         if minutes is not None:
-            request_body = {"minutes": minutes}
+            append_minutes = f"?minutes={minutes}"
 
         return self.api.request(
             "GET", (
                 "{{host}}/waInstance{{idInstance}}/"
-                "lastOutgoingMessages/{{apiTokenInstance}}"
-            ), request_body
+                "lastOutgoingMessages/{{apiTokenInstance}}"+append_minutes
+            )
         )
diff --git a/whatsapp_api_client_python/tools/partner.py b/whatsapp_api_client_python/tools/partner.py
diff --git a/whatsapp_api_client_python/tools/sending.py b/whatsapp_api_client_python/tools/sending.py
diff --git a/whatsapp_api_client_python/tools/serviceMethods.py b/whatsapp_api_client_python/tools/serviceMethods.py
