whatsapp-python 3.3.5.dev0__py3-none-any.whl → 3.3.9__py3-none-any.whl

whatsapp/constants.py

@@ -1,4 +1,4 @@
-# This file contains the constants used in the project.
-# The VERSION constant is used to store the version of the project - it's not only used in the __init__.py file, but also in the pyproject.toml file.
-
-VERSION = "3.3.5.dev0"
+# This file contains the constants used in the project.
+# The VERSION constant is used to store the version of the project - it's not only used in the __init__.py file, but also in the pyproject.toml file.
+
+VERSION = "3.3.9"

whatsapp/ext/_buttons.py

@@ -1,82 +1,82 @@
-import logging
-import requests
-from typing import Dict, Any
-
-
-def create_button(self, button: Dict[Any, Any]) -> Dict[Any, Any]:
-    """
-    Method to create a button object to be used in the send_message method.
-
-    This is method is designed to only be used internally by the send_button method.
-
-    Args:
-            button[dict]: A dictionary containing the button data
-    """
-    data = {"type": "list", "action": button.get("action")}
-    if button.get("header"):
-        data["header"] = {"type": "text", "text": button.get("header")}
-    if button.get("body"):
-        data["body"] = {"text": button.get("body")}
-    if button.get("footer"):
-        data["footer"] = {"text": button.get("footer")}
-    return data
-
-
-def send_button(self, button: Dict[Any, Any], recipient_id: str) -> Dict[Any, Any]:
-    """
-    Sends an interactive buttons message to a WhatsApp user
-
-    Args:
-        button[dict]: A dictionary containing the button data(rows-title may not exceed 20 characters)
-        recipient_id[str]: Phone number of the user with country code wihout +
-
-    check https://github.com/Neurotech-HQ/whatsapp#sending-interactive-reply-buttons for an example.
-    """
-    data = {
-        "messaging_product": "whatsapp",
-        "to": recipient_id,
-        "type": "interactive",
-        "interactive": self.create_button(button),
-    }
-    logging.info(f"Sending buttons to {recipient_id}")
-    r = requests.post(self.url, headers=self.headers, json=data)
-    if r.status_code == 200:
-        logging.info(f"Buttons sent to {recipient_id}")
-        return r.json()
-    logging.info(f"Buttons not sent to {recipient_id}")
-    logging.info(f"Status code: {r.status_code}")
-    logging.info(f"Response: {r.json()}")
-    return r.json()
-
-
-def send_reply_button(
-    self, button: Dict[Any, Any], recipient_id: str
-) -> Dict[Any, Any]:
-    """
-    Sends an interactive reply buttons[menu] message to a WhatsApp user
-
-    Args:
-        button[dict]: A dictionary containing the button data
-        recipient_id[str]: Phone number of the user with country code wihout +
-
-    Note:
-        The maximum number of buttons is 3, more than 3 buttons will rise an error.
-    """
-    if len(button["action"]["buttons"]) > 3:
-        raise ValueError("The maximum number of buttons is 3.")
-
-    data = {
-        "messaging_product": "whatsapp",
-        "recipient_type": "individual",
-        "to": recipient_id,
-        "type": "interactive",
-        "interactive": button,
-    }
-    r = requests.post(self.url, headers=self.headers, json=data)
-    if r.status_code == 200:
-        logging.info(f"Reply buttons sent to {recipient_id}")
-        return r.json()
-    logging.info(f"Reply buttons not sent to {recipient_id}")
-    logging.info(f"Status code: {r.status_code}")
-    logging.info(f"Response: {r.json()}")
-    return r.json()
+import logging
+import requests
+from typing import Dict, Any
+
+
+def create_button(self, button: Dict[Any, Any]) -> Dict[Any, Any]:
+    """
+    Method to create a button object to be used in the send_message method.
+
+    This is method is designed to only be used internally by the send_button method.
+
+    Args:
+            button[dict]: A dictionary containing the button data
+    """
+    data = {"type": "list", "action": button.get("action")}
+    if button.get("header"):
+        data["header"] = {"type": "text", "text": button.get("header")}
+    if button.get("body"):
+        data["body"] = {"text": button.get("body")}
+    if button.get("footer"):
+        data["footer"] = {"text": button.get("footer")}
+    return data
+
+
+def send_button(self, button: Dict[Any, Any], recipient_id: str) -> Dict[Any, Any]:
+    """
+    Sends an interactive buttons message to a WhatsApp user
+
+    Args:
+        button[dict]: A dictionary containing the button data(rows-title may not exceed 20 characters)
+        recipient_id[str]: Phone number of the user with country code wihout +
+
+    check https://github.com/Neurotech-HQ/whatsapp#sending-interactive-reply-buttons for an example.
+    """
+    data = {
+        "messaging_product": "whatsapp",
+        "to": recipient_id,
+        "type": "interactive",
+        "interactive": self.create_button(button),
+    }
+    logging.info(f"Sending buttons to {recipient_id}")
+    r = requests.post(self.url, headers=self.headers, json=data)
+    if r.status_code == 200:
+        logging.info(f"Buttons sent to {recipient_id}")
+        return r.json()
+    logging.info(f"Buttons not sent to {recipient_id}")
+    logging.info(f"Status code: {r.status_code}")
+    logging.info(f"Response: {r.json()}")
+    return r.json()
+
+
+def send_reply_button(
+    self, button: Dict[Any, Any], recipient_id: str
+) -> Dict[Any, Any]:
+    """
+    Sends an interactive reply buttons[menu] message to a WhatsApp user
+
+    Args:
+        button[dict]: A dictionary containing the button data
+        recipient_id[str]: Phone number of the user with country code wihout +
+
+    Note:
+        The maximum number of buttons is 3, more than 3 buttons will rise an error.
+    """
+    if len(button["action"]["buttons"]) > 3:
+        raise ValueError("The maximum number of buttons is 3.")
+
+    data = {
+        "messaging_product": "whatsapp",
+        "recipient_type": "individual",
+        "to": recipient_id,
+        "type": "interactive",
+        "interactive": button,
+    }
+    r = requests.post(self.url, headers=self.headers, json=data)
+    if r.status_code == 200:
+        logging.info(f"Reply buttons sent to {recipient_id}")
+        return r.json()
+    logging.info(f"Reply buttons not sent to {recipient_id}")
+    logging.info(f"Status code: {r.status_code}")
+    logging.info(f"Response: {r.json()}")
+    return r.json()

