1.11.0

What's Changed

Update with pip: pip3 install -U pywa

• [callback] adding support for Optional[x] annotation in CallbackData subclasses
• [media] allowing to pass pathlib.Path as a media file path
• [system] make all fields nullable in system update

from pywa import WhatsApp
from pathlib import Path

wa = WhatsApp(...)
wa.send_document(
    to=972123456789,
    document=Path('/home/david/Documents') / 'Resume.pdf',
    filename='Resume.pdf',
    caption='My Resume',
)

Full Changelog: 1.10.0...1.11.0

1.10.0

What's Changed

Update with pip: pip3 install -U pywa

• [template] adding support for OtpType.ZERO_TAP in new authentication template
• [callback] adding support for nullable and optional fields in CallbackData
• [tests] update CallbackData tests

import dataclasses
from pywa.types import CallbackData

@dataclasses.dataclass
class User(CallbackData):
    id: str
    name: str | None # nullable field
    is_admin: bool = False # optional field

Full Changelog: 1.9.0...1.10.0

1.9.0

What's Changed

Update with pip: pip3 install -U pywa

• [handlers] call .stop_handling() on every update if you want to stop handling the update (or raise pywa.types.StopHandling)
• [errors] include requests.Response with all api errors
• [client] mark keyboard argument in .send_message as deprecated. use buttons instead

from pywa import WhatsApp, filters as fil, types

wa = WhatsApp(...)

@wa.on_message(fil.text)
def print_msg_1(_: WhatsApp, msg: types.Message):
    print(msg)
    msg.stop_handling()  # Stop handling the message
    # or raise types.StopHandling

@wa.on_message(fil.text)
def print_msg_2(_: WhatsApp, msg: types.Message):
    print("This handler will never be called")

Full Changelog: 1.8.0...1.9.0

1.8.0

What's Changed

Update with pip: pip3 install -U pywa

• [webhook] allow to register callback url by @david-lev in #18

See Handlers for more information.

from pywa import WhatsApp
from flask import Flask
from pywa.types import Message, CallbackButton, Button
from pywa.filters import text, callback

flask_app = Flask(__name__)
wa = WhatsApp(
    phone_id='1234567890',
    token='xxxxxxx',
    server=flask_app,
    callback_url='https://6b3e-18.ngrok.io',
    verify_token='XYZ123',
    app_id=123456,
    app_secret='yyyyyy'
)

# register the handlers

flask_app.run()  # Run the flask app to start the server

Full Changelog: 1.7.3...1.8.0

1.7.3

What's Changed

Update with pip: pip3 install -U pywa

• callback: Treat the Template's QuickReplyButtonData as an incoming CallbackButton (Reported by @bcombes in #17)
• handlers: adding @functools.wraps to all on_x decorators to preserve callbacks metadata

Full Changelog: 1.7.2...1.7.3

1.7.2

What's Changed

Update with pip: pip3 install -U pywa

• reply to CallbackButton.id instead of to .reply_to_message by @yehuda-lev in #16
• change default CallbackData separators to unused characters (¶ for clb sep, ~ for data sep and § for True boolean

Full Changelog: 1.7.1...1.7.2

1.7.1

What's Changed

Update with pip: pip3 install -U pywa

callback: hot-fix for last booleans fields on CallbackData (WhatsApp Cloud API consider "1: " and "1:" as duplicate datas)

Full Changelog: 1.7.0...1.7.1

1.7.0

What's Changed

Update with pip: pip3 install -U pywa

types: new ButtonUrl type
client: allowing to provide mime_type when sending media as bytes, open file or file path without extensions

from pywa import WhatsApp
from pywa.types import ButtonUrl

wa = WhatsApp(...)

wa.send_message(
    text='Hi',
    to='972123456789',
    keyboard=ButtonUrl(title='Google Search', url='https://google.com')
)

Full Changelog: 1.6.0...1.7.0

1.6.0

What's Changed

Update with pip: pip3 install -U pywa

• handlers: apply callback data factory before filters by setting factory_before_filters to True when registering the handler

import dataclasses
from pywa import WhatsApp
from pywa.types import CallbackData, CallbackButton

@dataclasses.dataclass(frozen=True, slots=True)
class User(CallbackData):
    id: int
    admin: bool

wa = WhatsApp(...)

@wa.on_callback_button(
    lambda _, b: b.data.admin, lambda _, b: b.data.id == 1, # filters get access to user data
    factory=User, # factory to convert the callback data to the user object
    factory_before_filters=True # factory will run before the filters
)
def on_callback_button(_: WhatsApp, clb: CallbackButton[User]):
    print(f"User with id {clb.data.id} is admin")

Full Changelog: 1.5.4...1.6.0

1.5.4

What's Changed

Update with pip: pip3 install -U pywa

• template: fix media key

Full Changelog: 1.5.3...1.5.4