[version] new version! 2.3.0

CHANGELOG.md

@@ -3,13 +3,19 @@
 
 > NOTE: pywa follows the [semver](https://semver.org/) versioning standard.
 
-### 2.2.0 (2024-11-29) **Latest**
+
+### 2.3.0 (2024-11-30) **Latest**
+
+- [client] allowing to specify the callback url scope
+- [client] expose methods to override callback url in waba and phone scopes
+- [flows] typing `DataSource` to accept `Ref`s
+
+### 2.2.0 (2024-11-29)
 
 - [flows] adding `ScreenDataUpdate` to use in `UpdateDataAction`
 - [flows] using math operators between math objs
 - [flows] renaming `ActionNext` to `Next` and `ActionNextType` to `NextType`
 
-
 ### 2.1.0 (2024-11-24)
 
 - [flows] adding `CalendarPicker` component

docs/source/content/client/client_reference.rst

@@ -48,6 +48,12 @@ Client Reference
 .. automethod:: WhatsApp.get_qr_codes
 .. automethod:: WhatsApp.update_qr_code
 .. automethod:: WhatsApp.delete_qr_code
+.. automethod:: WhatsApp.get_app_access_token
+.. automethod:: WhatsApp.set_app_callback_url
+.. automethod:: WhatsApp.override_waba_callback_url
+.. automethod:: WhatsApp.delete_waba_callback_url
+.. automethod:: WhatsApp.override_phone_callback_url
+.. automethod:: WhatsApp.delete_phone_callback_url
 .. automethod:: WhatsApp.webhook_update_handler
 .. automethod:: WhatsApp.webhook_challenge_handler
 .. automethod:: WhatsApp.get_flow_request_handler

docs/source/content/client/overview.rst

@@ -39,71 +39,252 @@ The :class:`~WhatsApp` client has 3 main responsibilities:
 .. autoclass:: WhatsApp()
     :members: __init__
 
-The available methods are:
+
+Sending messages
+----------------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.send_message`
+     - Send a text message
+   * - :meth:`~WhatsApp.send_image`
+     - Send an image
+   * - :meth:`~WhatsApp.send_video`
+     - Send a video
+   * - :meth:`~WhatsApp.send_audio`
+     - Send an audio
+   * - :meth:`~WhatsApp.send_document`
+     - Send a document
+   * - :meth:`~WhatsApp.send_location`
+     - Send a location
+   * - :meth:`~WhatsApp.request_location`
+     - Request location
+   * - :meth:`~WhatsApp.send_contact`
+     - Send a contact/s
+   * - :meth:`~WhatsApp.send_sticker`
+     - Send a sticker
+   * - :meth:`~WhatsApp.send_template`
+     - Send a template
+   * - :meth:`~WhatsApp.send_catalog`
+     - Send a catalog
+   * - :meth:`~WhatsApp.send_product`
+     - Send a product
+   * - :meth:`~WhatsApp.send_products`
+     - Send multiple products
+   * - :meth:`~WhatsApp.send_reaction`
+     - React to a message
+   * - :meth:`~WhatsApp.remove_reaction`
+     - Remove a reaction
+   * - :meth:`~WhatsApp.mark_message_as_read`
+     - Mark a message as read
+
+Handling updates
+----------------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.on_message`
+     - Handle messages
+   * - :meth:`~WhatsApp.on_callback_button`
+     - Handle callback button clicks
+   * - :meth:`~WhatsApp.on_callback_selection`
+     - Handle callback selections
+   * - :meth:`~WhatsApp.on_message_status`
+     - Handle message status (delivered, read etc.)
+   * - :meth:`~WhatsApp.on_chat_opened`
+     - Handle when new chat is opened
+   * - :meth:`~WhatsApp.on_flow_request`
+     - Handle incoming flow requests
+   * - :meth:`~WhatsApp.on_flow_completion`
+     - Handle flow completions
+   * - :meth:`~WhatsApp.on_template_status`
+     - Handle template status changes
+   * - :meth:`~WhatsApp.add_handlers`
+     - Add handlers programmatically
+   * - :meth:`~WhatsApp.remove_handlers`
+     - Remove handlers programmatically
+   * - :meth:`~WhatsApp.remove_callbacks`
+     - Remove handlers by callbacks
+   * - :meth:`~WhatsApp.add_flow_request_handler`
+     - Add a flow request handler programmatically
+   * - :meth:`~WhatsApp.load_handlers_modules`
+     - Load handlers from modules
+
+Listening
+---------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.listen`
+     - Listen to specific user update
+   * - :meth:`~WhatsApp.stop_listening`
+     - Stop listening
+
+Media
+-----
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.upload_media`
+     - Upload media to WhatsApp servers
+   * - :meth:`~WhatsApp.download_media`
+     - Download media
+   * - :meth:`~WhatsApp.get_media_url`
+     - Get media URL
+
+Templates
+---------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.create_template`
+     - Create a template
+
+Flows
+-----
 
 .. list-table::
    :widths: 40 60
    :header-rows: 1
 
-   * - Category
-     - Methods
-   * - Sending messages
-     - :meth:`~WhatsApp.send_message`,
-       :meth:`~WhatsApp.send_image`,
-       :meth:`~WhatsApp.send_video`,
-       :meth:`~WhatsApp.send_audio`,
-       :meth:`~WhatsApp.send_document`,
-       :meth:`~WhatsApp.send_location`,
-       :meth:`~WhatsApp.request_location`,
-       :meth:`~WhatsApp.send_contact`,
-       :meth:`~WhatsApp.send_sticker`,
-       :meth:`~WhatsApp.send_template`,
-       :meth:`~WhatsApp.send_catalog`,
-       :meth:`~WhatsApp.send_product`,
-       :meth:`~WhatsApp.send_products`,
-       :meth:`~WhatsApp.send_reaction`,
-       :meth:`~WhatsApp.remove_reaction`,
-       :meth:`~WhatsApp.mark_message_as_read`
-   * - Listening
-     - :meth:`~WhatsApp.listen`,
-       :meth:`~WhatsApp.stop_listening`
-   * - Media
-     - :meth:`~WhatsApp.upload_media`,
-       :meth:`~WhatsApp.download_media`,
-       :meth:`~WhatsApp.get_media_url`
-   * - Templates
-     - :meth:`~WhatsApp.create_template`
-   * - Flows
-     - :meth:`~WhatsApp.create_flow`,
-       :meth:`~WhatsApp.update_flow_metadata`,
-       :meth:`~WhatsApp.update_flow_json`,
-       :meth:`~WhatsApp.publish_flow`,
-       :meth:`~WhatsApp.delete_flow`,
-       :meth:`~WhatsApp.deprecate_flow`,
-       :meth:`~WhatsApp.get_flow`,
-       :meth:`~WhatsApp.get_flows`,
-       :meth:`~WhatsApp.get_flow_metrics`,
-       :meth:`~WhatsApp.get_flow_assets`
-   * - Business profile
-     - :meth:`~WhatsApp.get_business_profile`,
-       :meth:`~WhatsApp.get_business_phone_number`,
-       :meth:`~WhatsApp.update_business_profile`,
-       :meth:`~WhatsApp.update_conversational_automation`,
-       :meth:`~WhatsApp.set_business_public_key`
-       :meth:`~WhatsApp.register_phone_number`,
-   * - QR Codes
-     - :meth:`~WhatsApp.create_qr_code`,
-       :meth:`~WhatsApp.get_qr_code`,
-       :meth:`~WhatsApp.get_qr_codes`,
-       :meth:`~WhatsApp.update_qr_code`,
-       :meth:`~WhatsApp.delete_qr_code`
-   * - Commerce
-     - :meth:`~WhatsApp.get_commerce_settings`,
-       :meth:`~WhatsApp.update_commerce_settings`
-   * - Server
-     - :meth:`~WhatsApp.webhook_update_handler`,
-       :meth:`~WhatsApp.webhook_challenge_handler`,
-       :meth:`~WhatsApp.get_flow_request_handler`
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.create_flow`
+     - Create a flow
+   * - :meth:`~WhatsApp.update_flow_metadata`
+     - Update flow metadata (name, categories, endpoint etc.)
+   * - :meth:`~WhatsApp.update_flow_json`
+     - Update flow JSON
+   * - :meth:`~WhatsApp.publish_flow`
+     - Publish a flow
+   * - :meth:`~WhatsApp.delete_flow`
+     - Delete a flow
+   * - :meth:`~WhatsApp.deprecate_flow`
+     - Deprecate a flow
+   * - :meth:`~WhatsApp.get_flow`
+     - Get a flow details
+   * - :meth:`~WhatsApp.get_flows`
+     - List all flows
+   * - :meth:`~WhatsApp.get_flow_metrics`
+     - Get flow metrics
+   * - :meth:`~WhatsApp.get_flow_assets`
+     - Get flow assets
+
+Business profile
+----------------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.get_business_profile`
+     - Get business profile
+   * - :meth:`~WhatsApp.get_business_phone_number`
+     - Get business phone number
+   * - :meth:`~WhatsApp.update_business_profile`
+     - Update business profile details (name, description, picture etc.)
+   * - :meth:`~WhatsApp.update_conversational_automation`
+     - Update commands and ice breakers
+   * - :meth:`~WhatsApp.set_business_public_key`
+     - Upload business public key
+   * - :meth:`~WhatsApp.register_phone_number`
+     - Register new phone number
+
+QR Codes
+--------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.create_qr_code`
+     - Create a QR code for a phone number
+   * - :meth:`~WhatsApp.get_qr_code`
+     - Get a QR code
+   * - :meth:`~WhatsApp.get_qr_codes`
+     - Get all QR codes
+   * - :meth:`~WhatsApp.update_qr_code`
+     - Update a QR code
+   * - :meth:`~WhatsApp.delete_qr_code`
+     - Delete a QR code
+
+Commerce
+--------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.get_commerce_settings`
+     - Get commerce settings
+   * - :meth:`~WhatsApp.update_commerce_settings`
+     - Update commerce settings
+
+Server
+------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.webhook_update_handler`
+     - Handle webhook updates manually
+   * - :meth:`~WhatsApp.webhook_challenge_handler`
+     - Handle webhook challenge manually
+   * - :meth:`~WhatsApp.get_flow_request_handler`
+     - Get flow request handler to handle manually
+
+Others
+------
+
+.. list-table::
+   :widths: 40 60
+   :header-rows: 1
+
+   * - Method
+     - Description
+   * - :meth:`~WhatsApp.get_app_access_token`
+     - Get app access token
+   * - :meth:`~WhatsApp.set_app_callback_url`
+     - Set app callback URL
+   * - :meth:`~WhatsApp.override_waba_callback_url`
+     - Override WABA callback URL
+   * - :meth:`~WhatsApp.delete_waba_callback_url`
+     - Delete WABA callback URL
+   * - :meth:`~WhatsApp.override_phone_callback_url`
+     - Override phone callback URL
+   * - :meth:`~WhatsApp.delete_phone_callback_url`
+     - Delete phone callback URL
+
+
 .. toctree::
     client_reference
     api_reference

pywa/__init__.py

@@ -9,6 +9,6 @@
 from pywa.client import WhatsApp
 from pywa.utils import Version
 
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 __author__ = "David Lev"
 __license__ = "MIT"