whatsapp/ext/_media.py

@@ -1,135 +1,135 @@
-import logging
-import requests
-import os
-import mimetypes
-from requests_toolbelt.multipart.encoder import MultipartEncoder
-from typing import Union, Dict, Any
-
-
-def upload_media(self, media: str) -> Union[Dict[Any, Any], None]:
-    """
-    Uploads a media to the cloud api and returns the id of the media
-
-    Args:
-        media[str]: Path of the media to be uploaded
-
-    Example:
-        >>> from whatsapp import WhatsApp
-        >>> whatsapp = WhatsApp(token, phone_number_id)
-        >>> whatsapp.upload_media("/path/to/media")
-
-    REFERENCE: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#
-    """
-    form_data = {
-        "file": (
-            media,
-            open(os.path.realpath(media), "rb"),
-            mimetypes.guess_type(media)[0],
-        ),
-        "messaging_product": "whatsapp",
-        "type": mimetypes.guess_type(media)[0],
-    }
-    form_data = MultipartEncoder(fields=form_data)
-    headers = self.headers.copy()
-    headers["Content-Type"] = form_data.content_type
-    logging.info(f"Content-Type: {form_data.content_type}")
-    logging.info(f"Uploading media {media}")
-    r = requests.post(
-        f"{self.base_url}/{self.phone_number_id}/media",
-        headers=headers,
-        data=form_data,
-    )
-    if r.status_code == 200:
-        logging.info(f"Media {media} uploaded")
-        return r.json()
-    logging.info(f"Error uploading media {media}")
-    logging.info(f"Status code: {r.status_code}")
-    logging.debug(f"Response: {r.json()}")
-    return None
-
-
-def delete_media(self, media_id: str) -> Union[Dict[Any, Any], None]:
-    """
-    Deletes a media from the cloud api
-
-    Args:
-        media_id[str]: Id of the media to be deleted
-    """
-    logging.info(f"Deleting media {media_id}")
-    r = requests.delete(
-        f"{self.base_url}/{media_id}", headers=self.headers)
-    if r.status_code == 200:
-        logging.info(f"Media {media_id} deleted")
-        return r.json()
-    logging.info(f"Error deleting media {media_id}")
-    logging.info(f"Status code: {r.status_code}")
-    logging.info(f"Response: {r.json()}")
-    return None
-
-
-def query_media_url(self, media_id: str) -> Union[str, None]:
-    """
-    Query media url from media id obtained either by manually uploading media or received media
-
-    Args:
-        media_id[str]: Media id of the media
-
-    Returns:
-        str: Media url
-
-    Example:
-        >>> from whatsapp import WhatsApp
-        >>> whatsapp = WhatsApp(token, phone_number_id)
-        >>> whatsapp.query_media_url("media_id")
-    """
-
-    logging.info(f"Querying media url for {media_id}")
-    r = requests.get(f"{self.base_url}/{media_id}", headers=self.headers)
-    if r.status_code == 200:
-        logging.info(f"Media url queried for {media_id}")
-        return r.json()["url"]
-    logging.info(f"Media url not queried for {media_id}")
-    logging.info(f"Status code: {r.status_code}")
-    logging.info(f"Response: {r.json()}")
-    return None
-
-
-def download_media(
-    self, media_url: str, mime_type: str, file_path: str = "temp"
-) -> Union[str, None]:
-    """
-    Download media from media url obtained either by manually uploading media or received media
-
-    Args:
-        media_url[str]: Media url of the media
-        mime_type[str]: Mime type of the media
-        file_path[str]: Path of the file to be downloaded to. Default is "temp"
-                        Do not include the file extension. It will be added automatically.
-
-    Returns:
-        str: Media url
-
-    Example:
-        >>> from whatsapp import WhatsApp
-        >>> whatsapp = WhatsApp(token, phone_number_id)
-        >>> whatsapp.download_media("media_url", "image/jpeg")
-        >>> whatsapp.download_media("media_url", "video/mp4", "path/to/file") #do not include the file extension
-    """
-    r = requests.get(media_url, headers=self.headers)
-    content = r.content
-    extension = mime_type.split("/")[1]
-    save_file_here = None
-    # create a temporary file
-    try:
-
-        save_file_here = (
-            f"{file_path}.{extension}" if file_path else f"temp.{extension}"
-        )
-        with open(save_file_here, "wb") as f:
-            f.write(content)
-        logging.info(f"Media downloaded to {save_file_here}")
-        return f.name
-    except Exception as e:
-        logging.info(e)
-        logging.error(f"Error downloading media to {save_file_here}")
-        return None
+import logging
+import requests
+import os
+import mimetypes
+from requests_toolbelt.multipart.encoder import MultipartEncoder
+from typing import Union, Dict, Any
+
+
+def upload_media(self, media: str) -> Union[Dict[Any, Any], None]:
+    """
+    Uploads a media to the cloud api and returns the id of the media
+
+    Args:
+        media[str]: Path of the media to be uploaded
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.upload_media("/path/to/media")
+
+    REFERENCE: https://developers.facebook.com/docs/whatsapp/cloud-api/reference/media#
+    """
+    form_data = {
+        "file": (
+            media,
+            open(os.path.realpath(media), "rb"),
+            mimetypes.guess_type(media)[0],
+        ),
+        "messaging_product": "whatsapp",
+        "type": mimetypes.guess_type(media)[0],
+    }
+    form_data = MultipartEncoder(fields=form_data)
+    headers = self.headers.copy()
+    headers["Content-Type"] = form_data.content_type
+    logging.info(f"Content-Type: {form_data.content_type}")
+    logging.info(f"Uploading media {media}")
+    r = requests.post(
+        f"{self.base_url}/{self.phone_number_id}/media",
+        headers=headers,
+        data=form_data,
+    )
+    if r.status_code == 200:
+        logging.info(f"Media {media} uploaded")
+        return r.json()
+    logging.info(f"Error uploading media {media}")
+    logging.info(f"Status code: {r.status_code}")
+    logging.debug(f"Response: {r.json()}")
+    return None
+
+
+def delete_media(self, media_id: str) -> Union[Dict[Any, Any], None]:
+    """
+    Deletes a media from the cloud api
+
+    Args:
+        media_id[str]: Id of the media to be deleted
+    """
+    logging.info(f"Deleting media {media_id}")
+    r = requests.delete(
+        f"{self.base_url}/{media_id}", headers=self.headers)
+    if r.status_code == 200:
+        logging.info(f"Media {media_id} deleted")
+        return r.json()
+    logging.info(f"Error deleting media {media_id}")
+    logging.info(f"Status code: {r.status_code}")
+    logging.info(f"Response: {r.json()}")
+    return None
+
+
+def query_media_url(self, media_id: str) -> Union[str, None]:
+    """
+    Query media url from media id obtained either by manually uploading media or received media
+
+    Args:
+        media_id[str]: Media id of the media
+
+    Returns:
+        str: Media url
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.query_media_url("media_id")
+    """
+
+    logging.info(f"Querying media url for {media_id}")
+    r = requests.get(f"{self.base_url}/{media_id}", headers=self.headers)
+    if r.status_code == 200:
+        logging.info(f"Media url queried for {media_id}")
+        return r.json()["url"]
+    logging.info(f"Media url not queried for {media_id}")
+    logging.info(f"Status code: {r.status_code}")
+    logging.info(f"Response: {r.json()}")
+    return None
+
+
+def download_media(
+    self, media_url: str, mime_type: str, file_path: str = "temp"
+) -> Union[str, None]:
+    """
+    Download media from media url obtained either by manually uploading media or received media
+
+    Args:
+        media_url[str]: Media url of the media
+        mime_type[str]: Mime type of the media
+        file_path[str]: Path of the file to be downloaded to. Default is "temp"
+                        Do not include the file extension. It will be added automatically.
+
+    Returns:
+        str: Media url
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.download_media("media_url", "image/jpeg")
+        >>> whatsapp.download_media("media_url", "video/mp4", "path/to/file") #do not include the file extension
+    """
+    r = requests.get(media_url, headers=self.headers)
+    content = r.content
+    extension = mime_type.split("/")[1]
+    save_file_here = None
+    # create a temporary file
+    try:
+
+        save_file_here = (
+            f"{file_path}.{extension}" if file_path else f"temp.{extension}"
+        )
+        with open(save_file_here, "wb") as f:
+            f.write(content)
+        logging.info(f"Media downloaded to {save_file_here}")
+        return f.name
+    except Exception as e:
+        logging.info(e)
+        logging.error(f"Error downloading media to {save_file_here}")
+        return None