Metadata-Version: 2.4
Name: pretix-waitinglistsms
Version: 0.1.0
Summary: Send SMS notifications when pretix waiting list vouchers are assigned.
Author-email: Hans Fraiponts <fraiponts@gmail.com>
Maintainer-email: Hans Fraiponts <fraiponts@gmail.com>
License: GPL-3.0-or-later
Project-URL: homepage, https://github.com/HansF/pretix-waitinglistsms
Project-URL: repository, https://github.com/HansF/pretix-waitinglistsms
Keywords: pretix,sms,waiting-list
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: requests>=2.0
Dynamic: license-file

pretix Waiting List SMS
=======================

This is a pretix plugin that sends an SMS notification when a waiting list
entry receives a voucher.

.. note::
   This project's code and documentation were generated by an AI coding
   assistant (Claude). It has not been independently audited; review it
   carefully before relying on it in production, particularly the parts
   that handle SMS gateway credentials and personal data.

Supported SMS gateways:

* Pingram
* Twilio
* Generic HTTP JSON webhook

Installation
------------

Install the plugin in the same Python environment as pretix::

    pip install pretix-waitinglistsms
    python -m pretix rebuild

Then restart the pretix web and worker processes.

Configuration
-------------

Enable the plugin for an event, then open the event settings page and configure
``Waiting list SMS``. The plugin sends messages only if all of these conditions
are true:

* the plugin is active for the event
* SMS notifications are enabled in the plugin settings
* a waiting list entry has a phone number
* a voucher has been assigned to the waiting list entry
* no successful SMS log entry exists for the waiting list entry yet

Message placeholders
--------------------

The message template supports these placeholders:

* ``{event}``
* ``{item}``
* ``{variation}``
* ``{voucher_code}``
* ``{voucher_valid_until}``
* ``{url}``

Data privacy
------------

The plugin does not store any personal data itself. However, to deliver a
message it transmits the waiting list entry's phone number (and the message
content, which may include the event name and voucher code) to the SMS gateway
you configure (Pingram, Twilio, or your own HTTP endpoint). Make sure your
privacy statement covers this processing and that you have a data processing
agreement with the gateway provider where required.

Development
-----------

Install in editable mode for local development::

    pip install -e .
