whatsapp-python 3.0.2.post1__py3-none-any.whl

whatsapp/ext/_static.py

@@ -0,0 +1,310 @@
+from typing import Any, Dict, Union
+
+
+@staticmethod
+def is_message(data: Dict[Any, Any]) -> bool:
+    """is_message checks if the data received from the webhook is a message.
+
+    Args:
+        data (Dict[Any, Any]): The data received from the webhook
+
+    Returns:
+        bool: True if the data is a message, False otherwise
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        return True
+    else:
+        return False
+
+
+@staticmethod
+def get_mobile(data: Dict[Any, Any]) -> Union[str, None]:
+    """
+    Extracts the mobile number of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        str: The mobile number of the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> mobile = whatsapp.get_mobile(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "contacts" in data:
+        return data["contacts"][0]["wa_id"]
+
+
+@staticmethod
+def get_name(data: Dict[Any, Any]) -> Union[str, None]:
+    """
+    Extracts the name of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        str: The name of the sender
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> mobile = whatsapp.get_name(data)
+    """
+    contact = data["entry"][0]["changes"][0]["value"]
+    if contact:
+        return contact["contacts"][0]["profile"]["name"]
+
+
+@staticmethod
+def get_message(data: Dict[Any, Any]) -> Union[str, None]:
+    """
+    Extracts the text message of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        str: The text message received from the sender
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> message = message.get_message(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        return data["messages"][0]["text"]["body"]
+
+
+@staticmethod
+def get_message_id(data: Dict[Any, Any]) -> Union[str, None]:
+    """
+    Extracts the message id of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        str: The message id of the sender
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> message_id = whatsapp.get_message_id(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        return data["messages"][0]["id"]
+
+
+@staticmethod
+def get_message_timestamp(data: Dict[Any, Any]) -> Union[str, None]:
+    """ "
+    Extracts the timestamp of the message from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        str: The timestamp of the message
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.get_message_timestamp(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        return data["messages"][0]["timestamp"]
+
+
+@staticmethod
+def get_interactive_response(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """
+        Extracts the response of the interactive message from the data received from the webhook.
+
+        Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        dict: The response of the interactive message
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> response = whatsapp.get_interactive_response(data)
+        >>> interactive_type = response.get("type")
+        >>> message_id = response[interactive_type]["id"]
+        >>> message_text = response[interactive_type]["title"]
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "interactive" in data["messages"][0]:
+            return data["messages"][0]["interactive"]
+
+
+@staticmethod
+def get_location(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """
+    Extracts the location of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+
+    Returns:
+        dict: The location of the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.get_location(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "location" in data["messages"][0]:
+            return data["messages"][0]["location"]
+
+
+@staticmethod
+def get_image(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """ "
+    Extracts the image of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        dict: The image_id of an image sent by the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> image_id = whatsapp.get_image(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "image" in data["messages"][0]:
+            return data["messages"][0]["image"]
+
+
+@staticmethod
+def get_document(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """ "
+    Extracts the document of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+    Returns:
+        dict: The document_id of an image sent by the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> document_id = whatsapp.get_document(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "document" in data["messages"][0]:
+            return data["messages"][0]["document"]
+
+
+@staticmethod
+def get_audio(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """
+    Extracts the audio of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+
+    Returns:
+        dict: The audio of the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.get_audio(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "audio" in data["messages"][0]:
+            return data["messages"][0]["audio"]
+
+
+@staticmethod
+def get_video(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """
+    Extracts the video of the sender from the data received from the webhook.
+
+    Args:
+        data[dict]: The data received from the webhook
+
+    Returns:
+        dict: Dictionary containing the video details sent by the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.get_video(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        if "video" in data["messages"][0]:
+            return data["messages"][0]["video"]
+
+
+@staticmethod
+def get_message_type(data: Dict[Any, Any]) -> Union[str, None]:
+    """
+    Gets the type of the message sent by the sender from the data received from the webhook.
+
+
+    Args:
+        data [dict]: The data received from the webhook
+
+    Returns:
+        str: The type of the message sent by the sender
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.get_message_type(data)
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "messages" in data:
+        return data["messages"][0]["type"]
+
+
+@staticmethod
+def get_delivery(data: Dict[Any, Any]) -> Union[Dict, None]:
+    """
+    Extracts the delivery status of the message from the data received from the webhook.
+    Args:
+        data [dict]: The data received from the webhook
+
+    Returns:
+        dict: The delivery status of the message and message id of the message
+    """
+    data = data["entry"][0]["changes"][0]["value"]
+    if "statuses" in data:
+        return data["statuses"][0]["status"]
+
+
+@staticmethod
+def changed_field(data: Dict[Any, Any]) -> str:
+    """
+    Helper function to check if the field changed in the data received from the webhook.
+
+    Args:
+        data [dict]: The data received from the webhook
+
+    Returns:
+        str: The field changed in the data received from the webhook
+
+    Example:
+        >>> from whatsapp import WhatsApp
+        >>> whatsapp = WhatsApp(token, phone_number_id)
+        >>> whatsapp.changed_field(data)
+    """
+    return data["entry"][0]["changes"][0]["field"]
+
+
+@staticmethod
+def get_author(data: Dict[Any, Any]) -> Union[str, None]:
+    try:
+        return data["entry"][0]["changes"][0]["value"]["messages"][0]["from"]
+    except Exception:
+        return None

whatsapp_python-3.0.2.post1.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: whatsapp-python
+Version: 3.0.2.post1
+Summary: Open source Python wrapper for the WhatsApp Cloud API
+Project-URL: Homepage, https://github.com/filipporomani/whatsapp
+Project-URL: Bug Tracker, https://github.com/filipporomani/whatsapp/issues
+Project-URL: Download, https://github.com/filipporomani/whatsapp/releases/latest
+Author-email: Filippo Romani <mail@filipporomani.it>
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Build Tools
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+
+# [whatsapp-python](https://pypi.org/project/whatsapp-python/)
+
+![Made in Italy](https://img.shields.io/badge/made%20in-italy-008751.svg?style=flat-square)
+[![Downloads](https://static.pepy.tech/personalized-badge/whatsapp-python?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads)](https://pepy.tech/project/whatsapp-python)
+[![Downloads](https://pepy.tech/badge/whatsapp-python/month)](https://pepy.tech/project/whatsapp-python)
+[![Downloads](https://pepy.tech/badge/whatsapp-python/week)](https://pepy.tech/project/whatsapp-python)
+
+Free, open-source Python wrapper for the [WhatsApp Cloud API](https://developers.facebook.com/docs/whatsapp/cloud-api).
+
+Forked from [Neurotech-HQ/heyoo](https://github.com/Neurotech-HQ/heyoo)
+
+## Supported features
+
+1. Listening to events (messages, media, etc.)
+2. Sending messages
+3. Marking messages as read
+4. Sending Media (images, audio, video and documents)
+5. Sending location
+6. Sending interactive buttons
+7. Sending template messages
+8. Parsing messages and media received
+
+## App events
+
+Asynchronous app events are now available!
+
+The docs are available in the [wiki](https://github.com/filipporomani/whatsapp/wiki/App-events)
+
+Leave feedbacks/report issues freely on GitHub! I'll be glad to help you!
+
+
+## Installation
+
+To install the library you can either use pip (latest release version):
+
+``pip install whatsapp-python``
+
+or git (latest development version):
+
+```bash
+git clone https://github.com/filipporomani/whatsapp.git
+cd whatsapp
+python3 setup.py install
+```
+
+## Documentation
+
+The documentation for the library is available under the [**wiki**](https://github.com/filipporomani/whatsapp/wiki) section on GitHub.
+
+## Costs of the API
+
+While using third-party API providers of the WhatsApp API may have some monthly fees, using the WhatsApp API provided directly by Facebook is way cheaper, even if the billing docs are pretty hard to understand.
+The first 1000 chats created are free, then there is a pay-as-you-go fee that is paid for each conversation started.
+
+**IMPORTANT**: it is now mandatory (at least it was for me) to add a credit card to the whatsapp account to use the service. I eventually got billed for using a non-test number (~1,20€), so be carefull using the API!
+
+All the prices are available in the [**WhatsApp API docs**](https://developers.facebook.com/docs/whatsapp/pricing)
+
+## Switching from `Neurotech-HQ/heyoo`
+Any version >1.1.2 is incompatible with the original `heyoo` library! Be careful updating! Read the docs first!
+Any version <=1.1.2 is fully compatible with the original `heyoo` library and doesn't include any breaking change..
+You can ignore this warning if it's your first time using the library.
+
+
+Switching from heyoo to whatsapp-python doesn't require any change for versions up to 1.1.2: just uninstall `heyoo`, install `whatsapp-python==1.1.2` and change the import name from `heyoo` to `whatsapp`.
+For version which are GREATER THEN 1.1.2, messages have became objects, so you need to change your code to use the new methods.
+
+**Note**: docs for version 1.1.2 are available in the [**dedicated wiki page**](https://github.com/filipporomani/whatsapp/wiki/v1.1.2).
+
+
+
+
+## Issues
+
+If you are facing any issues or have any questions, please open an issue on the [**GitHub repository**](https://github.com/filipporomani/whatsapp/issues)
+
+## Contributing
+
+This is an opensource project published under the ```MIT License```: [**LICENSE**](LICENSE).
+
+## References
+
+1. [WhatsApp Cloud API official documentation](https://developers.facebook.com/docs/whatsapp/cloud-api/)

whatsapp_python-3.0.2.post1.dist-info/RECORD

@@ -0,0 +1,25 @@
+setup.py,sha256=iYla9PqaVtjAQtMDnLvNixkoqpw_MHhAG9dN5Wk0OlU,1535
+examples/example_hook_obj.py,sha256=jlw6kF-BX_ZoYZnUs5yqDqzklQm-wjXO8bQecIRH3U8,3053
+examples/reply_to_message_obj.py,sha256=CNseOMXEDA9y5V8o0y4cQhwf9_vN5drsVg5xu3kYp3M,346
+examples/sending_audio.py,sha256=AAjIgNobQqqmVqz_IlawR1qeX9JpLUeVE3XbZANFFqw,441
+examples/sending_button.py,sha256=CULZ9kpnIn17e6__ZrYy-VGxuY87AU8zSqd4UqHqvdA,1088
+examples/sending_document.py,sha256=C5ofmLuWrLLFnn-JSw4qqDciTd6b1Cg4Kcuiht2qWa4,436
+examples/sending_image.py,sha256=Kw4Wo-HjRsHhBXoGxElPak2zmvEwZqTJFOmtvcN14lY,412
+examples/sending_location.py,sha256=qyP5vMkPx7x97AZD4q7ptPz7aEF0QELN84Sx_p0GRsA,462
+examples/sending_message.py,sha256=QYPM1JigdB7nIcSdZqzcJ_y9wCx5VB0vKSwHPMpCNUE,415
+examples/sending_template_message.py,sha256=tXO8LPXdLq21m8RaLS4m0GArMFKi61N0mvbicGiAJow,388
+examples/sending_video.py,sha256=LtlKf-GlMU36L_3WBf6XIcjQlaSK0GcIECTt_iRXgCg,423
+examples/standalone_hook.py,sha256=9MGmLB92IUg5lj1sTpWs-0k_85E8IfHOOpffUsr-Aq8,5330
+whatsapp/__init__.py,sha256=6UCaboat6usACDvLVolJZFrhXNzlM5ZIoUd1bu8RMPI,9526
+whatsapp/constants.py,sha256=YJQsH6Ppwk6OxHMaF0YJSYUNvozTwIb_DgqBZYxobVc,46
+whatsapp/ext/_buttons.py,sha256=GKgxDsansBf4dm4UtZWa-Y-P5ag0TCo36badqyS5fFU,2922
+whatsapp/ext/_media.py,sha256=S8kLfFbZQ1zDCNjdFr5jQYBnuo7tp9FMGsZOGb-h23o,4511
+whatsapp/ext/_message.py,sha256=_0E47iqKdP6YsFXSbSFHJ7TLzL5cSfUiHqbG17FN0Lg,3792
+whatsapp/ext/_property.py,sha256=QS4FjWw21lyLuHnXGy7-2MCP-p0VoMw0gRpgu0OByO8,128
+whatsapp/ext/_send_media.py,sha256=aLdq4a0CyYa_ZNy8KOXEdX2rwA79RbCPp-thMjVxvh0,10036
+whatsapp/ext/_send_others.py,sha256=9Z2zV64Ygxu0LmN9Oy_oomwtgUbk3ZIFEF_3RWxkUDM,2934
+whatsapp/ext/_static.py,sha256=6T9CmHD3XBAH3e2T-w9je1mOfC1HwdBIMaRQjBdR_cQ,9513
+whatsapp_python-3.0.2.post1.dist-info/METADATA,sha256=wOvl_K_5U9peuR8peIRPSCcjsrMLnFCsobQ9qRKOGns,4583
+whatsapp_python-3.0.2.post1.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
+whatsapp_python-3.0.2.post1.dist-info/licenses/LICENSE,sha256=HnVLQg1StPmnEJfysP2uUtgEGJ2NsZjAT_5y1WsV8RU,1092
+whatsapp_python-3.0.2.post1.dist-info/RECORD,,

whatsapp_python-3.0.2.post1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.18.0
+Root-Is-Purelib: true
+Tag: py3-none-any

whatsapp_python-3.0.2.post1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 FILIPPO ROMANI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.