Try to debug flaky test

Currently translated at 100.0% (3996 of 3996 strings)

Translation: pretix/pretix
Translate-URL: https://translate.pretix.eu/projects/pretix/pretix/de_Informal/

powered by weblate

.dockerignore

@@ -1,3 +1,10 @@
 doc/
 env/
 res/
+local/
+.git/
+pretixeu/
+src/data/
+src/pretix/static.dist/
+src/dist/
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Please only create issues for bug reports. Feature requests or general questions
+  should start as a "Discussion" on GitHub.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+<!-- Please only create issues for bug reports. Feature requests or general questions should start as a "Discussion" on GitHub. -->
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/docs.yml

@@ -0,0 +1,42 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'src/pretix/locale/**'
+      - 'src/pretix/static/**'
+      - 'src/tests/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'src/pretix/locale/**'
+      - 'src/pretix/static/**'
+      - 'src/tests/**'
+
+jobs:
+  spelling:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install system packages
+        run: sudo apt update && sudo apt install enchant hunspell aspell-en
+      - name: Install Dependencies
+        run: pip3 install -Ur doc/requirements.txt
+      - name: Spellcheck docs
+        run: make spelling
+        working-directory: ./doc
+      - name:
+        run: '[ ! -s _build/spelling/output.txt ]'
+        working-directory: ./doc

.github/workflows/strings.yml

@@ -0,0 +1,62 @@
+name: Strings
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+  pull_request:
+    branches: [ master ]
+    paths:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+
+jobs:
+  compile:
+    runs-on: ubuntu-latest
+    name: Check gettext syntax
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install system packages
+        run: sudo apt update && sudo apt install gettext
+      - name: Install Dependencies
+        run: pip3 install -Ur src/requirements.txt
+      - name: Compile messages
+        run: python manage.py compilemessages
+        working-directory: ./src
+      - name: Compile jsi18n
+        run: python manage.py compilejsi18n
+        working-directory: ./src
+  spelling:
+    runs-on: ubuntu-latest
+    name: Spellcheck
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install system packages
+        run: sudo apt update && sudo apt install enchant hunspell hunspell-de-de aspell-en aspell-de
+      - name: Install Dependencies
+        run: pip3 install -Ur src/requirements/dev.txt
+      - name: Spellcheck translations
+        run: potypo
+        working-directory: ./src

.github/workflows/style.yml

@@ -0,0 +1,55 @@
+name: Code Style
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'src/pretix/locale/**'
+      - 'src/pretix/static/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'src/pretix/locale/**'
+      - 'src/pretix/static/**'
+
+jobs:
+  isort:
+    name: isort
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install Dependencies
+        run: pip3 install -Ur src/requirements/dev.txt
+      - name: Run isort
+        run: isort -c .
+        working-directory: ./src
+  flake:
+    name: flake8
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install Dependencies
+        run: pip3 install -r src/requirements.txt -Ur src/requirements/dev.txt
+      - name: Run flake8
+        run: flake8 .
+        working-directory: ./src

.github/workflows/tests.yml

@@ -0,0 +1,75 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+  pull_request:
+    branches: [ master ]
+    paths-ignore:
+      - 'doc/**'
+      - 'src/pretix/locale/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Tests
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8]
+        database: [sqlite, postgres, mysql]
+        exclude:
+          - database: mysql
+            python-version: 3.7
+          - database: sqlite
+            python-version: 3.7
+          - database: mysql
+            python-version: 3.6
+          - database: sqlite
+            python-version: 3.6
+    steps:
+      - uses: actions/checkout@v2
+      - uses: getong/mariadb-action@v1.1
+        with:
+          mariadb version: '10.4'
+          mysql database: 'pretix'
+          mysql root password: ''
+        if: matrix.database == 'mysql'
+      - uses: harmon758/postgresql-action@v1
+        with:
+          postgresql version: '11'
+          postgresql db: 'pretix'
+          postgresql user: 'postgres'
+          postgresql password: 'postgres'
+        if: matrix.database == 'postgres'
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v1
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/cache@v1
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+      - name: Install system dependencies
+        run: sudo apt update && sudo apt install gettext mysql-client
+      - name: Install Python dependencies
+        run: pip3 install -r src/requirements.txt -Ur src/requirements/dev.txt mysqlclient psycopg2-binary
+      - name: Run checks
+        run: python manage.py check
+        working-directory: ./src
+      - name: Compile
+        working-directory: ./src
+        run: make all compress
+      - name: Run tests
+        working-directory: ./src
+        run: PRETIX_CONFIG_FILE=tests/travis_${{ matrix.database }}.cfg py.test -n 3 -p no:sugar --cov=./ --cov-report=xml --reruns 3 tests --maxfail=100
+      - name: Upload coverage
+        uses: codecov/codecov-action@v1
+        with:
+          file: src/coverage.xml
+          fail_ci_if_error: true
+        if: matrix.database == 'postgres' && matrix.python-version == '3.8'

.gitlab-ci.yml

@@ -5,7 +5,11 @@ tests:
         - virtualenv env
         - source env/bin/activate
         - pip install -U pip wheel setuptools
-        - XDG_CACHE_HOME=/cache bash .travis.sh tests
+        - XDG_CACHE_HOME=/cache pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
+        - cd src
+        - python manage.py check
+        - make all compress
+        - py.test --reruns 3 -n 3 tests
     tags:
         - python3
     except:
@@ -16,15 +20,17 @@ pypi:
         - cp /keys/.pypirc ~/.pypirc
         - virtualenv env
         - source env/bin/activate
-        - pip install -U pip wheel setuptools
+        - pip install -U pip wheel setuptools check-manifest twine
         - XDG_CACHE_HOME=/cache pip3 install -Ur src/requirements.txt -r src/requirements/dev.txt
         - cd src
         - python setup.py sdist
         - pip install dist/pretix-*.tar.gz
         - python -m pretix migrate
         - python -m pretix check
-        - python setup.py sdist upload
-        - python setup.py bdist_wheel upload
+        - check-manifest
+        - python setup.py sdist bdist_wheel
+        - twine check dist/*
+        - twine upload dist/*
     tags:
         - python3
     only:

.travis.sh

@@ -1,68 +0,0 @@
-#!/bin/bash
-set -e
-set -x
-
-echo "Executing job $1"
-
-if [ "$PRETIX_CONFIG_FILE" == "tests/travis_mysql.cfg" ]; then
-    mysql -u root -e 'CREATE DATABASE pretix DEFAULT CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;'
-    pip3 install -Ur src/requirements/mysql.txt
-fi
-
-if [ "$PRETIX_CONFIG_FILE" == "tests/travis_postgres.cfg" ]; then
-    psql -c 'create database travis_ci_test;' -U postgres
-fi
-
-if [ "$1" == "style" ]; then
-	XDG_CACHE_HOME=/cache pip3 install --no-use-pep517 -Ur src/requirements.txt -r src/requirements/dev.txt
-	cd src
-    flake8 .
-    isort -c -rc -df .
-fi
-if [ "$1" == "doctests" ]; then
-	XDG_CACHE_HOME=/cache pip3 install --no-use-pep517 -Ur doc/requirements.txt
-	cd doc
-	make doctest
-fi
-if [ "$1" == "doc-spelling" ]; then
-	XDG_CACHE_HOME=/cache pip3 install --no-use-pep517 -Ur doc/requirements.txt
-	cd doc
-	make spelling
-	if [ -s _build/spelling/output.txt ]; then
-		exit 1
-	fi
-fi
-if [ "$1" == "translation-spelling" ]; then
-	XDG_CACHE_HOME=/cache pip3 install --no-use-pep517 -Ur src/requirements/dev.txt
-	cd src
-	potypo
-fi
-if [ "$1" == "tests" ]; then
-	pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
-	cd src
-	python manage.py check
-	make all compress
-	py.test --reruns 5 -n 3 tests
-fi
-if [ "$1" == "tests-cov" ]; then
-	pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
-	cd src
-	python manage.py check
-	make all compress
-	coverage run -m py.test --reruns 5 tests && codecov
-fi
-if [ "$1" == "plugins" ]; then
-	pip3 install -r src/requirements.txt --no-use-pep517 -Ur src/requirements/dev.txt
-	cd src
-	python setup.py develop
-	make all compress
-
-	pushd ~
-    git clone --depth 1 https://github.com/pretix/pretix-cartshare.git
-    cd pretix-cartshare
-    python setup.py develop
-    make
-	py.test --reruns 5 tests
-    popd
-
-fi

.travis.yml

@@ -1,45 +0,0 @@
-language: python
-dist: xenial
-sudo: false
-install:
-  - pip install -U pip wheel setuptools
-script:
-  - bash .travis.sh $JOB
-cache:
-  directories:
-    - $HOME/.cache/pip
-services:
-  - mysql
-  - postgresql
-matrix:
-  include:
-    - python: 3.7
-      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_sqlite.cfg
-    - python: 3.7
-      env: JOB=tests-cov PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
-    - python: 3.7
-      env: JOB=style
-    - python: 3.7
-      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_mysql.cfg
-    - python: 3.7
-      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
-    - python: 3.5
-      env: JOB=tests PRETIX_CONFIG_FILE=tests/travis_postgres.cfg
-    - python: 3.7
-      env: JOB=doc-spelling
-    - python: 3.7
-      env: JOB=translation-spelling
-addons:
-  postgresql: "9.4"
-  mariadb: '10.3'
-  apt:
-      packages:
-          - enchant
-          - myspell-de-de
-          - aspell-en
-          - sqlite3
-  sources:
-    - travis-ci/sqlite3
-branches:
-  except:
-  - /^weblate-.*/

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.6
+FROM python:3.8
 
 RUN apt-get update && \
     apt-get install -y --no-install-recommends \
@@ -29,8 +29,9 @@ RUN apt-get update && \
     mkdir /etc/pretix && \
     mkdir /data && \
     useradd -ms /bin/bash -d /pretix -u 15371 pretixuser && \
-    echo 'pretixuser ALL=(ALL) NOPASSWD: /usr/bin/supervisord' >> /etc/sudoers && \
-    mkdir /static
+    echo 'pretixuser ALL=(ALL) NOPASSWD:SETENV: /usr/bin/supervisord' >> /etc/sudoers && \
+    mkdir /static && \
+    mkdir /etc/supervisord
 
 ENV LC_ALL=C.UTF-8 \
     DJANGO_SETTINGS_MODULE=production_settings
@@ -47,12 +48,13 @@ RUN pip3 install -U \
         -r requirements.txt \
         -r requirements/memcached.txt \
         -r requirements/mysql.txt \
-        -r requirements/redis.txt \
-        gunicorn && \
+        gunicorn django-extensions ipython && \
     rm -rf ~/.cache/pip
 
 COPY deployment/docker/pretix.bash /usr/local/bin/pretix
-COPY deployment/docker/supervisord.conf /etc/supervisord.conf
+COPY deployment/docker/supervisord /etc/supervisord
+COPY deployment/docker/supervisord.all.conf /etc/supervisord.all.conf
+COPY deployment/docker/supervisord.web.conf /etc/supervisord.web.conf
 COPY deployment/docker/nginx.conf /etc/nginx/nginx.conf
 COPY deployment/docker/production_settings.py /pretix/src/production_settings.py
 COPY src /pretix/src

README.rst

@@ -4,11 +4,10 @@ pretix
 .. image:: https://img.shields.io/pypi/v/pretix.svg
    :target: https://pypi.python.org/pypi/pretix
 
-.. image:: https://readthedocs.org/projects/pretix/badge/?version=latest
+.. image:: https://github.com/pretix/pretix/workflows/Documentation/badge.svg
    :target: https://docs.pretix.eu/en/latest/
 
-.. image:: https://travis-ci.org/pretix/pretix.svg?branch=master
-   :target: https://travis-ci.org/pretix/pretix
+.. image:: https://github.com/pretix/pretix/workflows/Tests/badge.svg
 
 .. image:: https://codecov.io/gh/pretix/pretix/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/pretix/pretix
@@ -20,9 +19,8 @@ Reinventing ticket presales, one ticket at a time.
 Project status & release cycle
 ------------------------------
 
-While there is always a lot to do and improve on, pretix by now has been in use for more than a dozen
-conferences that sold over ten thousand tickets combined without major problems. We therefore think of
-pretix as being stable and ready to use.
+While there is always a lot to do and improve on, pretix by now has been in use for thousands of events
+conferences that sold millions of tickets combined. We therefore think of pretix as being stable and ready to use.
 
 If you want to use or extend pretix, we strongly recommend to follow our `blog`_. We will announce all
 releases there. You can always find the latest stable version on PyPI or in the ``release/X.Y`` branch of
@@ -31,9 +29,13 @@ the sense that it does not break your data,  but its APIs might change without p
 
 To get started using pretix on your own server, look at the `installation guide`_ in our documentation.
 
-This project is 100 percent free and open source software. If you are interested in commercial support,
-hosting services or supporting this project financially, please go to `pretix.eu`_ or contact us at
-support@pretix.eu.
+Support
+-------
+
+This project is 100 percent free and open source software. You are welcome to ask questions in the GitHub
+repository. Private support via email or phone is only offered to customers of our pretix Hosted or pretix
+Enterprise offerings. If you are interested in commercial support, hosting services or supporting this project
+financially, please go to `pretix.eu`_ or contact us at support@pretix.eu.
 
 Contributing
 ------------
@@ -53,8 +55,8 @@ License
 The code in this repository is published under the terms of the Apache License. 
 See the LICENSE file for the complete license text.
 
-This project is maintained by Raphael Michel <mail@raphaelmichel.de>. See the
-AUTHORS file for a list of all the awesome folks who contributed to this project.
+This project is maintained by Raphael Michel. See the AUTHORS file for a list of all
+the awesome folks who contributed to this project.
 
 .. _installation guide: https://docs.pretix.eu/en/latest/admin/installation/index.html
 .. _developer documentation: https://docs.pretix.eu/en/latest/development/index.html

deployment/docker/nginx.conf

@@ -1,10 +1,13 @@
 user www-data www-data;
-worker_processes 1;
+worker_processes auto;
 pid /var/run/nginx.pid;
 daemon off;
+worker_rlimit_nofile 262144;
 
 events {
-	worker_connections 4096;
+    worker_connections 16384;
+    multi_accept on;
+    use epoll;
 }
 
 http {

deployment/docker/pretix.bash

@@ -3,7 +3,10 @@ cd /pretix/src
 export DJANGO_SETTINGS_MODULE=production_settings
 export DATA_DIR=/data/
 export HOME=/pretix
-export NUM_WORKERS=$((2 * $(nproc --all)))
+
+AUTOMIGRATE=${AUTOMIGRATE:-yes}
+NUM_WORKERS_DEFAULT=$((2 * $(nproc --all)))
+export NUM_WORKERS=${NUM_WORKERS:-$NUM_WORKERS_DEFAULT}
 
 if [ ! -d /data/logs ]; then
     mkdir /data/logs;
@@ -16,10 +19,16 @@ if [ "$1" == "cron" ]; then
     exec python3 -m pretix runperiodic
 fi
 
-python3 -m pretix migrate --noinput
+if [ "$AUTOMIGRATE" != "skip" ]; then
+  python3 -m pretix migrate --noinput
+fi
 
 if [ "$1" == "all" ]; then
-    exec sudo /usr/bin/supervisord -n -c /etc/supervisord.conf
+    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.all.conf
+fi
+
+if [ "$1" == "web" ]; then
+    exec sudo -E /usr/bin/supervisord -n -c /etc/supervisord.web.conf
 fi
 
 if [ "$1" == "webworker" ]; then
@@ -33,17 +42,12 @@ if [ "$1" == "webworker" ]; then
 fi
 
 if [ "$1" == "taskworker" ]; then
-    export C_FORCE_ROOT=True
-    exec celery -A pretix.celery_app worker -l info
-fi
-
-if [ "$1" == "shell" ]; then
-    exec python3 -m pretix shell
+    shift
+    exec celery -A pretix.celery_app worker -l info "$@"
 fi
 
 if [ "$1" == "upgrade" ]; then
     exec python3 -m pretix updatestyles
 fi
 
-echo "Specify argument: all|cron|webworker|taskworker|shell|upgrade"
-exit 1
+exec python3 -m pretix "$@"

deployment/docker/supervisord.all.conf

@@ -0,0 +1,2 @@
+[include]
+files = /etc/supervisord/*.conf

deployment/docker/supervisord.conf

@@ -1,44 +0,0 @@
-[unix_http_server]
-file=/tmp/supervisor.sock
-
-[supervisord]
-logfile=/tmp/supervisord.log
-logfile_maxbytes=50MB
-logfile_backups=10
-loglevel=info
-pidfile=/tmp/supervisord.pid
-nodaemon=false
-minfds=1024
-minprocs=200
-
-[rpcinterface:supervisor]
-supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
-
-[supervisorctl]
-serverurl=unix:///tmp/supervisor.sock
-
-[program:pretixweb]
-command=/usr/local/bin/pretix webworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-environment=HOME=/pretix
-
-[program:pretixtask]
-command=/usr/local/bin/pretix taskworker
-autostart=true
-autorestart=true
-priority=5
-user=pretixuser
-
-[program:nginx]
-command=/usr/sbin/nginx
-autostart=true
-autorestart=true
-priority=10
-stdout_events_enabled=true
-stderr_events_enabled=true
-
-[include]
-files = /etc/supervisord-*.conf

deployment/docker/supervisord.web.conf

@@ -0,0 +1,2 @@
+[include]
+files = /etc/supervisord/base.conf /etc/supervisord/nginx.conf /etc/supervisord/pretixweb.conf

deployment/docker/supervisord/base.conf

@@ -0,0 +1,17 @@
+[unix_http_server]
+file=/tmp/supervisor.sock
+
+[supervisord]
+logfile=/dev/stdout
+logfile_maxbytes=0
+loglevel=info
+pidfile=/tmp/supervisord.pid
+nodaemon=false
+minfds=1024
+minprocs=200
+
+[rpcinterface:supervisor]
+supervisor.rpcinterface_factory = supervisor.rpcinterface:make_main_rpcinterface
+
+[supervisorctl]
+serverurl=unix:///tmp/supervisor.sock

deployment/docker/supervisord/nginx.conf

@@ -0,0 +1,9 @@
+[program:nginx]
+command=/usr/sbin/nginx
+autostart=true
+autorestart=true
+priority=10
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixtask.conf

@@ -0,0 +1,10 @@
+[program:pretixtask]
+command=/usr/local/bin/pretix taskworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

deployment/docker/supervisord/pretixweb.conf

@@ -0,0 +1,11 @@
+[program:pretixweb]
+command=/usr/local/bin/pretix webworker
+autostart=true
+autorestart=true
+priority=5
+user=pretixuser
+environment=HOME=/pretix
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/fd/2
+stderr_logfile_maxbytes=0

doc/_themes/pretix_theme/static/css/pretix.css

@@ -6099,3 +6099,6 @@ img.screenshot, a.screenshot img {
 .versionchanged p:last-child {
     margin-bottom: 0;
 }
+.rst-content td > .line-block {
+    margin-left: 0 !important;
+}

doc/admin/config.rst

@@ -23,6 +23,14 @@ The config file may contain the following sections (all settings are optional an
 default values). We suggest that you start from the examples given in one of the
 installation tutorials.
 
+.. note::
+
+    The configuration file is the recommended way to configure pretix. However, you can
+    also set them through environment variables. In this case, the syntax is
+    ``PRETIX_SECTION_CONFIG``. For example, to configure the setting ``password_reset``
+    from the ``[pretix]`` section, set ``PRETIX_PRETIX_PASSWORD_RESET=off`` in your
+    environment.
+
 pretix settings
 ---------------
 
@@ -92,9 +100,19 @@ Example::
 
 ``trust_x_forwarded_proto``
     Specifies whether the ``X-Forwarded-Proto`` header can be trusted. Only set to ``on`` if you have a reverse
-    proxy that actively removes and re-adds the header to make sure the correct client IP is the first value.
+    proxy that actively removes and re-adds the header to make sure the correct value is set.
     Defaults to ``off``.
 
+``csp_log``
+    Log violations of the Content Security Policy (CSP). Defaults to ``on``.
+
+``csp_additional_header``
+    Specifies a CSP header that will be **merged** with pretix's default header. For example, if you set this
+    to ``script-src https://mycdn.com``, pretix will add ``https://mycdn.com`` as an **additional** allowed source
+    to all CSP headers. Empty by default.
+
+``loglevel``
+    Set console and file log level (``DEBUG``, ``INFO``, ``WARNING``, ``ERROR`` or ``CRITICAL``). Defaults to ``INFO``.
 
 Locale settings
 ---------------
@@ -337,6 +355,15 @@ application. If you want to use sentry, you need to set a DSN in the configurati
     You will be given this value by your sentry installation.
 
 
+Caching
+-------
+
+You can adjust some caching settings to control how much storage pretix uses::
+
+    [cache]
+    tickets=48  ; Number of hours tickets (PDF, passbook, …) are cached
+
+
 Secret length
 -------------
 

doc/admin/index.rst

@@ -12,3 +12,4 @@ This documentation is for everyone who wants to install pretix on a server.
    config
    maintainance
    scaling
+   indexes

doc/admin/indexes.rst

@@ -0,0 +1,73 @@
+Additional database indices
+===========================
+
+If you have a large pretix database, some features such as search for orders or events might turn pretty slow.
+For PostgreSQL, we have compiled a list of additional database indexes that you can add to speed things up.
+Just like any index, they in turn make write operations insignificantly slower and cause the database to use
+more disk space.
+
+The indexes aren't automatically created by pretix since Django does not allow us to do so only on PostgreSQL
+(and they won't work on other databases). Also, they're really not necessary if you're not having tens of
+thousands of records in your database.
+
+However, this also means they won't automatically adapt if some of the referred fields change in future updates of pretix
+and you might need to re-check this page and change them manually.
+
+Here is the currently recommended set of commands::
+
+    CREATE EXTENSION pg_trgm;
+
+    CREATE INDEX CONCURRENTLY pretix_addidx_event_slug
+        ON pretixbase_event
+        USING gin (upper("slug") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_event_name
+        ON pretixbase_event
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_code
+        ON pretixbase_order
+        USING gin (upper("code") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_voucher_code
+        ON pretixbase_voucher
+        USING gin (upper("code") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu1
+        ON "pretixbase_invoice" (UPPER("invoice_no"));
+    CREATE INDEX CONCURRENTLY pretix_addidx_invoice_nu2
+        ON "pretixbase_invoice" (UPPER("full_invoice_no"));
+    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_name
+        ON pretixbase_organizer
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_organizer_slug
+        ON pretixbase_organizer
+        USING gin (upper("slug") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_email
+        ON pretixbase_order
+        USING gin (upper("email") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_order_comment
+        ON pretixbase_order
+        USING gin (upper("comment") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_name
+        ON pretixbase_orderposition
+        USING gin (upper("attendee_name_cached") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_scret
+        ON pretixbase_orderposition
+        USING gin (upper("secret") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_orderpos_email
+        ON pretixbase_orderposition
+        USING gin (upper("attendee_email") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_ia_name
+        ON pretixbase_invoiceaddress
+        USING gin (upper("name_cached") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_ia_company
+        ON pretixbase_invoiceaddress
+        USING gin (upper("company") gin_trgm_ops);
+
+
+Also, if you use our ``pretix-shipping`` plugin::
+
+    CREATE INDEX CONCURRENTLY pretix_addidx_sa_name
+        ON pretix_shipping_shippingaddress
+        USING gin (upper("name") gin_trgm_ops);
+    CREATE INDEX CONCURRENTLY pretix_addidx_sa_company
+        ON pretix_shipping_shippingaddress
+        USING gin (upper("company") gin_trgm_ops);
+

doc/admin/installation/docker_smallscale.rst

@@ -26,7 +26,7 @@ installation guides):
 * `Docker`_
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
 * A `redis`_ server
 
 We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
@@ -135,7 +135,7 @@ Fill the configuration file ``/etc/pretix/pretix.cfg`` with the following conten
     user=pretix
     ; Replace with the password you chose above
     password=*********
-    ; In most docker setups, 172.17.0.1 is the address of the docker host. Adjuts
+    ; In most docker setups, 172.17.0.1 is the address of the docker host. Adjust
     ; this to wherever your database is running, e.g. the name of a linked container
     ; or of a mounted MySQL socket.
     host=172.17.0.1
@@ -182,7 +182,7 @@ named ``/etc/systemd/system/pretix.service`` with the following content::
         -v /var/pretix-data:/data \
         -v /etc/pretix:/etc/pretix \
         -v /var/run/redis:/var/run/redis \
-        --sysctl net.core.somaxconn=4096
+        --sysctl net.core.somaxconn=4096 \
         pretix/standalone:stable all
     ExecStop=/usr/bin/docker stop %n
 
@@ -284,13 +284,33 @@ Then, go to that directory and build the image::
 You can now use that image ``mypretix`` instead of ``pretix/standalone`` in your service file (see above). Be sure
 to re-build your custom image after you pulled ``pretix/standalone`` if you want to perform an update.
 
+Scaling up
+----------
+
+If you need to scale to multiple machines, please first read our :ref:`scaling guide <scaling>`.
+
+If you run the official docker container on multiple machines, it is recommended to set the environment
+variable ``AUTOMIGRATE=skip`` on all containers and run ``docker exec -it pretix.service pretix migrate``
+on one machine after each upgrade manually, otherwise multiple containers might try to upgrade the
+database schema at the same time.
+
+To run only the ``pretix-web`` component of pretix as well as a nginx server serving static files, you
+can invoke the container with ``docker run … pretix/standalone:stable web`` (instead of ``all``). You
+can adjust the number of ``gunicorn`` processes with the ``NUM_WORKERS`` environment variable (defaults to
+two times the number of CPUs detected).
+
+To run only ``pretix-worker``, you can run ``docker run … pretix/standalone:stable taskworker``. You can
+also pass arguments to limit the worker to specific queues or to change the number of concurrent task
+workers, e.g. ``docker run … taskworker -Q notifications --concurrency 32``.
+
+
 .. _Docker: https://docs.docker.com/engine/installation/linux/debian/
 .. _Postfix: https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-postfix-as-a-send-only-smtp-server-on-ubuntu-16-04
 .. _nginx: https://botleg.com/stories/https-with-lets-encrypt-and-nginx/
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
 .. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-9-4-on-debian-8
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _redis website: https://redis.io/topics/security

doc/admin/installation/manual_smallscale.rst

@@ -12,7 +12,7 @@ solution with many things readily set-up, look at :ref:`dockersmallscale`.
              get it right. If you're not feeling comfortable managing a Linux server, check out our hosting and service
              offers at `pretix.eu`_.
 
-We tested this guide on the Linux distribution **Debian 8.0** but it should work very similar on other
+We tested this guide on the Linux distribution **Debian 10.0** but it should work very similar on other
 modern distributions, especially on all systemd-based ones.
 
 Requirements
@@ -23,7 +23,7 @@ installation guides):
 
 * A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
 * A HTTP reverse proxy, e.g. `nginx`_ or Apache to allow HTTPS connections
-* A `PostgreSQL`_, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
+* A `PostgreSQL`_ 9.5+, `MySQL`_ 5.7+, or MariaDB 10.2.7+ database server
 * A `redis`_ server
 
 We also recommend that you use a firewall, although this is not a pretix-specific recommendation. If you're new to
@@ -133,7 +133,7 @@ command if you're running MySQL::
 
     (venv)$ pip3 install "pretix[postgres]" gunicorn
 
-Note that you need Python 3.5 or newer. You can find out your Python version using ``python -V``.
+Note that you need Python 3.6 or newer. You can find out your Python version using ``python -V``.
 
 We also need to create a data directory::
 
@@ -308,7 +308,7 @@ example::
 .. _Let's Encrypt: https://letsencrypt.org/
 .. _pretix.eu: https://pretix.eu/
 .. _MySQL: https://dev.mysql.com/doc/refman/5.7/en/linux-installation-apt-repo.html
-.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-9-4-on-debian-8
+.. _PostgreSQL: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-postgresql-on-ubuntu-20-04
 .. _redis: https://blog.programster.org/debian-8-install-redis-server/
 .. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
 .. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/

doc/admin/maintainance.rst

@@ -92,7 +92,14 @@ pretix_task_duration_seconds
 
 pretix_model_instances
     Gauge. Measures number of instances of a certain model within the database, labeled with
-    the ``model`` name.
+    the ``model`` name. Starting with pretix 3.11, these numbers might only be approximate for
+    most tables when running on PostgreSQL to mitigate performance impact.
+
+pretix_celery_tasks_queued_count
+    The number of background tasks in the worker queue, labeled with ``queue``.
+
+pretix_celery_tasks_queued_age_seconds
+    The age of the longest-waiting in the worker queue in seconds, labeled with ``queue``.
 
 .. _metric types: https://prometheus.io/docs/concepts/metric_types/
 .. _Prometheus: https://prometheus.io/

doc/api/deviceauth.rst

@@ -49,11 +49,15 @@ information on your device as well as your API token:
        "device_id": 5,
        "unique_serial": "HHZ9LW9JWP390VFZ",
        "api_token": "1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd",
-       "name": "Bar"
+       "name": "Bar",
+       "gate": {
+           "id": 3,
+           "name": "South entrance"
+       }
    }
 
 Please make sure that you store this ``api_token`` value. We also recommend storing your device ID, your assigned
-``unique_serial``, and the ``organizer`` you have access to, but that's up to you.
+``unique_serial``, and the ``organizer`` you have access to, but that's up to you. ``gate`` might be ``null``.
 
 In case of an error, the response will look like this:
 
@@ -98,6 +102,8 @@ following endpoint:
        "software_version": "4.1.0"
    }
 
+You will receive a response equivalent to the response of your initialization request.
+
 Creating a new API key
 ----------------------
 
@@ -126,12 +132,65 @@ invalidate your API key. There is no way to reverse this operation.
 
 This can also be done by the user through the web interface.
 
-Permissions
------------
+Permissions & security profiles
+-------------------------------
 
 Device authentication is currently hardcoded to grant the following permissions:
 
 * View event meta data and products etc.
-* View and change orders
+* View orders
+* Change orders
+* Manage gift cards
 
 Devices cannot change events or products and cannot access vouchers.
+
+Additionally, when creating a device through the user interface or API, a user can specify a "security profile" for
+the device. These include an allow list of specific API calls that may be made by the device. pretix ships with security
+policies for official pretix apps like pretixSCAN and pretixPOS.
+
+Removing a device
+-----------------
+
+If you want implement a way to to deprovision a device in your software, you can call the ``revoke`` endpoint to
+invalidate your API key. There is no way to reverse this operation.
+
+.. sourcecode:: http
+
+   POST /api/v1/device/revoke HTTP/1.1
+   Host: pretix.eu
+   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
+
+This can also be done by the user through the web interface.
+
+Event selection
+---------------
+
+In most cases, your application should allow the user to select the event and check-in list they work with manually
+from a list. However, in some cases it is required to automatically configure the device for the correct event, for
+example in a kiosk-like situation where nobody is operating the device. In this case, the app can query the server
+for a suggestion which event should be used. You can also submit the configuration that is currently in use via
+query parameters:
+
+.. sourcecode:: http
+
+   GET /api/v1/device/eventselection?current_event=democon&current_subevent=42&current_checkinlist=542 HTTP/1.1
+   Host: pretix.eu
+   Authorization: Device 1kcsh572fonm3hawalrncam4l1gktr2rzx25a22l8g9hx108o9oi0rztpcvwnfnd
+
+You can get three response codes:
+
+* ``304`` The server things you already selected a good event
+* ``404`` The server has not found a suggestion for you
+* ``200`` The server suggests a new event (body see below)
+
+.. sourcecode:: http
+
+   HTTP/1.1 200 OK
+   Content-Type: application/json
+
+   {
+      "event": "democon",
+      "subevent": 23,
+      "checkinlist": 5
+   }
+

doc/api/fundamentals.rst

@@ -183,6 +183,9 @@ Relative date         *either* String in ISO 8601  ``"2017-12-27"``,
                       constructed from a number of
                       days before the base point
                       and the base point.
+File                  URL in responses, ``file:``  ``"https://…"``, ``"file:…"``
+                      specifiers in requests
+                      (see below).
 ===================== ============================ ===================================
 
 Query parameters
@@ -227,4 +230,48 @@ We store idempotency keys for 24 hours, so you should never retry a request afte
 All ``POST``, ``PUT``, ``PATCH``, or ``DELETE`` api calls support idempotency keys. Adding an idempotency key to a
 ``GET``, ``HEAD``, or ``OPTIONS`` request has no effect.
 
+
+File upload
+-----------
+
+In some places, the API supports working with files, for example when setting the picture of a product. In this case,
+you will first need to make a separate request to our file upload endpoint:
+
+.. sourcecode:: http
+
+   POST /api/v1/upload HTTP/1.1
+   Host: pretix.eu
+   Authorization: Token e1l6gq2ye72thbwkacj7jbri7a7tvxe614ojv8ybureain92ocub46t5gab5966k
+   Content-Type: image/png
+   Content-Disposition: attachment; filename="logo.png"
+   Content-Length: 1234
+
+   <raw file content>
+
+Note that the ``Content-Type`` and ``Content-Disposition`` headers are required. If the upload was successful, you will
+receive a JSON response with the ID of the file:
+
+.. sourcecode:: http
+
+   HTTP/1.1 201 Created
+   Content-Type: application/json
+
+   {
+     "id": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
+   }
+
+You can then use this file ID in the request you want to use it in. File IDs are currently valid for 24 hours and can only
+be used using the same authorization method and user that was used to upload them.
+
+.. sourcecode:: http
+
+   PATCH /api/v1/organizers/test/events/test/items/3/ HTTP/1.1
+   Host: pretix.eu
+   Content-Type: application/json
+
+   {
+     "picture": "file:1cd99455-1ebd-4cda-b1a2-7a7d2a969ad1"
+   }
+
+
 .. _CSRF policies: https://docs.djangoproject.com/en/1.11/ref/csrf/#ajax

doc/api/guides/index.rst

@@ -8,4 +8,5 @@ This part of the documentation contains how-to guides on some special use cases
 .. toctree::
    :maxdepth: 2
 
+   order_lifecycle
    custom_checkout

doc/api/guides/order_lifecycle.rst

@@ -0,0 +1,56 @@
+Understanding the life cycle of orders
+======================================
+
+When integrating pretix with other systems, it is important that you understand how orders and related objects
+such as order positions, fees, payments, refunds, and invoices work together, in order to react to their changes
+properly and map them to processes in your system.
+
+Order states
+------------
+
+Generally, an order can be in six states. For compatibility reasons, the ``status`` field only allows four values
+and the two remaining states are modeled through the ``require_approval`` field and the number of positions within
+an order. The states and their allowed changes are shown in the following graph:
+
+.. image:: /images/order_states.png
+
+
+Object types
+------------
+
+Order
+    One order represents one purchase. It's the main object you interact with and bundles all the other objects
+    together. Orders can change in many ways during their lifetime, but will never be deleted (unless ``testmode``
+    is set to ``true``).
+
+Order position
+    An order position represents one product contained in the order. Orders can usually have multiple positions.
+    There might be a parent-child relation between order positions if one position is an add-on to another position.
+    Order positions can change in many ways during their lifetime, and can also be removed or added to an order.
+
+Order fees
+    A fee represents a charge that is not related to a product. Examples include shipping fees, service fees, and
+    cancellation fees.
+    Order fees can change in many ways during their lifetime, and can also be removed or added to an order.
+
+Order payment
+    An order payment represents one payment attempt with a specific payment method and amount. An order can have
+    multiple payments attached.
+    Order payments have their own state diagram. Apart from their state and their meta information (e.g. used
+    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
+
+Order refund
+    An order payment represents one refund attempt with a specific payment method and amount. An order can have
+    multiple refunds attached.
+    Order refunds have their own state diagram. Apart from their state and their meta information (e.g. used
+    credit card, …) they usually don't change. They may be added at any time, but will never be deleted.
+
+Invoice
+    An invoice represents a legal document stating the contents of an order. While the backend technically allows
+    to update an invoice in some situations, invoices are generally considered immutable. Once they are issued,
+    they no longer change. If the order changes substantially (e.g. prices change), an invoice is canceled through
+    creation of a new invoice with the opposite amount, plus the issuance of a new invoice.
+
+Here's an example of how they all play together:
+
+.. image:: /images/order_objects.png

doc/api/index.rst

@@ -7,9 +7,6 @@ This part of the documentation contains information about the REST-style API
 exposed by pretix since version 1.5 that can be used by third-party programs
 to interact with pretix and its data structures.
 
-Currently, the API provides mostly read-only capabilities, but it will be extended
-in functionality over time.
-
 .. toctree::
    :maxdepth: 2
 

doc/api/oauth.rst

@@ -25,7 +25,7 @@ Obtaining an authorization grant
 --------------------------------
 
 To authorize a new user, link or redirect them to the ``authorize`` endpoint, passing your client ID as a query
-parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, or ``read write``)
+parameter. Additionally, you can pass a scope (currently either ``read``, ``write``, ``read write`` or ``profile``)
 and an URL the user should be redirected to after successful or failed authorization. You also need to pass the
 ``response_type`` parameter with a value of ``code``. Example::
 
@@ -47,11 +47,9 @@ You will need this ``code`` parameter to perform the next step.
 
 On a failed registration, a query string like ``?error=access_denied`` will be appended to the redirection URL.
 
-.. note:: In this step, the user is allowed to restrict your access to certain organizer accounts. If you try to
-          re-authenticate the user later, the user might be instantly redirected back to you if authorization is already
-          given and would therefore be unable to review their organizer restriction settings. You can append the
-          ``approval_prompt=force`` query parameter if you want to make sure the user actively needs to confirm the
-          authorization.
+.. note:: By default, the user is asked to give permission on every call to this URL. If you **only** request the
+          ``profile`` scope, i.e. no access to organizer data, you can pass the ``approval_prompt=auto`` parameter
+          to skip user interaction on subsequent calls.
 
 Getting an access token
 -----------------------
@@ -193,10 +191,11 @@ If you need the user's meta data, you can fetch it here:
       Content-Type: application/json
 
       {
-        email: "admin@localhost",
-        fullname: "John Doe",
-        locale: "de",
-        timezone: "Europe/Berlin"
+        "email": "admin@localhost",
+        "fullname": "John Doe",
+        "locale": "de",
+        "is_staff": false,
+        "timezone": "Europe/Berlin"
       }
 
    :statuscode 200: no error

doc/api/resources/carts.rst

@@ -42,10 +42,6 @@ seat                                  objects                    The assigned se
 └ seat_guid                           string                     Identifier of the seat within the seating plan
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.17
-
-   This resource has been added.
-
 .. versionchanged:: 3.0
 
    This ``seat`` attribute has been added.

doc/api/resources/categories.rst

@@ -25,14 +25,6 @@ is_addon                              boolean                    If ``true``, it
                                                                  defining add-ons for other products.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.14
-
-   The operations POST, PATCH, PUT and DELETE have been added.
-
-.. versionchanged:: 1.16
-
-   The field ``internal_name`` has been added.
-
 
 Endpoints
 ---------

doc/api/resources/checkinlists.rst

@@ -30,31 +30,28 @@ position_count                        integer                    Number of ticke
 checkin_count                         integer                    Number of check-ins performed on this list (read-only).
 include_pending                       boolean                    If ``true``, the check-in list also contains tickets from orders in pending state.
 auto_checkin_sales_channels           list of strings            All items on the check-in list will be automatically marked as checked-in when purchased through any of the listed sales channels.
+allow_multiple_entries                boolean                    If ``true``, subsequent scans of a ticket on this list should not show a warning but instead be stored as an additional check-in.
+allow_entry_after_exit                boolean                    If ``true``, subsequent scans of a ticket on this list are valid if the last scan of the ticket was an exit scan.
+rules                                 object                     Custom check-in logic. The contents of this field are currently not considered a stable API and modifications through the API are highly discouraged.
+exit_all_at                           datetime                   Automatically check out (i.e. perform an exit scan) at this point in time. After this happened, this property will automatically be set exactly one day into the future. Note that this field is considered "internal configuration" and if you pull the list with ``If-Modified-Since``, the daily change in this field will not trigger a response.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.10
+.. versionchanged:: 3.9
 
-   This resource has been added.
+    The ``subevent`` attribute may now be ``null`` inside event series. The ``allow_multiple_entries``,
+    ``allow_entry_after_exit``, and ``rules`` attributes have been added.
 
-.. versionchanged:: 1.11
+.. versionchanged:: 3.11
 
-   The ``positions`` endpoints have been added.
+    The ``subevent_match`` and ``exclude`` query parameters have been added.
 
-.. versionchanged:: 1.13
+.. versionchanged:: 3.12
 
-   The ``include_pending`` field has been added.
-
-.. versionchanged:: 3.2
-
-    The ``auto_checkin_sales_channels`` field has been added.
+    The ``exit_all_at`` attribute has been added.
 
 Endpoints
 ---------
 
-.. versionchanged:: 1.15
-
-   The ``../status/`` detail endpoint has been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/
 
    Returns a list of all check-in lists within a given event.
@@ -89,6 +86,10 @@ Endpoints
             "limit_products": [],
             "include_pending": false,
             "subevent": null,
+            "allow_multiple_entries": false,
+            "allow_entry_after_exit": true,
+            "exit_all_at": null,
+            "rules": {},
             "auto_checkin_sales_channels": [
               "pretixpos"
             ]
@@ -98,6 +99,8 @@ Endpoints
 
    :query integer page: The page number in case of a multi-page result set, default is 1
    :query integer subevent: Only return check-in lists of the sub-event with the given ID
+   :query integer subevent_match: Only return check-in lists that are valid for the sub-event with the given ID (i.e. also lists valid for all subevents)
+   :query string exclude: Exclude a field from the output, e.g. ``checkin_count``. Can be used as a performance optimization. Can be passed multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :statuscode 200: no error
@@ -133,6 +136,10 @@ Endpoints
         "limit_products": [],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
+        "exit_all_at": null,
+        "rules": {},
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -168,6 +175,7 @@ Endpoints
       {
         "checkin_count": 17,
         "position_count": 42,
+        "inside_count": 12,
         "event": {
           "name": "Demo Conference"
         },
@@ -229,6 +237,8 @@ Endpoints
         "all_products": false,
         "limit_products": [1, 2],
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -251,6 +261,8 @@ Endpoints
         "limit_products": [1, 2],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -303,6 +315,8 @@ Endpoints
         "limit_products": [1, 2],
         "include_pending": false,
         "subevent": null,
+        "allow_multiple_entries": false,
+        "allow_entry_after_exit": true,
         "auto_checkin_sales_channels": [
           "pretixpos"
         ]
@@ -346,29 +360,6 @@ Endpoints
 Order position endpoints
 ------------------------
 
-.. versionchanged:: 1.15
-
-   The order positions endpoint has been extended by the filter queries ``item__in``, ``variation__in``,
-   ``order__status__in``, ``subevent__in``, ``addon_to__in``, and ``search``. The search for attendee names and order
-   codes is now case-insensitive.
-
-   The ``.../redeem/`` endpoint has been added.
-
-.. versionchanged:: 2.0
-
-   The order positions endpoint has been extended by the filter queries ``voucher`` and ``voucher__code``.
-
-.. versionchanged:: 2.7
-
-   The resource now contains the new attributes ``require_attention`` and ``order__status`` and accepts the new
-   ``ignore_status`` filter. The ``attendee_name`` field is now "smart" (see below) and the redemption endpoint
-   returns ``400`` instead of ``404`` on tickets which are known but not paid.
-
-.. versionchanged:: 3.2
-
-    The ``checkins`` dict now also contains a ``auto_checked_in`` value to indicate if the check-in has been performed
-    automatically by the system.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/checkinlists/(list)/positions/
 
    Returns a list of all order positions within a given event. The result is the same as
@@ -582,6 +573,7 @@ Order position endpoints
    :<json datetime datetime: Specifies the datetime of the check-in. If not supplied, the current time will be used.
    :<json boolean force: Specifies that the check-in should succeed regardless of previous check-ins or required
                          questions that have not been filled. Defaults to ``false``.
+   :<json string type: Send ``"exit"`` for an exit and ``"entry"`` (default) for an entry.
    :<json boolean ignore_unpaid: Specifies that the check-in should succeed even if the order is in pending state.
                                  Defaults to ``false`` and only works when ``include_pending`` is set on the check-in
                                  list.
@@ -696,6 +688,7 @@ Order position endpoints
      ``canceled_supported`` to ``true``, otherwise these orders return ``unpaid``.
    * ``already_redeemed`` - Ticket already has been redeemed
    * ``product`` - Tickets with this product may not be scanned at this device
+   * ``rules`` - Check-in prevented by a user-defined rule
 
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch

doc/api/resources/devices.rst

@@ -0,0 +1,224 @@
+.. spelling:: fullname
+
+.. _`rest-devices`:
+
+Devices
+=======
+
+See also :ref:`rest-deviceauth`.
+
+Device resource
+----------------
+
+The device resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+device_id                             integer                    Internal ID of the device within this organizer
+unique_serial                         string                     Unique identifier of this device
+name                                  string                     Device name
+all_events                            boolean                    Whether this device has access to all events
+limit_events                          list                       List of event slugs this device has access to
+hardware_brand                        string                     Device hardware manufacturer (read-only)
+hardware_model                        string                     Device hardware model (read-only)
+software_brand                        string                     Device software product (read-only)
+software_version                      string                     Device software version (read-only)
+created                               datetime                   Creation time
+initialized                           datetime                   Time of initialization (or ``null``)
+initialization_token                  string                     Token for initialization
+revoked                               boolean                    Whether this device no longer has access
+security_profile                      string                     The name of a supported security profile restricting API access
+===================================== ========================== =======================================================
+
+Device endpoints
+----------------
+
+.. http:get:: /api/v1/organizers/(organizer)/devices/
+
+   Returns a list of all devices within a given organizer.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/devices/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "device_id": 1,
+            "unique_serial": "UOS3GNZ27O39V3QS",
+            "initialization_token": "frkso3m2w58zuw70",
+            "all_events": false,
+            "limit_events": [
+              "museum"
+            ],
+            "revoked": false,
+            "name": "Scanner",
+            "created": "2020-09-18T14:17:40.971519Z",
+            "initialized": "2020-09-18T14:17:44.190021Z",
+            "security_profile": "full",
+            "hardware_brand": "Zebra",
+            "hardware_model": "TC25",
+            "software_brand": "pretixSCAN",
+            "software_version": "1.5.1"
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/devices/(device_id)/
+
+   Returns information on one device, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/devices/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "device_id": 1,
+        "unique_serial": "UOS3GNZ27O39V3QS",
+        "initialization_token": "frkso3m2w58zuw70",
+        "all_events": false,
+        "limit_events": [
+          "museum"
+        ],
+        "revoked": false,
+        "name": "Scanner",
+        "created": "2020-09-18T14:17:40.971519Z",
+        "initialized": "2020-09-18T14:17:44.190021Z",
+        "security_profile": "full",
+        "hardware_brand": "Zebra",
+        "hardware_model": "TC25",
+        "software_brand": "pretixSCAN",
+        "software_version": "1.5.1"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param device_id: The ``device_id`` field of the device to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/devices/
+
+   Creates a new device
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/devices/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "name": "Scanner",
+        "all_events": true,
+        "limit_events": [],
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "device_id": 1,
+        "unique_serial": "UOS3GNZ27O39V3QS",
+        "initialization_token": "frkso3m2w58zuw70",
+        "all_events": true,
+        "limit_events": [],
+        "revoked": false,
+        "name": "Scanner",
+        "created": "2020-09-18T14:17:40.971519Z",
+        "security_profile": "full",
+        "initialized": null
+        "hardware_brand": null,
+        "hardware_model": null,
+        "software_brand": null,
+        "software_version": null
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create a device for
+   :statuscode 201: no error
+   :statuscode 400: The device could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/devices/(device_id)/
+
+   Update a device.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/devices/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 94
+
+      {
+        "name": "Foo"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "name": "Foo",
+        ...
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param device_id: The ``device_id`` field of the device to modify
+   :statuscode 200: no error
+   :statuscode 400: The device could not be modified due to invalid submitted data
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
+

doc/api/resources/events.rst

@@ -44,34 +44,14 @@ seat_category_mapping                 object                     An object mappi
                                                                  (strings) to items in the event (integers or ``null``).
 timezone                              string                     Event timezone name
 item_meta_properties                  object                     Item-specific meta data parameters and default values.
+valid_keys                            object                     Cryptographic keys for non-default signature schemes.
+                                                                 For performance reason, value is omitted in lists and
+                                                                 only contained in detail views. Value can be cached.
+sales_channels                        list                       A list of sales channels this event is available for
+                                                                 sale on.
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.7
-
-   The ``meta_data`` field has been added.
-
-.. versionchanged:: 1.15
-
-   The ``plugins`` field has been added.
-   The operations POST, PATCH, PUT and DELETE have been added.
-
-.. versionchanged:: 2.1
-
-   Filters have been added to the list of events.
-
-.. versionchanged:: 2.5
-
-   The ``testmode`` attribute has been added.
-
-.. versionchanged:: 2.8
-
-    When cloning events, the ``testmode`` attribute will now be cloned, too.
-
-.. versionchanged:: 3.0
-
-   The attributes ``seating_plan`` and ``seat_category_mapping`` have been added.
-
 .. versionchanged:: 3.3
 
    The attributes ``geo_lat`` and ``geo_lon`` have been added.
@@ -84,6 +64,15 @@ item_meta_properties                  object                     Item-specific m
 
    The attribute ``item_meta_properties`` has been added.
 
+.. versionchanged:: 3.12
+
+   The attribute ``valid_keys`` has been added.
+
+.. versionchanged:: 3.14
+
+    The attribute ``sales_channels`` has been added.
+
+
 Endpoints
 ---------
 
@@ -140,10 +129,15 @@ Endpoints
             "timezone": "Europe/Berlin",
             "item_meta_properties": {},
             "plugins": [
-              "pretix.plugins.banktransfer"
-              "pretix.plugins.stripe"
-              "pretix.plugins.paypal"
+              "pretix.plugins.banktransfer",
+              "pretix.plugins.stripe",
+              "pretix.plugins.paypal",
               "pretix.plugins.ticketoutputpdf"
+            ],
+            "sales_channels": [
+              "web",
+              "pretixpos",
+              "resellers"
             ]
           }
         ]
@@ -163,6 +157,7 @@ Endpoints
         only contain the events matching the set criteria. Providing ``?attr[Format]=Seminar`` would return only those
         events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that have no value
         set. Please note that this filter will respect default values set on organizer level.
+   :query sales_channel: If set to a sales channel identifier, only events allowed to be sold on the specified sales channel are returned.
    :param organizer: The ``slug`` field of a valid organizer
    :statuscode 200: no error
    :statuscode 401: Authentication failure
@@ -212,10 +207,20 @@ Endpoints
         "timezone": "Europe/Berlin",
         "item_meta_properties": {},
         "plugins": [
-          "pretix.plugins.banktransfer"
-          "pretix.plugins.stripe"
-          "pretix.plugins.paypal"
+          "pretix.plugins.banktransfer",
+          "pretix.plugins.stripe",
+          "pretix.plugins.paypal",
           "pretix.plugins.ticketoutputpdf"
+        ],
+        "valid_keys": {
+          "pretix_sig1": [
+            "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUNvd0JRWURLMlZ3QXlFQTdBRDcvdkZBMzNFc1k0ejJQSHI3aVpQc1o4bjVkaDBhalA4Z3l6Tm1tSXM9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQo="
+          ]
+        },
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -267,6 +272,11 @@ Endpoints
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
+        ],
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -302,6 +312,11 @@ Endpoints
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
+        ],
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -357,6 +372,11 @@ Endpoints
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
+        ],
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -392,6 +412,11 @@ Endpoints
         "plugins": [
           "pretix.plugins.stripe",
           "pretix.plugins.paypal"
+        ],
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -461,6 +486,11 @@ Endpoints
           "pretix.plugins.stripe",
           "pretix.plugins.paypal",
           "pretix.plugins.pretixdroid"
+        ],
+        "sales_channels": [
+          "web",
+          "pretixpos",
+          "resellers"
         ]
       }
 
@@ -472,7 +502,7 @@ Endpoints
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create this resource.
 
 
-.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/items/(id)/
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/
 
    Delete an event. Note that events with orders cannot be deleted to ensure data integrity.
 
@@ -526,7 +556,7 @@ information about the properties.
 
    Get current values of event settings.
 
-   Permission required: "Can change event settings"
+   Permission required: "Can change event settings" (Exception: with device auth, *some* settings can always be *read*.)
 
    **Example request**:
 

doc/api/resources/exporters.rst

@@ -0,0 +1,215 @@
+.. spelling:: checkin
+
+Data exporters
+==============
+
+pretix and it's plugins include a number of data exporters that allow you to bulk download various data from pretix in
+different formats. This page shows you how to use these exporters through the API.
+
+.. versionchanged:: 3.13
+
+   This feature has been added to the API.
+
+.. warning::
+
+   While we consider the methods listed on this page to be a stable API, the availability and specific input field
+   requirements of individual exporters is **not considered a stable API**. Specific exporters and their input parameters
+   may change at any time without warning.
+
+Listing available exporters
+---------------------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/exporters/
+
+   Returns a list of all exporters available for a given event. You will receive a list of export methods as well as their
+   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
+   response, and you might need to look into the pretix web interface to figure out the exact input required.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/exporters/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "orderlist",
+            "verbose_name": "Order data",
+            "input_parameters": [
+              {
+                "name": "_format",
+                "required": true,
+                "choices": [
+                  "xlsx",
+                  "orders:default",
+                  "orders:excel",
+                  "orders:semicolon",
+                  "positions:default",
+                  "positions:excel",
+                  "positions:semicolon",
+                  "fees:default",
+                  "fees:excel",
+                  "fees:semicolon"
+                ]
+              },
+              {
+                "name": "paid_only",
+                "required": false
+              }
+            ]
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:get:: /api/v1/organizers/(organizer)/exporters/
+
+   Returns a list of all cross-event exporters available for a given organizer. You will receive a list of export methods as well as their
+   supported input fields. Note that the exact type and validation requirements of the input fields are not given in the
+   response, and you might need to look into the pretix web interface to figure out the exact input required.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/exporters/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "identifier": "orderlist",
+            "verbose_name": "Order data",
+            "input_parameters": [
+              {
+                "name": "events",
+                "required": true
+              },
+              {
+                "name": "_format",
+                "required": true,
+                "choices": [
+                  "xlsx",
+                  "orders:default",
+                  "orders:excel",
+                  "orders:semicolon",
+                  "positions:default",
+                  "positions:excel",
+                  "positions:semicolon",
+                  "fees:default",
+                  "fees:excel",
+                  "fees:semicolon"
+                ]
+              },
+              {
+                "name": "paid_only",
+                "required": false
+              }
+            ]
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+Running an export
+-----------------
+
+Since exports often include large data sets, they might take longer than the duration of an HTTP request. Therefore,
+creating an export is a two-step process. First you need to start an export task with one of the following to API
+endpoints:
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/exporters/(identifier)/run/
+
+   Starts an export task. If your input parameters validate correctly, a ``202 Accepted`` status code is returned.
+   The body points you to the download URL of the result.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/exporters/orderlist/run/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "_format": "xlsx"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "download": "https://pretix.eu/api/v1/organizers/bigevents/events/sampleconf/orderlist/download/29891ede-196f-4942-9e26-d055a36e98b8/3f279f13-c198-4137-b49b-9b360ce9fcce/"
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param identifier: The ``identifier`` field of the exporter to run
+   :statuscode 202: no error
+   :statuscode 400: Invalid input options
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+
+.. http:post:: /api/v1/organizers/(organizer)/exporters/(identifier)/run/
+
+   The endpoint for organizer-level exports works just like event-level exports (see above).
+
+
+Downloading the result
+----------------------
+
+When starting an export, you receive a ``url`` for downloading the result. Running a ``GET`` request on that result will
+yield one of the following status codes:
+
+* ``200 OK`` – The export succeeded. The body will be your resulting file. Might be large!
+* ``409 Conflict`` – Your export is still running. The body will be JSON with the structure ``{"status": "running", "percentage": 40}``. ``percentage`` can be ``null`` if it is not known and ``status`` can be ``waiting`` before the task is actually being processed. Please retry, but wait at least one second before you do.
+* ``410 Gone`` – Running the export has failed permanently. The body will be JSON with the structure ``{"status": "failed", "message": "Error message"}``
+* ``404 Not Found`` – The export does not exist / is expired.
+
+.. warning::
+
+   Running exports puts a lot of stress on the system, we kindly ask you not to run more than two exports at the same time.
+

doc/api/resources/giftcards.rst

@@ -18,11 +18,32 @@ secret                                string                     Gift card code
 value                                 money (string)             Current gift card value
 currency                              string                     Currency of the value (can not be modified later)
 testmode                              boolean                    Whether this is a test gift card
+expires                               datetime                   Expiry date (or ``null``)
+conditions                            string                     Special terms and conditions for this card (or ``null``)
+===================================== ========================== =======================================================
+
+The gift card transaction resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal ID of the gift card transaction
+datetime                              datetime                   Creation date of the transaction
+value                                 money (string)             Transaction amount
+event                                 string                     Event slug, if the gift card was used in the web shop (or ``null``)
+order                                 string                     Order code, if the gift card was used in the web shop (or ``null``)
+text                                  string                     Custom text of the transaction (or ``null``)
 ===================================== ========================== =======================================================
 
 Endpoints
 ---------
 
+.. versionadded:: 3.14
+
+   The transaction list endpoint was added.
+
 .. http:get:: /api/v1/organizers/(organizer)/giftcards/
 
    Returns a list of all gift cards issued by a given organizer.
@@ -53,6 +74,8 @@ Endpoints
             "secret": "HLBYVELFRC77NCQY",
             "currency": "EUR",
             "testmode": false,
+            "expires": null,
+            "conditions": null,
             "value": "13.37"
           }
         ]
@@ -92,6 +115,8 @@ Endpoints
         "secret": "HLBYVELFRC77NCQY",
         "currency": "EUR",
         "testmode": false,
+        "expires": null,
+        "conditions": null,
         "value": "13.37"
       }
 
@@ -134,6 +159,8 @@ Endpoints
         "secret": "HLBYVELFRC77NCQY",
         "testmode": false,
         "currency": "EUR",
+        "expires": null,
+        "conditions": null,
         "value": "13.37"
       }
 
@@ -180,6 +207,8 @@ Endpoints
         "secret": "HLBYVELFRC77NCQY",
         "testmode": false,
         "currency": "EUR",
+        "expires": null,
+        "conditions": null,
         "value": "14.00"
       }
 
@@ -199,14 +228,15 @@ Endpoints
 
    .. sourcecode:: http
 
-      PATCH /api/v1/organizers/bigevents/giftcards/1/transact/ HTTP/1.1
+      POST /api/v1/organizers/bigevents/giftcards/1/transact/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
       Content-Type: application/json
-      Content-Length: 94
+      Content-Length: 79
 
       {
-        "value": "2.00"
+        "value": "2.00",
+        "text": "Optional value explaining the transaction"
       }
 
    **Example response**:
@@ -222,6 +252,8 @@ Endpoints
         "secret": "HLBYVELFRC77NCQY",
         "currency": "EUR",
         "testmode": false,
+        "expires": null,
+        "conditions": null,
         "value": "15.37"
       }
 
@@ -237,3 +269,45 @@ Endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer does not exist **or** you have no permission to change this resource.
    :statuscode 409: There is not sufficient credit on the gift card.
+
+.. http:get:: /api/v1/organizers/(organizer)/giftcards/(id)/transactions/
+
+   List all transactions of a gift card.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/giftcards/1/transactions/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 82,
+            "datetime": "2020-06-22T15:41:42.800534Z",
+            "value": "50.00",
+            "event": "democon",
+            "order": "FXQYW",
+            "text": null
+          }
+        ]
+      }
+
+   :param organizer: The ``slug`` field of the organizer to view
+   :param id: The ``id`` field of the gift card to view
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.

doc/api/resources/index.rst

@@ -24,7 +24,9 @@ Resources and endpoints
    giftcards
    carts
    teams
+   devices
    webhooks
    seatingplans
+   exporters
    billing_invoices
    billing_var

doc/api/resources/invoices.rst

@@ -46,24 +46,6 @@ internal_reference                    string                     Customer's refe
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.6
-
-   The attribute ``invoice_no`` has been dropped in favor of ``number`` which includes the number including the prefix,
-   since the prefix can now vary. Also, invoices now need to be identified by their ``number`` instead of the raw
-   number.
-
-
-.. versionchanged:: 1.7
-
-   The attributes ``lines.tax_name``, ``foreign_currency_display``, ``foreign_currency_rate``, and
-   ``foreign_currency_rate_date`` have been added.
-
-
-.. versionchanged:: 1.9
-
-   The attribute ``internal_reference`` has been added.
-
-
 .. versionchanged:: 3.4
 
    The attribute ``lines.number`` has been added.

doc/api/resources/item_add-ons.rst

@@ -24,13 +24,10 @@ addon_category                        integer                    Internal ID of
 min_count                             integer                    The minimal number of add-ons that need to be chosen.
 max_count                             integer                    The maximal number of add-ons that can be chosen.
 position                              integer                    An integer, used for sorting
+multi_allowed                         boolean                    Adding the same item multiple times is allowed
 price_included                        boolean                    Adding this add-on to the item is free
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 
@@ -65,6 +62,7 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 0,
+            "multi_allowed": false,
             "price_included": true
           },
           {
@@ -73,6 +71,7 @@ Endpoints
             "min_count": 0,
             "max_count": 10,
             "position": 1,
+            "multi_allowed": false,
             "price_included": true
           }
         ]
@@ -112,6 +111,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -141,6 +141,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -158,6 +159,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 
@@ -206,6 +208,7 @@ Endpoints
         "min_count": 0,
         "max_count": 10,
         "position": 1,
+        "multi_allowed": false,
         "price_included": true
       }
 

doc/api/resources/item_bundles.rst

@@ -30,10 +30,6 @@ designated_price                      money (string)             Designated pric
                                                                  taxation. This is not added to the price.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.6
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/item_variations.rst

@@ -26,14 +26,6 @@ description                           multi-lingual string       A public descri
 position                              integer                    An integer, used for sorting
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.7
-
-   The attribute ``original_price`` has been added.
-
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/items.rst

@@ -36,8 +36,8 @@ admission                             boolean                    ``true`` for it
                                                                  (such as primary tickets) and ``false`` for others
                                                                  (such as add-ons or merchandise).
 position                              integer                    An integer, used for sorting
-picture                               string                     A product picture to be displayed in the shop
-                                                                 (read-only, can be ``null``).
+picture                               file                       A product picture to be displayed in the shop
+                                                                 (can be ``null``).
 sales_channels                        list of strings            Sales channels this product is available on, such as
                                                                  ``"web"`` or ``"resellers"``. Defaults to ``["web"]``.
 available_from                        datetime                   The first date time at which this item can be bought
@@ -104,6 +104,7 @@ addons                                list of objects            Definition of a
 ├ min_count                           integer                    The minimal number of add-ons that need to be chosen.
 ├ max_count                           integer                    The maximal number of add-ons that can be chosen.
 ├ position                            integer                    An integer, used for sorting
+├ multi_allowed                       boolean                    Adding the same item multiple times is allowed
 └ price_included                      boolean                    Adding this add-on to the item is free
 bundles                               list of objects            Definition of bundles that are included in this item.
                                                                  Only writable during creation,
@@ -117,48 +118,14 @@ bundles                               list of objects            Definition of b
 meta_data                             object                     Values set for event-specific meta data parameters.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.7
-
-   The attribute ``original_price`` has been added for ``variations``.
-
-.. versionchanged:: 1.7
-
-   The attribute ``tax_rule`` has been added. ``tax_rate`` is kept for compatibility. The attribute
-   ``checkin_attention`` has been added.
-
-.. versionchanged:: 1.12
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-   The attribute ``price_included`` has been added to ``addons``.
-
-.. versionchanged:: 1.16
-
-   The ``internal_name`` and ``original_price`` fields have been added.
-
-.. versionchanged:: 2.0
-
-   The field ``require_approval`` has been added.
-
-.. versionchanged:: 2.3
-
-   The ``sales_channels`` attribute has been added.
-
-.. versionchanged:: 2.4
-
-   The ``generate_tickets`` attribute has been added.
-
-.. versionchanged:: 2.6
-
-   The ``bundles`` and ``require_bundling`` attributes have been added.
-
-.. versionchanged:: 3.0
-
-   The ``show_quota_left``, ``allow_waitinglist``, and ``hidden_if_available`` attributes have been added.
-
 .. versionchanged:: 3.7
 
    The attribute ``meta_data`` has been added.
 
+.. versionchanged:: 3.10
+
+   The attribute ``multi_allowed`` has been added to ``addons``.
+
 Notes
 -----
 

doc/api/resources/orders.rst

@@ -30,6 +30,7 @@ testmode                              boolean                    If ``true``, th
                                                                  test mode. Only orders in test mode can be deleted.
 secret                                string                     The secret contained in the link sent to the customer
 email                                 string                     The customer email address
+phone                                 string                     The customer phone number
 locale                                string                     The locale used for communication with this customer
 sales_channel                         string                     Channel this sale was created through, such as
                                                                  ``"web"``.
@@ -93,64 +94,30 @@ last_modified                         datetime                   Last modificati
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.6
-
-   The ``invoice_address.country`` attribute contains a two-letter country code for all new orders. For old orders,
-   a custom text might still be returned.
-
-.. versionchanged:: 1.7
-
-   The attributes ``invoice_address.vat_id_validated`` and ``invoice_address.is_business`` have been added.
-   The attributes ``order.payment_fee``, ``order.payment_fee_tax_rate`` and ``order.payment_fee_tax_value`` have been
-   deprecated in favor of the new ``fees`` attribute but will still be served and removed in 1.9.
-
-.. versionchanged:: 1.9
-
-   First write operations (``…/mark_paid/``, ``…/mark_pending/``, ``…/mark_canceled/``, ``…/mark_expired/``) have been added.
-   The attribute ``invoice_address.internal_reference`` has been added.
-
-.. versionchanged:: 1.13
-
-   The field ``checkin_attention`` has been added.
-
-.. versionchanged:: 1.15
-
-   The attributes ``order.payment_fee``, ``order.payment_fee_tax_rate``, ``order.payment_fee_tax_value`` and
-   ``order.payment_fee_tax_rule`` have finally been removed.
-
-.. versionchanged:: 1.16
-
-   The attributes ``order.last_modified`` as well as the corresponding filters to the resource have been added.
-   An endpoint for order creation as well as ``…/mark_refunded/`` has been added.
-
-.. versionchanged:: 2.0
-
-   The ``order.payment_date`` and ``order.payment_provider`` attributes have been deprecated in favor of the new
-   nested ``payments`` and ``refunds`` resources, but will still be served and removed in 2.2. The ``require_approval``
-   attribute has been added, as have been the ``…/approve/`` and ``…/deny/`` endpoints.
-
-.. versionchanged:: 2.3
-
-   The ``sales_channel`` attribute has been added.
-
-.. versionchanged:: 2.4
-
-   ``order.status`` can no longer be ``r``, ``…/mark_canceled/`` now accepts a ``cancellation_fee`` parameter and
-   ``…/mark_refunded/`` has been deprecated.
-
-.. versionchanged:: 2.5
-
-   The ``testmode`` attribute has been added and ``DELETE`` has been implemented for orders.
-
-.. versionchanged:: 3.1
-
-   The ``invoice_address.state`` and ``url`` attributes have been added. When creating orders through the API,
-   vouchers are now supported and many fields are now optional.
-
 .. versionchanged:: 3.5
 
    The ``order.fees.canceled`` attribute has been added.
 
+.. versionchanged:: 3.8
+
+   The ``reactivate`` operation has been added.
+
+.. versionchanged:: 3.10
+
+   The ``search`` query parameter has been added.
+
+.. versionchanged:: 3.11
+
+   The ``exclude`` and ``subevent_after`` query parameter has been added.
+
+.. versionchanged:: 3.13
+
+   The ``subevent_before`` query parameter has been added.
+
+.. versionchanged:: 3.14
+
+   The ``phone`` attribute has been added.
+
 
 .. _order-position-resource:
 
@@ -173,6 +140,13 @@ price                                 money (string)             Price of this p
 attendee_name                         string                     Specified attendee name for this position (or ``null``)
 attendee_name_parts                   object of strings          Decomposition of attendee name (i.e. given name, family name)
 attendee_email                        string                     Specified attendee email address for this position (or ``null``)
+company                               string                     Attendee company name (or ``null``)
+street                                string                     Attendee street (or ``null``)
+zipcode                               string                     Attendee ZIP code (or ``null``)
+city                                  string                     Attendee city (or ``null``)
+country                               string                     Attendee country code (or ``null``)
+state                                 string                     Attendee state (ISO 3166-2 code). Only supported in
+                                                                 AU, BR, CA, CN, MY, MX, and US, otherwise ``null``.
 voucher                               integer                    Internal ID of the voucher used for this position (or ``null``)
 tax_rate                              decimal (string)           VAT rate applied for this position
 tax_value                             money (string)             VAT included in this position
@@ -182,15 +156,17 @@ addon_to                              integer                    Internal ID of
 subevent                              integer                    ID of the date inside an event series this position belongs to (or ``null``).
 pseudonymization_id                   string                     A random ID, e.g. for use in lead scanning apps
 checkins                              list of objects            List of check-ins with this ticket
+├ id                                  integer                    Internal ID of the check-in event
 ├ list                                integer                    Internal ID of the check-in list
 ├ datetime                            datetime                   Time of check-in
+├ type                                string                     Type of scan (defaults to ``entry``)
 └ auto_checked_in                     boolean                    Indicates if this check-in been performed automatically by the system
 downloads                             list of objects            List of ticket download options
 ├ output                              string                     Ticket output provider (e.g. ``pdf``, ``passbook``)
 └ url                                 string                     Download URL
 answers                               list of objects            Answers to user-defined questions
 ├ question                            integer                    Internal ID of the answered question
-├ answer                              string                     Text representation of the answer
+├ answer                              string                     Text representation of the answer (URL if answer is a file)
 ├ question_identifier                 string                     The question's ``identifier`` field
 ├ options                             list of integers           Internal IDs of selected option(s)s (only for choice types)
 └ option_identifiers                  list of strings            The ``identifier`` fields of the selected option(s)s
@@ -203,30 +179,6 @@ pdf_data                              object                     Data object req
                                                                  ``pdf_data=true`` query parameter to your request.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
-
-   The attribute ``tax_rule`` has been added.
-
-.. versionchanged:: 1.11
-
-   The attribute ``checkins.list`` has been added.
-
-.. versionchanged:: 1.14
-
-  The attributes ``answers.question_identifier`` and ``answers.option_identifiers`` have been added.
-
-.. versionchanged:: 1.16
-
-  The attributes ``pseudonymization_id`` and ``pdf_data`` have been added.
-
-.. versionchanged:: 3.0
-
-  The attribute ``seat`` has been added.
-
-.. versionchanged:: 3.2
-
-  The value ``auto_checked_in`` has been added to the ``checkins``-attribute.
-
 .. versionchanged:: 3.3
 
   The ``url`` of a ticket ``download`` can now also return a ``text/uri-list`` instead of a file. See
@@ -236,6 +188,18 @@ pdf_data                              object                     Data object req
 
   The attribute ``canceled`` has been added.
 
+.. versionchanged:: 3.8
+
+  The attributes ``company``, ``street``, ``zipcode``, ``city``, ``country``, and ``state`` have been added.
+
+.. versionchanged:: 3.9
+
+  The ``checkin.type`` attribute has been added.
+
+.. versionchanged:: 3.16
+
+   Answers to file questions are now returned as an URL.
+
 .. _order-payment-resource:
 
 Order payment resource
@@ -264,14 +228,6 @@ details                               object                     Payment-specifi
                                                                  the object is empty.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.0
-
-  This resource has been added.
-
-.. versionchanged:: 3.1
-
-  The attributes ``payment_url`` and ``details`` have been added.
-
 .. _order-refund-resource:
 
 Order refund resource
@@ -287,21 +243,14 @@ state                                 string                     Payment state,
 source                                string                     How this refund has been created, one of ``buyer``, ``admin``, or ``external``
 amount                                money (string)             Payment amount
 created                               datetime                   Date and time of creation of this payment
-payment_date                          datetime                   Date and time of completion of this payment (or ``null``)
+comment                               string                     Reason for refund (shown to the customer in some cases, can be ``null``).
+execution_date                        datetime                   Date and time of completion of this refund (or ``null``)
 provider                              string                     Identification string of the payment provider
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 2.0
-
-  This resource has been added.
-
 List of all orders
 ------------------
 
-.. versionchanged:: 1.15
-
-   Filtering for emails or order codes is now case-insensitive.
-
 .. versionchanged:: 3.5
 
    The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
@@ -339,6 +288,7 @@ List of all orders
             "secret": "k24fiuwvu8kxz3y1",
             "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
             "email": "tester@example.org",
+            "phone": "+491234567",
             "locale": "en",
             "sales_channel": "web",
             "datetime": "2017-12-01T10:00:00Z",
@@ -380,6 +330,12 @@ List of all orders
                   "full_name": "Peter",
                 },
                 "attendee_email": null,
+                "company": "Sample company",
+                "street": "Test street 12",
+                "zipcode": "12345",
+                "city": "Testington",
+                "country": "DE",
+                "state": null,
                 "voucher": null,
                 "tax_rate": "0.00",
                 "tax_value": "0.00",
@@ -392,6 +348,7 @@ List of all orders
                 "checkins": [
                   {
                     "list": 44,
+                    "type": "entry",
                     "datetime": "2017-12-25T12:45:23Z",
                     "auto_checked_in": false
                   }
@@ -441,6 +398,7 @@ List of all orders
                            ``last_modified``, and ``status``. Default: ``datetime``
    :query string code: Only return orders that match the given order code
    :query string status: Only return orders in the given order status (see above)
+   :query string search: Only return orders matching a given search query
    :query boolean testmode: Only return orders with ``testmode`` set to ``true`` or ``false``
    :query boolean require_approval: If set to ``true`` or ``false``, only categories with this value for the field
                                     ``require_approval`` will be returned.
@@ -453,6 +411,9 @@ List of all orders
        recommend using this in combination with ``testmode=false``, since test mode orders can vanish at any time and
        you will not notice it using this method.
    :query datetime created_since: Only return orders that have been created since the given date.
+   :query datetime subevent_after: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive after, and it considers the **end** of the subevent (or its start, if the end is not set).
+   :query datetime subevent_before: Only return orders that contain a ticket for a subevent taking place after the given date. This is an exclusive before, and it considers the **start** of the subevent.
+   :query string exclude: Exclude a field from the output, e.g. ``fees`` or ``positions.downloads``. Can be used as a performance optimization. Can be passed multiple times.
    :param organizer: The ``slug`` field of the organizer to fetch
    :param event: The ``slug`` field of the event to fetch
    :resheader X-Page-Generated: The server time at the beginning of the operation. If you're using this API to fetch
@@ -495,6 +456,7 @@ Fetching individual orders
         "secret": "k24fiuwvu8kxz3y1",
         "url": "https://test.pretix.eu/dummy/dummy/order/ABC12/k24fiuwvu8kxz3y1/",
         "email": "tester@example.org",
+        "phone": "+491234567",
         "locale": "en",
         "sales_channel": "web",
         "datetime": "2017-12-01T10:00:00Z",
@@ -536,6 +498,12 @@ Fetching individual orders
               "full_name": "Peter",
             },
             "attendee_email": null,
+            "company": "Sample company",
+            "street": "Test street 12",
+            "zipcode": "12345",
+            "city": "Testington",
+            "country": "DE",
+            "state": null,
             "voucher": null,
             "tax_rate": "0.00",
             "tax_rule": null,
@@ -548,6 +516,7 @@ Fetching individual orders
             "checkins": [
               {
                 "list": 44,
+                "type": "entry",
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -654,6 +623,8 @@ Updating order fields
 
    * ``email``
 
+   * ``phone``
+
    * ``checkin_attention``
 
    * ``locale``
@@ -816,9 +787,9 @@ Creating orders
    * ``consume_carts`` (optional) – A list of cart IDs. All cart positions with these IDs will be deleted if the
      order creation is successful. Any quotas or seats that become free by this operation will be credited to your order
      creation.
-   * ``email``
+   * ``email`` (optional)
    * ``locale``
-   * ``sales_channel``
+   * ``sales_channel`` (optional)
    * ``payment_provider`` (optional) – The identifier of the payment provider set for this order. This needs to be an
      existing payment provider. You should use ``"free"`` for free orders, and we strongly advise to use ``"manual"``
      for all orders you create as paid. This field is optional when the order status is ``"n"`` or the order total is
@@ -851,15 +822,21 @@ Creating orders
 
       * ``positionid`` (optional, see below)
       * ``item``
-      * ``variation``
+      * ``variation`` (optional)
       * ``price`` (optional, if set to ``null`` or missing the price will be computed from the given product)
       * ``seat`` (The ``seat_guid`` attribute of a seat. Required when the specified ``item`` requires a seat, otherwise must be ``null``.)
-      * ``attendee_name`` **or** ``attendee_name_parts``
+      * ``attendee_name`` **or** ``attendee_name_parts`` (optional)
       * ``voucher`` (optional, the ``code`` attribute of a valid voucher)
-      * ``attendee_email``
+      * ``attendee_email`` (optional)
+      * ``company`` (optional)
+      * ``street`` (optional)
+      * ``zipcode`` (optional)
+      * ``city`` (optional)
+      * ``country`` (optional)
+      * ``state`` (optional)
       * ``secret`` (optional)
       * ``addon_to`` (optional, see below)
-      * ``subevent``
+      * ``subevent`` (optional)
       * ``answers``
 
         * ``question``
@@ -883,8 +860,9 @@ Creating orders
         during order generation and is not respected automatically when the order changes later.)
 
    * ``force`` (optional). If set to ``true``, quotas will be ignored.
-   * ``send_mail`` (optional). If set to ``true``, the same emails will be sent as for a regular order. Defaults to
-     ``false``.
+   * ``send_email`` (optional). If set to ``true``, the same emails will be sent as for a regular order, regardless of
+     whether these emails are enabled for certain sales channels. Defaults to
+     ``false``. Used to be ``send_mail`` before pretix 3.14.
 
    If you want to use add-on products, you need to set the ``positionid`` fields of all positions manually
    to incrementing integers starting with ``1``. Then, you can reference one of these
@@ -977,6 +955,10 @@ Creating orders
 Order state operations
 ----------------------
 
+.. versionchanged:: 3.12
+
+   The ``mark_paid`` operation now takes a ``send_email`` parameter.
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_paid/
 
    Marks a pending or expired order as successfully paid.
@@ -988,6 +970,11 @@ Order state operations
       POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/mark_paid/ HTTP/1.1
       Host: pretix.eu
       Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+          "send_email": true
+      }
 
    **Example response**:
 
@@ -1057,6 +1044,42 @@ Order state operations
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order does not exist.
 
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/reactivate/
+
+   Reactivates a canceled order. This will set the order to pending or paid state. Only possible if all products are
+   still available.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/orders/ABC12/reactivate/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "code": "ABC12",
+        "status": "n",
+        ...
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param code: The ``code`` field of the order to modify
+   :statuscode 200: no error
+   :statuscode 400: The order cannot be reactivated
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
+   :statuscode 404: The requested order does not exist.
+
 .. http:post:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/mark_pending/
 
    Marks a paid order as unpaid.
@@ -1333,21 +1356,6 @@ Sending e-mails
 List of all order positions
 ---------------------------
 
-.. versionchanged:: 1.15
-
-   The order positions endpoint has been extended by the filter queries ``item__in``, ``variation__in``,
-   ``order__status__in``, ``subevent__in``, ``addon_to__in`` and ``search``. The search for attendee names and order
-   codes is now case-insensitive.
-
-.. versionchanged:: 2.0
-
-   The order positions endpoint has been extended by the filter queries ``voucher``, ``voucher__code`` and
-   ``pseudonymization_id``.
-
-.. versionchanged:: 3.2
-
-  The value ``auto_checked_in`` has been added to the ``checkins``-attribute.
-
 .. versionchanged:: 3.5
 
    The ``include_canceled_positions`` and ``include_canceled_fees`` query parameters have been added.
@@ -1402,6 +1410,7 @@ List of all order positions
             "checkins": [
               {
                 "list": 44,
+                "type": "entry",
                 "datetime": "2017-12-25T12:45:23Z",
                 "auto_checked_in": false
               }
@@ -1507,6 +1516,7 @@ Fetching individual positions
         "checkins": [
           {
             "list": 44,
+            "type": "entry",
             "datetime": "2017-12-25T12:45:23Z",
             "auto_checked_in": false
           }
@@ -1592,6 +1602,67 @@ Order position ticket download
 Manipulating individual positions
 ---------------------------------
 
+.. versionchanged:: 3.15
+
+   The ``PATCH`` method has been added for individual positions.
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
+
+   Updates specific fields on an order position. Currently, only the following fields are supported:
+
+   * ``attendee_email``
+
+   * ``attendee_name_parts`` or ``attendee_name``
+
+   * ``company``
+
+   * ``street``
+
+   * ``zipcode``
+
+   * ``city``
+
+   * ``country``
+
+   * ``state``
+
+   * ``answers``: If specified, you will need to provide **all** answers for this order position.
+     Validation is handled the same way as when creating orders through the API. You are therefore
+     expected to provide ``question``, ``answer``, and possibly ``options``. ``question_identifier``
+     and ``option_identifiers`` will be ignored.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/orderpositions/23442/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "attendee_email": "other@example.org"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      (Full order resource, see above.)
+
+   :param organizer: The ``slug`` field of the organizer of the event
+   :param event: The ``slug`` field of the event
+   :param id: The ``id`` field of the order position to update
+
+   :statuscode 200: no error
+   :statuscode 400: The order could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to update this order.
+
 .. http:delete:: /api/v1/organizers/(organizer)/events/(event)/orderpositions/(id)/
 
    Deletes an order position, identified by its internal ID.
@@ -1624,14 +1695,14 @@ Manipulating individual positions
 Order payment endpoints
 -----------------------
 
-.. versionchanged:: 2.0
-
-  These endpoints have been added.
-
 .. versionchanged:: 3.6
 
    Payments can now be created through the API.
 
+.. versionchanged:: 3.12
+
+   The ``confirm`` operation now takes a ``send_email`` parameter.
+
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/payments/
 
    Returns a list of all payments for an order.
@@ -1732,7 +1803,10 @@ Order payment endpoints
       Accept: application/json, text/javascript
       Content-Type: application/json
 
-      {"force": false}
+      {
+          "send_email": true,
+          "force": false
+      }
 
    **Example response**:
 
@@ -1864,6 +1938,7 @@ Order payment endpoints
         "amount": "23.00",
         "payment_date": "2017-12-04T12:13:12Z",
         "info": {},
+        "send_email": false,
         "provider": "banktransfer"
       }
 
@@ -1899,10 +1974,6 @@ Order payment endpoints
 Order refund endpoints
 ----------------------
 
-.. versionchanged:: 2.0
-
-  These endpoints have been added.
-
 .. http:get:: /api/v1/organizers/(organizer)/events/(event)/orders/(code)/refunds/
 
    Returns a list of all refunds for an order.
@@ -1936,6 +2007,7 @@ Order refund endpoints
             "payment": 1,
             "created": "2017-12-01T10:00:00Z",
             "execution_date": "2017-12-04T12:13:12Z",
+            "comment": "Cancellation",
             "provider": "banktransfer"
           }
         ]
@@ -1978,6 +2050,7 @@ Order refund endpoints
         "payment": 1,
         "created": "2017-12-01T10:00:00Z",
         "execution_date": "2017-12-04T12:13:12Z",
+        "comment": "Cancellation",
         "provider": "banktransfer"
       }
 
@@ -2012,6 +2085,7 @@ Order refund endpoints
         "amount": "23.00",
         "payment": 1,
         "execution_date": null,
+        "comment": "Cancellation",
         "provider": "manual",
         "mark_canceled": false,
         "mark_pending": true
@@ -2033,6 +2107,7 @@ Order refund endpoints
         "payment": 1,
         "created": "2017-12-01T10:00:00Z",
         "execution_date": null,
+        "comment": "Cancellation",
         "provider": "manual"
       }
 
@@ -2156,3 +2231,57 @@ Order refund endpoints
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.
    :statuscode 404: The requested order or refund does not exist.
+
+Revoked ticket secrets
+----------------------
+
+With some non-default ticket secret generation methods, a list of revoked ticket secrets is required for proper validation.
+
+.. versionchanged:: 3.12
+
+   Added revocation lists.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/revokedsecrets/
+
+   Returns a list of all revoked secrets within a given event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/revokedsecrets/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+      X-Page-Generated: 2017-12-01T10:00:00Z
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1234,
+            "secret": "k24fiuwvu8kxz3y1",
+            "created": "2017-12-01T10:00:00Z",
+          }
+        ]
+      }
+
+   :query integer page: The page number in case of a multi-page result set, default is 1
+   :query string ordering: Manually set the ordering of results. Valid fields to be used are ``secret`` and ``created``. Default: ``-created``
+   :query datetime created_since: Only return revocations that have been created since the given date.
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :resheader X-Page-Generated: The server time at the beginning of the operation. If you're using this API to fetch
+                                differences, this is the value you want to use as ``created_since`` in your next call.
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to view this resource.

doc/api/resources/organizers.rst

@@ -90,3 +90,120 @@ Endpoints
    :statuscode 200: no error
    :statuscode 401: Authentication failure
    :statuscode 403: The requested organizer does not exist **or** you have no permission to view it.
+
+Organizer settings
+------------------
+
+pretix organizers and events have lots and lots of parameters of different types that are stored in a key-value store on our system.
+Since many of these settings depend on each other in complex ways, we can not give direct access to all of these
+settings through the API. However, we do expose many of the simple and useful flags through the API.
+
+Please note that the available settings flags change between pretix versions, and we do not give a guarantee on backwards-compatibility like with other parts of the API.
+Therefore, we're also not including a list of the options here, but instead recommend to look at the endpoint output
+to see available options. The ``explain=true`` flag enables a verbose mode that provides you with human-readable
+information about the properties.
+
+.. note:: Please note that this is not a complete representation of all organizer settings. You will find more settings
+          in the web interface.
+
+.. warning:: This API is intended for advanced users. Even though we take care to validate your input, you will be
+             able to break your shops using this API by creating situations of conflicting settings. Please take care.
+
+.. versionchanged:: 3.14
+
+   Initial support for settings has been added to the API.
+
+.. http:get:: /api/v1/organizers/(organizer)/settings/
+
+   Get current values of organizer settings.
+
+   Permission required: "Can change organizer settings"
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/settings/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example standard response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "event_list_type": "calendar",
+        …
+      }
+
+   **Example verbose response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "event_list_type":
+          {
+            "value": "calendar",
+            "label": "Default overview style",
+            "help_text": "If your event series has more than 50 dates in the future, only the month or week calendar can be used."
+          }
+        },
+        …
+      }
+
+   :param organizer: The ``slug`` field of the organizer to access
+   :query explain: Set to ``true`` to enable verbose response mode
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to view this resource.
+
+.. http:patch:: /api/v1/organizers/(organizer)/settings/
+
+   Updates organizer settings. Note that ``PUT`` is not allowed here, only ``PATCH``.
+
+    .. warning::
+
+       Settings can be stored at different levels in pretix. If a value is not set on organizer level, a default setting
+       from a higher level (global) will be returned. If you explicitly set a setting on organizer level, it
+       will no longer be inherited from the higher levels. Therefore, we recommend you to send only settings that you
+       explicitly want to set on organizer level. To unset a settings, pass ``null``.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/settings/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+
+      {
+        "event_list_type": "calendar"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "event_list_type": "calendar",
+        …
+      }
+
+   :param organizer: The ``slug`` field of the organizer to update
+   :statuscode 200: no error
+   :statuscode 400: The organizer could not be updated due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer does not exist **or** you have no permission to create this resource.

doc/api/resources/question_options.rst

@@ -19,10 +19,6 @@ identifier                            string                     An arbitrary st
 answer                                multi-lingual string       The displayed value of this option
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-   This resource has been added.
-
 Endpoints
 ---------
 

doc/api/resources/questions.rst

@@ -1,4 +1,7 @@
-.. spelling:: checkin
+.. spelling::
+
+   checkin
+   datetime
 
 .. _rest-questions:
 
@@ -53,6 +56,12 @@ options                               list of objects            In case of ques
 ├ identifier                          string                     An arbitrary string that can be used for matching with
                                                                  other sources.
 └ answer                              multi-lingual string       The displayed value of this option
+valid_number_min                      string                     Minimum value for number questions (optional)
+valid_number_max                      string                     Maximum value for number questions (optional)
+valid_date_min                        date                       Minimum value for date questions (optional)
+valid_date_max                        date                       Maximum value for date questions (optional)
+valid_datetime_min                    datetime                   Minimum value for date and time questions (optional)
+valid_datetime_max                    datetime                   Maximum value for date and time questions (optional)
 dependency_question                   integer                    Internal ID of a different question. The current
                                                                  question will only be shown if the question given in
                                                                  this attribute is set to the value given in
@@ -66,32 +75,14 @@ dependency_value                      string                     An old version
                                                                  for one value. **Deprecated.**
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.12
-
-  The values ``D``, ``H``, and ``W`` for the field ``type`` are now allowed and the ``ask_during_checkin`` field has
-  been added.
-
-.. versionchanged:: 1.14
-
-  Write methods have been added. The attribute ``identifier`` has been added to both the resource itself and the
-  options resource. The ``position`` attribute has been added to the options resource.
-
-.. versionchanged:: 2.7
-
-  The attribute ``hidden`` and the question type ``CC`` have been added.
-
-.. versionchanged:: 3.0
-
-  The attribute ``dependency_values`` has been added.
-
-.. versionchanged:: 3.1
-
-  The attribute ``print_on_invoice`` has been added.
-
 .. versionchanged:: 3.5
 
   The attribute ``help_text`` has been added.
 
+.. versionchanged:: 3.14
+
+  The attributes ``valid_*`` have been added.
+
 Endpoints
 ---------
 
@@ -137,6 +128,12 @@ Endpoints
             "ask_during_checkin": false,
             "hidden": false,
             "print_on_invoice": false,
+            "valid_number_min": null,
+            "valid_number_max": null,
+            "valid_date_min": null,
+            "valid_date_max": null,
+            "valid_datetime_min": null,
+            "valid_datetime_max": null,
             "dependency_question": null,
             "dependency_value": null,
             "dependency_values": [],
@@ -208,6 +205,12 @@ Endpoints
         "ask_during_checkin": false,
         "hidden": false,
         "print_on_invoice": false,
+        "valid_number_min": null,
+        "valid_number_max": null,
+        "valid_date_min": null,
+        "valid_date_max": null,
+        "valid_datetime_min": null,
+        "valid_datetime_max": null,
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
@@ -302,6 +305,12 @@ Endpoints
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
+        "valid_number_min": null,
+        "valid_number_max": null,
+        "valid_date_min": null,
+        "valid_date_max": null,
+        "valid_datetime_min": null,
+        "valid_datetime_max": null,
         "options": [
           {
             "id": 1,
@@ -377,6 +386,12 @@ Endpoints
         "dependency_question": null,
         "dependency_value": null,
         "dependency_values": [],
+        "valid_number_min": null,
+        "valid_number_max": null,
+        "valid_date_min": null,
+        "valid_date_max": null,
+        "valid_datetime_min": null,
+        "valid_datetime_max": null,
         "options": [
           {
             "id": 1,

doc/api/resources/quotas.rst

@@ -26,15 +26,13 @@ close_when_sold_out                   boolean                    If ``true``, th
                                                                  again.
 closed                                boolean                    Whether the quota is currently closed (see above
                                                                  field).
+release_after_exit                    boolean                    Whether the quota regains capacity as soon as some tickets
+                                                                 have been scanned at an exit.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.10
+.. versionchanged:: 3.10
 
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 3.0
-
-   The attributes ``close_when_sold_out`` and ``closed`` have been added.
+   The attribute ``release_after_exit`` has been added.
 
 
 Endpoints
@@ -283,6 +281,7 @@ Endpoints
         "total_size": 1000,
         "pending_orders": 25,
         "paid_orders": 423,
+        "exited_orders": 0,
         "cart_positions": 7,
         "blocking_vouchers": 126,
         "waiting_list": 0

doc/api/resources/seatingplans.rst

@@ -20,10 +20,6 @@ layout                                object                     JSON representa
                                                                  still evolves. The version in use can be found `here`_.
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 3.0
-
-   This endpoint has been added.
-
 Endpoints
 ---------
 

doc/api/resources/subevents.rst

@@ -33,47 +33,40 @@ date_to                               datetime                   The sub-event's
 date_admission                        datetime                   The sub-event's admission date (or ``null``)
 presale_start                         datetime                   The sub-date at which the ticket shop opens (or ``null``)
 presale_end                           datetime                   The sub-date at which the ticket shop closes (or ``null``)
+frontpage_text                        multi-lingual string       The description of the event (or ``null``)
 location                              multi-lingual string       The sub-event location (or ``null``)
 geo_lat                               float                      Latitude of the location (or ``null``)
 geo_lon                               float                      Longitude of the location (or ``null``)
 item_price_overrides                  list of objects            List of items for which this sub-event overrides the
                                                                  default price
 ├ item                                integer                    The internal item ID
+├ disabled                            boolean                    If ``true``, item should not be available for this sub-event
 └ price                               money (string)             The price or ``null`` for the default price
 variation_price_overrides             list of objects            List of variations for which this sub-event overrides
                                                                  the default price
 ├ variation                           integer                    The internal variation ID
+├ disabled                            boolean                    If ``true``, variation should not be available for this sub-event
 └ price                               money (string)             The price or ``null`` for the default price
 meta_data                             object                     Values set for organizer-specific meta data parameters.
 seating_plan                          integer                    If reserved seating is in use, the ID of a seating
                                                                  plan. Otherwise ``null``.
 seat_category_mapping                 object                     An object mapping categories of the seating plan
                                                                  (strings) to items in the event (integers or ``null``).
+last_modified                         datetime                   Last modification of this object
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
-
-   The ``meta_data`` field has been added.
-
-.. versionchanged:: 2.1
-
-   The ``event`` field has been added, together with filters on the list of dates and an organizer-level list.
-
-.. versionchanged:: 2.6
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 2.7
-
-   The attribute ``is_public`` has been added.
-
-.. versionchanged:: 3.0
-
-   The attributes ``seating_plan`` and ``seat_category_mapping`` have been added.
-
 .. versionchanged:: 3.3
 
    The attributes ``geo_lat`` and ``geo_lon`` have been added.
 
+.. versionchanged:: 3.10
+
+   The ``disabled`` attribute has been added to ``item_price_overrides`` and ``variation_price_overrides``.
+
+.. versionchanged:: 3.12
+
+   The ``last_modified`` attribute has been added.
+
 Endpoints
 ---------
 
@@ -125,6 +118,7 @@ Endpoints
             "item_price_overrides": [
               {
                 "item": 2,
+                "disabled": false,
                 "price": "12.00"
               }
             ],
@@ -141,6 +135,8 @@ Endpoints
    :query ends_after: If set to a date and time, only events that happen during of after the given time are returned.
    :param organizer: The ``slug`` field of a valid organizer
    :param event: The ``slug`` field of the main event
+   :query datetime modified_since: Only return objects that have changed since the given date. Be careful: This does not
+       allow you to know if a subevent was deleted.
    :query array attr[meta_data_key]: By providing the key and value of a meta data attribute, the list of sub-events
         will only contain the sub-events matching the set criteria. Providing ``?attr[Format]=Seminar`` would return
         only those sub-events having set their ``Format`` meta data to ``Seminar``, ``?attr[Format]=`` only those, that
@@ -182,6 +178,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -216,6 +213,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -271,6 +269,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "12.00"
           }
         ],
@@ -307,6 +306,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "23.42"
           }
         ],
@@ -339,6 +339,7 @@ Endpoints
         "item_price_overrides": [
           {
             "item": 2,
+            "disabled": false,
             "price": "23.42"
           }
         ],
@@ -427,6 +428,7 @@ Endpoints
             "item_price_overrides": [
               {
                 "item": 2,
+                "disabled": false,
                 "price": "12.00"
               }
             ],

doc/api/resources/taxrules.rst

@@ -24,14 +24,6 @@ home_country                          string                     Merchant countr
                                                                  ``null`` or empty string
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.7
-
-   This resource has been added.
-
-.. versionchanged:: 1.9
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
 
 Endpoints
 ---------

doc/api/resources/vouchers.rst

@@ -46,14 +46,6 @@ show_hidden_items                     boolean                    Only if set to
 ===================================== ========================== =======================================================
 
 
-.. versionchanged:: 1.9
-
-   The write operations ``POST``, ``PATCH``, ``PUT``, and ``DELETE`` have been added.
-
-.. versionchanged:: 3.0
-
-   The attribute ``show_hidden_items`` has been added.
-
 .. versionchanged:: 3.4
 
    The attribute ``seat`` has been added.

doc/api/resources/webhooks.rst

@@ -31,8 +31,10 @@ action_types                          list of strings            A list of actio
 The following values for ``action_types`` are valid with pretix core:
 
     * ``pretix.event.order.placed``
+    * ``pretix.event.order.placed.require_approval``
     * ``pretix.event.order.paid``
     * ``pretix.event.order.canceled``
+    * ``pretix.event.order.reactivated``
     * ``pretix.event.order.expired``
     * ``pretix.event.order.modified``
     * ``pretix.event.order.contact.changed``
@@ -42,6 +44,12 @@ The following values for ``action_types`` are valid with pretix core:
     * ``pretix.event.order.denied``
     * ``pretix.event.checkin``
     * ``pretix.event.checkin.reverted``
+    * ``pretix.event.added``
+    * ``pretix.event.changed``
+    * ``pretix.event.deleted``
+    * ``pretix.subevent.added``
+    * ``pretix.subevent.changed``
+    * ``pretix.subevent.deleted``
 
 Installed plugins might register more valid values.
 

doc/api/webhooks.rst

@@ -70,6 +70,9 @@ and ``checkin_list``.
              only include the minimum amount of data necessary for you to fetch the changed objects from our
              :ref:`rest-api` in an authenticated way.
 
+.. warning:: In very rare cases, you could receive the same webhook notification twice. We try to avoid it, but we
+             prefer it over missing a notification.
+
 If you want to further prevent others from accessing your webhook URL, you can also use `Basic authentication`_ and
 supply the URL to us in the format of ``https://username:password@domain.com/path/``.
 We recommend that you use HTTPS for your webhook URL and might require it in the future. If HTTPS is used, we require

doc/conf.py

@@ -52,6 +52,7 @@ extensions = [
     'sphinx.ext.coverage',
     'sphinxcontrib.httpdomain',
     'sphinxcontrib.images',
+    'sphinxemoji.sphinxemoji',
 ]
 if HAS_PYENCHANT:
     extensions.append('sphinxcontrib.spelling')

doc/development/api/customview.rst

@@ -14,7 +14,9 @@ Control panel views
 -------------------
 
 If you want to add a custom view to the control area of an event, just register an URL in your
-``urls.py`` that lives in the ``/control/`` subpath::
+``urls.py`` that lives in the ``/control/`` subpath:
+
+.. code-block:: python
 
     from django.conf.urls import url
 
@@ -44,7 +46,9 @@ If only the ``organizer`` parameter is present, it will be ensured that:
 * The user has permission to access view the current organizer
 
 If you want to require specific permission types, we provide you with a decorator or a mixin for
-your views::
+your views:
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         event_permission_required, EventPermissionRequiredMixin
@@ -61,12 +65,13 @@ your views::
         ...
 
 Similarly, there is ``organizer_permission_required`` and ``OrganizerPermissionRequiredMixin``. In case of
-event-related views, there is also a signal that allows you to add the view to the event navigation like this::
+event-related views, there is also a signal that allows you to add the view to the event navigation like this:
 
+.. code-block:: python
 
     from django.urls import resolve, reverse
     from django.dispatch import receiver
-    from django.utils.translation import ugettext_lazy as _
+    from django.utils.translation import gettext_lazy as _
     from pretix.control.signals import nav_event
 
 
@@ -90,7 +95,9 @@ Event settings view
 -------------------
 
 A special case of a control panel view is a view hooked into the event settings page. For this case, there is a
-special navigation signal::
+special navigation signal:
+
+.. code-block:: python
 
     @receiver(nav_event_settings, dispatch_uid='friends_tickets_nav_settings')
     def navbar_settings(sender, request, **kwargs):
@@ -105,7 +112,9 @@ special navigation signal::
         }]
 
 Also, your view should inherit from ``EventSettingsViewMixin`` and your template from ``pretixcontrol/event/settings_base.html``
-for good integration. If you just want to display a form, you could do it like the following::
+for good integration. If you just want to display a form, you could do it like the following:
+
+.. code-block:: python
 
     class MySettingsView(EventSettingsViewMixin, EventSettingsFormView):
         model = Event
@@ -147,7 +156,9 @@ Including a custom view into the participant-facing frontend is a little bit dif
 no path prefix like ``control/``.
 
 First, define your URL in your ``urls.py``, but this time in the ``event_patterns`` section and wrapped by
-``event_url``::
+``event_url``:
+
+.. code-block:: python
 
     from pretix.multidomain import event_url
 
@@ -182,8 +193,9 @@ standard Django request handling: There are `ViewSets`_ to group related views i
 automatically build URL configurations from them.
 
 To integrate a custom viewset with pretix' REST API, you can just register with one of our routers within the
-``urls.py`` module of your plugin::
+``urls.py`` module of your plugin:
 
+.. code-block:: python
 
     from pretix.api.urls import event_router, router, orga_router
 
@@ -200,7 +212,9 @@ in the control panel. However, you need to make sure on your own only to return
 .event`` and ``request.organizer`` are available as usual.
 
 To require a special permission like ``can_view_orders``, you do not need to inherit from a special ViewSet base
-class, you can just set the ``permission`` attribute on your viewset::
+class, you can just set the ``permission`` attribute on your viewset:
+
+.. code-block:: python
 
     class MyViewSet(ModelViewSet):
         permission = 'can_view_orders'
@@ -208,8 +222,9 @@ class, you can just set the ``permission`` attribute on your viewset::
 
 If you want to check the permission only for some methods of your viewset, you have to do it yourself. Note here that
 API authentications can be done via user sessions or API tokens and you should therefore check something like the
-following::
+following:
 
+.. code-block:: python
 
     perm_holder = (request.auth if isinstance(request.auth, TeamAPIToken) else request.user)
     if perm_holder.has_event_permission(request.event.organizer, request.event, 'can_view_orders'):

doc/development/api/email.rst

@@ -15,7 +15,9 @@ Output registration
 The email HTML renderer API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available email renderers. Your plugin
 should listen for this signal and return the subclass of ``pretix.base.email.BaseHTMLMailRenderer``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -72,7 +74,9 @@ class ``TemplateBasedMailRenderer`` that you can re-use to perform the following
 * Call `inlinestyler`_ to convert all ``<style>`` style sheets to inline ``style=""``
   attributes for better compatibility
 
-To use it, you just need to implement some variables::
+To use it, you just need to implement some variables:
+
+.. code-block:: python
 
     class ClassicMailRenderer(TemplateBasedMailRenderer):
         verbose_name = _('pretix default')

doc/development/api/exporter.rst

@@ -17,7 +17,9 @@ Exporter registration
 The exporter API does not make a lot of usage from signals, however, it does use a signal to get a list of
 all available exporters. Your plugin should listen for this signal and return the subclass of
 ``pretix.base.exporter.BaseExporter``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -29,6 +31,24 @@ that we'll provide in this plugin::
         from .exporter import MyExporter
         return MyExporter
 
+Some exporters might also prove to be useful, when provided on an organizer-level. In order to declare your
+exporter as capable of providing exports spanning multiple events, your plugin should listen for this signal
+and return the subclass of ``pretix.base.exporter.BaseExporter`` that we'll provide in this plugin:
+
+.. code-block:: python
+
+    from django.dispatch import receiver
+
+    from pretix.base.signals import register_multievent_data_exporters
+
+
+    @receiver(register_multievent_data_exporters, dispatch_uid="multieventexporter_myexporter")
+    def register_multievent_data_exporter(sender, **kwargs):
+        from .exporter import MyExporter
+        return MyExporter
+
+If your exporter supports both event-level and multi-event level exports, you will need to listen for both
+signals.
 
 The exporter class
 ------------------

doc/development/api/general.rst

@@ -12,7 +12,8 @@ Core
 
 .. automodule:: pretix.base.signals
    :members: periodic_task, event_live_issues, event_copy_data, email_filter, register_notification_types,
-      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter
+      item_copy_data, register_sales_channels, register_global_settings, quota_availability, global_email_filter,
+      register_ticket_secret_generators
 
 Order events
 """"""""""""
@@ -20,7 +21,7 @@ Order events
 There are multiple signals that will be sent out in the ordering cycle:
 
 .. automodule:: pretix.base.signals
-   :members: validate_cart, validate_cart_addons, validate_order, order_fee_calculation, order_paid, order_placed, order_canceled, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
+   :members: validate_cart, validate_cart_addons, validate_order, order_fee_calculation, order_paid, order_placed, order_canceled, order_reactivated, order_expired, order_modified, order_changed, order_approved, order_denied, order_fee_type_name, allow_ticket_download, order_split, order_gracefully_delete, invoice_line_text
 
 Check-ins
 """""""""
@@ -33,11 +34,11 @@ Frontend
 --------
 
 .. automodule:: pretix.presale.signals
-   :members: html_head, html_footer, footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, item_description
+   :members: html_head, html_footer, footer_link, global_footer_link, front_page_top, front_page_bottom, front_page_bottom_widget, fee_calculation_for_cart, contact_form_fields, question_form_fields, contact_form_fields_overrides, question_form_fields_overrides, checkout_confirm_messages, checkout_confirm_page_content, checkout_all_optional, html_page_header, sass_preamble, sass_postamble, render_seating_plan, checkout_flow_steps, position_info, position_info_top, item_description, global_html_head, global_html_footer, global_html_page_header
 
 
 .. automodule:: pretix.presale.signals
-   :members: order_info, order_meta_from_request
+   :members: order_info, order_info_top, order_meta_from_request
 
 Request flow
 """"""""""""
@@ -57,7 +58,7 @@ Backend
 .. automodule:: pretix.control.signals
    :members: nav_event, html_head, html_page_start, quota_detail_html, nav_topbar, nav_global, nav_organizer, nav_event_settings,
              order_info, event_settings_widget, oauth_application_registered, order_position_buttons, subevent_forms,
-             item_formsets, order_search_filter_q
+             item_formsets, order_search_filter_q, order_search_forms
 
 .. automodule:: pretix.base.signals
    :members: logentry_display, logentry_object_link, requiredaction_display, timeline_events
@@ -66,25 +67,19 @@ Vouchers
 """"""""
 
 .. automodule:: pretix.control.signals
-   :members: item_forms
-
-Vouchers
-""""""""
-
-.. automodule:: pretix.control.signals
-   :members: voucher_form_class, voucher_form_html, voucher_form_validation
+   :members: item_forms, voucher_form_class, voucher_form_html, voucher_form_validation
 
 Dashboards
 """"""""""
 
 .. automodule:: pretix.control.signals
-   :members: event_dashboard_widgets, user_dashboard_widgets
+   :members: event_dashboard_widgets, user_dashboard_widgets, event_dashboard_top
 
 Ticket designs
 """"""""""""""
 
 .. automodule:: pretix.base.signals
-   :members: layout_text_variables
+   :members: layout_text_variables, layout_image_variables
 
 .. automodule:: pretix.plugins.ticketoutputpdf.signals
    :members: override_layout

doc/development/api/invoice.rst

@@ -15,7 +15,9 @@ Output registration
 The invoice renderer API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available invoice renderers. Your plugin
 should listen for this signal and return the subclass of ``pretix.base.invoice.BaseInvoiceRenderer``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 

doc/development/api/payment.rst

@@ -19,7 +19,9 @@ Provider registration
 The payment provider API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available payment providers. Your plugin
 should listen for this signal and return the subclass of ``pretix.base.payment.BasePaymentProvider``
-that the plugin will provide::
+that the plugin will provide:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -104,14 +106,22 @@ The provider class
 
    .. automethod:: payment_control_render
 
+   .. automethod:: payment_control_render_short
+
    .. automethod:: payment_refund_supported
 
    .. automethod:: payment_partial_refund_supported
 
+   .. automethod:: payment_presale_render
+
    .. automethod:: execute_refund
 
    .. automethod:: refund_control_render
 
+   .. automethod:: new_refund_control_form_render
+
+   .. automethod:: new_refund_control_form_process
+
    .. automethod:: api_payment_details
 
    .. automethod:: matching_id
@@ -126,6 +136,8 @@ The provider class
 
    .. autoattribute:: test_mode_message
 
+   .. autoattribute:: requires_invoice_immediately
+
 
 Additional views
 ----------------
@@ -138,7 +150,9 @@ it is necessary to introduce additional views. One example is the PayPal
 provider. It redirects the user to a PayPal website in the
 :py:meth:`BasePaymentProvider.checkout_prepare` step of the checkout process
 and provides PayPal with a URL to redirect back to. This URL points to a
-view which looks roughly like this::
+view which looks roughly like this:
+
+.. code-block:: python
 
     @login_required
     def success(request):

doc/development/api/placeholder.rst

@@ -13,7 +13,9 @@ Placeholder registration
 
 The placeholder API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available email placeholders. Your plugin
-should listen for this signal and return an instance of a subclass of ``pretix.base.email.BaseMailTextPlaceholder``::
+should listen for this signal and return an instance of a subclass of ``pretix.base.email.BaseMailTextPlaceholder``:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -71,7 +73,9 @@ Helper class for simple placeholders
 ------------------------------------
 
 pretix ships with a helper class that makes it easy to provide placeholders based on simple
-functions::
+functions:
+
+.. code-block:: python
 
      placeholder = SimpleFunctionalMailTextPlaceholder(
          'code', ['order'], lambda order: order.code, sample='F8VVL'

doc/development/api/plugins.rst

@@ -55,13 +55,15 @@ restricted         boolean (optional)   ``False`` by default, restricts a plugin
 compatibility      string               Specifier for compatible pretix versions.
 ================== ==================== ===========================================================
 
-A working example would be::
+A working example would be:
+
+.. code-block:: python
 
     try:
         from pretix.base.plugins import PluginConfig
     except ImportError:
         raise RuntimeError("Please use pretix 2.7 or above to run this plugin!")
-    from django.utils.translation import ugettext_lazy as _
+    from django.utils.translation import gettext_lazy as _
 
 
     class PaypalApp(PluginConfig):
@@ -81,7 +83,7 @@ A working example would be::
 
     default_app_config = 'pretix_paypal.PaypalApp'
 
-The ``AppConfig`` class may implement a property ``compatiblity_errors``, that checks
+The ``AppConfig`` class may implement a property ``compatibility_errors``, that checks
 whether the pretix installation meets all requirements of the plugin. If so,
 it should contain ``None`` or an empty list, otherwise a list of strings containing
 human-readable error messages. We recommend using the ``django.utils.functional.cached_property``
@@ -96,7 +98,9 @@ Plugin registration
 
 Somehow, pretix needs to know that your plugin exists at all. For this purpose, we
 make use of the `entry point`_ feature of setuptools. To register a plugin that lives
-in a separate python package, your ``setup.py`` should contain something like this::
+in a separate python package, your ``setup.py`` should contain something like this:
+
+.. code-block:: python
 
     setup(
         args...,
@@ -118,7 +122,9 @@ The various components of pretix define a number of signals which your plugin ca
 listen for. We will go into the details of the different signals in the following
 pages. We suggest that you put your signal receivers into a ``signals`` submodule
 of your plugin. You should extend your ``AppConfig`` (see above) by the following
-method to make your receivers available::
+method to make your receivers available:
+
+.. code-block:: python
 
     class PaypalApp(AppConfig):
         …
@@ -127,7 +133,9 @@ method to make your receivers available::
             from . import signals  # NOQA
 
 You can optionally specify code that is executed when your plugin is activated for an event
-in the ``installed`` method::
+in the ``installed`` method:
+
+.. code-block:: python
 
     class PaypalApp(AppConfig):
         …
@@ -136,7 +144,7 @@ in the ``installed`` method::
             pass  # Your code here
 
 
-Note that ``installed`` will *not* be called if the plugin in indirectly activated for an event
+Note that ``installed`` will *not* be called if the plugin is indirectly activated for an event
 because the event is created with settings copied from another event.
 
 Views
@@ -151,8 +159,8 @@ your Django app label.
    with checking that the calling user is logged in, has appropriate permissions,
    etc. We plan on providing native support for this in a later version.
 
-.. _Django app: https://docs.djangoproject.com/en/1.7/ref/applications/
-.. _signal dispatcher: https://docs.djangoproject.com/en/1.7/topics/signals/
-.. _namespace packages: http://legacy.python.org/dev/peps/pep-0420/
+.. _Django app: https://docs.djangoproject.com/en/3.0/ref/applications/
+.. _signal dispatcher: https://docs.djangoproject.com/en/3.0/topics/signals/
+.. _namespace packages: https://legacy.python.org/dev/peps/pep-0420/
 .. _entry point: https://setuptools.readthedocs.io/en/latest/pkg_resources.html#locating-plugins
 .. _cookiecutter: https://cookiecutter.readthedocs.io/en/latest/

doc/development/api/shredder.rst

@@ -74,7 +74,7 @@ looks like this:
 
         def generate_files(self) -> List[Tuple[str, str, str]]:
             yield 'invoice-addresses.json', 'application/json', json.dumps({
-                ia.order.code: InvoiceAdddressSerializer(ia).data
+                ia.order.code: InvoiceAddressSerializer(ia).data
                 for ia in InvoiceAddress.objects.filter(order__event=self.event)
             }, indent=4)
 

doc/development/api/ticketoutput.rst

@@ -17,7 +17,9 @@ Output registration
 The ticket output API does not make a lot of usage from signals, however, it
 does use a signal to get a list of all available ticket outputs. Your plugin
 should listen for this signal and return the subclass of ``pretix.base.ticketoutput.BaseTicketOutput``
-that we'll provide in this plugin::
+that we'll provide in this plugin:
+
+.. code-block:: python
 
     from django.dispatch import receiver
 
@@ -72,6 +74,10 @@ The output class
 
    .. autoattribute:: download_button_icon
 
+   .. autoattribute:: multi_download_button_text
+
+   .. autoattribute:: long_download_button_text
+
    .. autoattribute:: preview_allowed
 
    .. autoattribute:: javascript_required

doc/development/concepts.rst

@@ -82,11 +82,15 @@ Orders
 ^^^^^^
 
 If a customer completes the checkout process, an **Order** will be created containing all the entered information.
-An order can be in one of currently four states that are listed in the diagram below:
+An order can be in one of currently six states that are listed in the diagram below:
 
 .. image:: /images/order_states.png
 
-There are additional "fake" states that are displayed like states but not represented as states in the system:
+The dotted lines represent status changes that usually do not happen as part of the regular process, but can be
+performed manually in the admin backend.
+
+For historical reasons, there are only four valid values of the ``status`` field, and the two additional states are
+represented differently:
 
 * An order is considered **canceled (with paid fee)** if it is in **paid** status but does not include any non-cancelled positions.
 

doc/development/contribution/style.rst

@@ -7,7 +7,7 @@ Coding style and quality
   for more information. Use four spaces for indentation.
 
 * We sort our imports by a certain schema, but you don't have to do this by hand. Again, ``setup.cfg`` contains
-  some definitions that allow the command ``isort -rc <directory>`` to automatically sort the imports in your source
+  some definitions that allow the command ``isort <directory>`` to automatically sort the imports in your source
   files.
 
 * For templates and models, please take a look at the `Django Coding Style`_. We like Django's `class-based views`_ and
@@ -18,7 +18,7 @@ Coding style and quality
 * We expect all new code to come with proper tests. When writing new tests, please write them using `pytest-style`_
   test functions and raw ``assert`` statements. Use `fixtures`_ to prevent repetitive code. Some old parts of pretix'
   test suite are in the style of Python's unit test module. If you extend those files, you might continue in this style,
-  but please use pytest style for any new test files.
+  but please use ``pytest`` style for any new test files.
 
 * Please keep the first line of your commit messages short. When referencing an issue, please phrase it like
   ``Fix #123 -- Problems with order creation`` or ``Refs #123 -- Fix this part of that bug``.

doc/development/implementation/background.rst

@@ -12,7 +12,9 @@ Implementing a task
 -------------------
 
 A common pattern for implementing asynchronous tasks can be seen a lot in ``pretix.base.services``
-and looks like this::
+and looks like this:
+
+.. code-block:: python
 
     from pretix.celery_app import app
 
@@ -34,13 +36,15 @@ If your user needs to wait for the response of the asynchronous task, there are
 that will probably move to ``pretix.base`` at some point. They consist of the view mixin ``AsyncAction`` that allows
 you to easily write a view that kicks off and waits for an asynchronous task. ``AsyncAction`` will determine whether
 to run the task asynchronously or not and will do some magic to look nice for users with and without JavaScript support.
-A usage example taken directly from the code is::
+A usage example taken directly from the code is:
+
+.. code-block:: python
 
     class OrderCancelDo(EventViewMixin, OrderDetailMixin, AsyncAction, View):
         """
         A view that executes a task asynchronously. A POST request will kick off the
         task into the background or run it in the foreground if celery is not installed.
-        In the former case, subsequent GET calls can be used to determinine the current
+        In the former case, subsequent GET calls can be used to determine the current
         status of the task.
         """
 
@@ -79,7 +83,9 @@ A usage example taken directly from the code is::
             return super().get_error_message(exception)
 
 On the client side, this can be used by simply adding a ``data-asynctask`` attribute to an HTML form. This will enable
-AJAX sending of the form and display a loading indicator::
+AJAX sending of the form and display a loading indicator:
+
+.. code-block:: html
 
     <form method="post" data-asynctask
           action="{% eventurl request.event "presale:event.order.cancel.do" … %}">

doc/development/implementation/i18n.rst

@@ -27,7 +27,9 @@ numbers and dates, ``LazyDate`` and ``LazyNumber``. There also is a ``LazyLocale
 exceptions with gettext-localized exception messages.
 
 Last, but definitely not least, we have the ``language`` context manager (``pretix.base.i18n.language``) that allows
-you to execute a piece of code with a different locale::
+you to execute a piece of code with a different locale:
+
+.. code-block:: python
 
     with language('de'):
         render_mail_template()

doc/development/implementation/logging.rst

@@ -16,7 +16,9 @@ We recommend all relevant models to inherit from ``LoggedModel`` as it simplifie
 .. autoclass:: pretix.base.models.LoggedModel
    :members: log_action, all_logentries
 
-To actually log an action, you can just call the ``log_action`` method on your object::
+To actually log an action, you can just call the ``log_action`` method on your object:
+
+.. code-block:: python
 
    order.log_action('pretix.event.order.canceled', user=user, data={})
 
@@ -29,7 +31,9 @@ Logging form actions
 """"""""""""""""""""
 
 A very common use case is to log the changes to a model that have been done in a ``ModelForm``. In this case,
-we generally use a custom ``form_valid`` method on our ``FormView`` that looks like this::
+we generally use a custom ``form_valid`` method on our ``FormView`` that looks like this:
+
+.. code-block:: python
 
     @transaction.atomic
     def form_valid(self, form):
@@ -40,7 +44,9 @@ we generally use a custom ``form_valid`` method on our ``FormView`` that looks l
         messages.success(self.request, _('Your changes have been saved.'))
         return super().form_valid(form)
 
-It gets a little bit more complicated if your form allows file uploads::
+It gets a little bit more complicated if your form allows file uploads:
+
+.. code-block:: python
 
     @transaction.atomic
     def form_valid(self, form):
@@ -67,9 +73,11 @@ following ready-to-include template::
 
 We now need a way to translate the action codes like ``pretix.event.changed`` into human-readable
 strings. The :py:attr:`pretix.base.signals.logentry_display` signals allows you to do so. A simple
-implementation could look like::
+implementation could look like:
 
-    from django.utils.translation import ugettext as _
+.. code-block:: python
+
+    from django.utils.translation import gettext as _
     from pretix.base.signals import logentry_display
 
     @receiver(signal=logentry_display)
@@ -88,7 +96,9 @@ Sending notifications
 
 If you think that the logged information might be important or urgent enough to send out a notification to interested
 organizers. In this case, you should listen for the :py:attr:`pretix.base.signals.register_notification_types` signal
-to register a notification type::
+to register a notification type:
+
+.. code-block:: python
 
     @receiver(register_notification_types)
     def register_my_notification_types(sender, **kwargs):
@@ -103,7 +113,9 @@ You should subclass the base ``NotificationType`` class and implement all its me
 .. autoclass:: pretix.base.notifications.NotificationType
    :members: action_type, verbose_name, required_permission, build_notification
 
-A simple implementation could look like this::
+A simple implementation could look like this:
+
+.. code-block:: python
 
     class MyNotificationType(NotificationType):
         required_permission = "can_view_orders"
@@ -143,7 +155,9 @@ Logging technical information
 -----------------------------
 
 If you just want to log technical information to a log file on disk that does not need to be parsed
-and displayed later, you can just use Python's ``logging`` module::
+and displayed later, you can just use Python's ``logging`` module:
+
+.. code-block:: python
 
    import logging
 
@@ -151,7 +165,9 @@ and displayed later, you can just use Python's ``logging`` module::
 
    logger.info('Startup complete.')
 
-This is also very useful to provide debugging information when an exception occurs::
+This is also very useful to provide debugging information when an exception occurs:
+
+.. code-block:: python
 
    try:
       foo()

doc/development/implementation/permissions.rst

@@ -15,7 +15,9 @@ Requiring permissions for a view
 --------------------------------
 
 pretix provides a number of useful mixins and decorators that allow you to specify that a user needs a certain
-permission level to access a view::
+permission level to access a view:
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         OrganizerPermissionRequiredMixin, organizer_permission_required
@@ -44,7 +46,9 @@ permission level to access a view::
         # Only users with *any* permission on this organizer can access this
 
 
-Of course, the same is available on event level::
+Of course, the same is available on event level:
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         EventPermissionRequiredMixin, event_permission_required
@@ -73,7 +77,9 @@ Of course, the same is available on event level::
         # Only users with *any* permission on this event can access this
 
 You can also require that this view is only accessible by system administrators with an active "admin session"
-(see below for what this means)::
+(see below for what this means):
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         AdministratorPermissionRequiredMixin, administrator_permission_required
@@ -89,7 +95,9 @@ You can also require that this view is only accessible by system administrators
         # ...
 
 In rare cases it might also be useful to expose a feature only to people who have a staff account but do not
-necessarily have an active admin session::
+necessarily have an active admin session:
+
+.. code-block:: python
 
     from pretix.control.permissions import (
         StaffMemberRequiredMixin, staff_member_required

doc/development/implementation/settings.rst

@@ -39,7 +39,9 @@ subclass that also adds support for internationalized fields:
 
 .. autoclass:: pretix.base.forms.SettingsForm
 
-You can simply use it like this::
+You can simply use it like this:
+
+.. code-block:: python
 
    class EventSettingsForm(SettingsForm):
        show_date_to = forms.BooleanField(
@@ -56,7 +58,9 @@ You can simply use it like this::
 Defaults in plugins
 -------------------
 
-Plugins can add custom hardcoded defaults in the following way::
+Plugins can add custom hardcoded defaults in the following way:
+
+.. code-block:: python
 
     from pretix.base.settings import settings_hierarkey
 

doc/development/setup.rst

@@ -98,7 +98,7 @@ pull request nevertheless and ask us for help, we are happy to assist you.
 Execute the following commands to check for code style errors::
 
     flake8 .
-    isort -c -rc .
+    isort -c .
     python manage.py check
 
 Execute the following command to run pretix' test suite (might take a couple of minutes)::
@@ -117,11 +117,11 @@ for example, to check for any errors in any staged files when committing::
     export GIT_WORK_TREE=../
     export GIT_DIR=../.git
     source ../env/bin/activate  # Adjust to however you activate your virtual environment
-    for file in $(git diff --cached --name-only | grep -E '\.py$' | grep -Ev "migrations|mt940\.py|pretix/settings\.py|make_testdata\.py|testutils/settings\.py|tests/settings\.py|pretix/base/models/__init__\.py")
+    for file in $(git diff --cached --name-only | grep -E '\.py$' | grep -Ev "migrations|mt940\.py|pretix/settings\.py|make_testdata\.py|testutils/settings\.py|tests/settings\.py|pretix/base/models/__init__\.py|.*_pb2\.py")
     do
       echo $file
       git show ":$file" | flake8 - --stdin-display-name="$file" || exit 1 # we only want to lint the staged changes, not any un-staged changes
-      git show ":$file" | isort -df --check-only - | grep ERROR && exit 1 || true
+      git show ":$file" | isort -c - | grep ERROR && exit 1 || true
     done
 
 

doc/images/order_objects.puml

@@ -0,0 +1,34 @@
+@startuml
+
+participant User
+collections "OrderPayment\nOrderRefund" as P
+collections "Order\nOrderPosition" as O
+collections "Invoice\nInvoiceLine" as I
+
+User -> O: Order placed (€100)
+rnote over O #6DD96D: Order A1B2C\nstatus = **n**\ntotal = €100
+O -> P: Payment created
+O -> I: Invoice created\n(can also happen later)
+rnote over I #6DD96D: Invoice 00001\n€100
+rnote over P #6DD96D: OrderPayment A1B2C-P-1\nstate = **created**
+P -> User: Payment details (web, email)
+User -> P: Payment performed
+rnote over P #EFF46B: OrderPayment A1B2C-P-1\nstate = **confirmed**
+P -> O: Order marked as paid
+rnote over O #EFF46B: Order A1B2C\nstatus = **p**\ntotal = €100
+User -> O: Data change (e.g. invoice address)
+O -> I: Invoice reissued
+rnote over I #6DD96D: Invoice 00002\n€-100
+rnote over I #6DD96D: Invoice 00003\n€100
+rnote over O #EFF46B: Order A1B2C\nstatus = **p**\ntotal = €100
+User -> O: Order canceled
+rnote over O #EFF46B: Order A1B2C\nstatus = **c**
+O -> I: Invoice canceled
+rnote over I #6DD96D: Invoice 00004\n€-100
+O -> P: Refund started
+rnote over P #6DD96D: OrderRefund\nA1B2C-R-1\nstate = **created**
+P -> User: Money sent
+rnote over P #EFF46B: OrderRefund\nA1B2C-R-1\nstate = **done**
+
+@enduml
+

doc/images/order_states.puml

@@ -1,19 +1,39 @@
 @startuml
 
-Pending: Order is expecting payment\nOrder reduces quotas
-Expired: Payment period is over\nOrder does not affect quotas
-Paid: Order was successful\nOrder reduces quotas
-Canceled: Order has been canceled\nOrder does not affect quotas
+state "Approval Pending" as AP
+state "Canceled (with paid fee)" as CP
+AP: status = "n"
+AP: require_approval = true
+Pending: status = "n"
+Pending: require_approval = false
+Pending: Tickets reserved: yes
+Expired: status = "e"
+Expired: Tickets reserved: no
+Paid: status = "p"
+Paid: count(positions | !canceled) > 0
+Paid: Tickets reserved: yes
+CP: status = "p"
+CP: count(positions | !canceled) = 0
+Canceled: status = "c"
+Canceled: Tickets reserved: no
 
-[*] --> Pending: customer\nplaces order
-Pending --> Paid: successful payment
-Pending --> Expired: automatically\nor manually\non admin action
-Expired --> Paid: if payment is received\nonly if quota left
-Expired --> Canceled
-Expired --> Pending: manually\non admin action
-Paid --> Canceled: manually on\nadmin action\nor if an external\npayment provider\nnotifies about a\npayment refund
-Pending --> Canceled: on admin or\ncustomer action
-Paid -> Pending: manually on admin action
-[*] --> Paid: customer\nplaces free order
+
+[*] -> Pending: order placed\ntotal > 0
+[*] -> Paid: order placed\ntotal = 0
+[*] -> AP: order placed\napproval required
+Pending --> Paid: order paid
+Pending --> Expired: after payment\ndeadline
+Expired --> Paid: order paid\n(only if quota left)
+Expired -[dashed]-> Canceled
+Expired -[dashed]-> Pending: order extended
+Paid --> Canceled: order canceled
+Pending --> Canceled: order canceled
+Paid -[dashed]-> Pending: refund
+AP --> Pending: order approved
+AP --> Canceled: order denied
+Paid --> CP: order canceled\n(with cancellation fee)
+Canceled -[dashed]-> Pending: order reactivated
+Canceled -[dashed]-> Paid: order reactivated
+CP -[dashed]-> Canceled: fee canceled
 
 @enduml

doc/plugins/badges.rst

@@ -22,10 +22,6 @@ item_assignments                      list of objects            Products this l
 └ item                                integer                    Item ID
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.16
-
-   This resource has been added.
-
 
 Endpoints
 ---------

doc/plugins/banktransfer.rst

@@ -34,6 +34,8 @@ transactions                          list of objects            Transactions in
 ├ payer                               string                     Payment source
 ├ reference                           string                     Payment reference
 ├ amount                              string                     Payment amount
+├ iban                                string                     Payment IBAN
+├ bic                                 string                     Payment BIC
 ├ date                                string                     Payment date (in **user-inputted** format)
 ├ order                               string                     Associated order code (or ``null``)
 └ comment                             string                     Internal comment
@@ -83,6 +85,8 @@ Endpoints
                 "date": "26.06.2017",
                 "payer": "John Doe",
                 "order": null,
+                "iban": "",
+                "bic": "",
                 "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
                 "reference": "GUTSCHRIFT\r\nSAMPLECONF-NAB12 EREF: SAMPLECONF-NAB12\r\nIBAN: DE1234556…",
                 "state": "nomatch",
@@ -132,6 +136,8 @@ Endpoints
             "comment": "",
             "date": "26.06.2017",
             "payer": "John Doe",
+            "iban": "",
+            "bic": "",
             "order": null,
             "checksum": "5de03a601644dfa63420dacfd285565f8375a8f2",
             "reference": "GUTSCHRIFT\r\nSAMPLECONF-NAB12 EREF: SAMPLECONF-NAB12\r\nIBAN: DE1234556…",

doc/plugins/digital.rst

@@ -0,0 +1,356 @@
+Digital content
+===============
+
+URL interpolation and JWT authentication
+----------------------------------------
+
+In the simplest case, you can use the digital content module to point users to a specific piece of content on some
+platform after their ticket purchase, or show them an embedded video or live stream. However, the full power of the
+module can be utilized by passing additional information to the target system to automatically authenticate the user
+or pre-fill some fields with their data. For example, you could use an URL like this::
+
+    https://webinars.example.com/join?as={attendee_name}&userid={order_code}-{positionid}
+
+While this is already useful, it does not provide much security – anyone could guess a valid combination for that URL.
+Therefore, the module allows you to pass information as a `JSON Web Token`_, which isn't encrypted, but signed with a
+shared secret such that nobody can create their own tokens or modify the contents. To use a token, set up a URL like this::
+
+    https://webinars.example.com/join?with_token={token}
+
+Additionally, you will need to set a JWT secret and a token template, either through the pretix interface or through the
+API (see below). pretix currently only supports tokens signed with ``HMAC-SHA256`` (``HS256``). Your token template can contain
+whatever JSON you'd like to pass on based on the same variables, for example::
+
+    {
+        "iss": "pretix.eu",
+        "aud": "webinars.example.com",
+        "user": {
+            "id": "{order_code}-{positionid}",
+            "product": "{product_id}",
+            "variation": "{variation_id}",
+            "name": "{attendee_name}"
+        }
+    }
+
+Variables can only be used in strings inside the JSON structure.
+pretix will automatically add an ``iat`` claim with the current timestamp and an ``exp`` claim with an expiration timestamp
+based on your configuration.
+
+
+List of variables
+"""""""""""""""""
+
+The following variables are currently supported:
+
+.. rst-class:: rest-resource-table
+
+=================================== ====================================================================
+Variable                            Description
+=================================== ====================================================================
+``order_code``                      Order code (alphanumerical, unique per order, not per ticket)
+``positionid``                      ID of the ticket within the order (integer, starting at 1)
+``order_email``                     E-mail address of the ticket purchaser
+``product_id``                      Internal ID of the purchased product
+``product_variation``               Internal ID of the purchased product variation (or empty)
+``attendee_name``                   Full name of the ticket holder (or empty)
+``attendee_name_*``                 Name parts of the ticket holder, depending on configuration, e.g. ``attendee_name_given_name`` or ``attendee_name_family_name``
+``attendee_email``                  E-mail address of the ticket holder (or empty)
+``attendee_company``                Company of the ticket holder (or empty)
+``attendee_street``                 Street of the ticket holder's address (or empty)
+``attendee_zipcode``                ZIP code of the ticket holder's address (or empty)
+``attendee_city``                   City of the ticket holder's address (or empty)
+``attendee_country``                Country code of the ticket holder's address (or empty)
+``attendee_state``                  State of the ticket holder's address (or empty)
+``answer[XYZ]``                     Answer to the custom question with identifier ``XYZ``
+``invoice_name``                    Full name of the invoice address (or empty)
+``invoice_name_*``                  Name parts of the invoice address, depending on configuration, e.g. ``invoice_name_given_name`` or ``invoice_name_family_name``
+``invoice_company``                 Company of the invoice address (or empty)
+``invoice_street``                  Street of the invoice address (or empty)
+``invoice_zipcode``                 ZIP code of the invoice address (or empty)
+``invoice_city``                    City of the invoice address (or empty)
+``invoice_country``                 Country code of the invoice address (or empty)
+``invoice_state``                   State of the invoice address (or empty)
+``meta_XYZ``                        Value of the event's ``XYZ`` meta property
+``token``                           Signed JWT (only to be used in URLs, not in tokens)
+=================================== ====================================================================
+
+
+API Resource description
+-------------------------
+
+The digital content plugin provides a HTTP API that allows you to create new digital content for your ticket holders,
+such as live streams, videos, or material downloads.
+
+The digital content resource contains the following public fields:
+
+.. rst-class:: rest-resource-table
+
+===================================== ========================== =======================================================
+Field                                 Type                       Description
+===================================== ========================== =======================================================
+id                                    integer                    Internal content ID
+title                                 multi-lingual string       The content title (required)
+content_type                          string                     The type of content, valid values are ``webinar``, ``video``, ``livestream``, ``link``, ``file``
+url                                   string                     The location of the digital content
+description                           multi-lingual string       A public description of the item. May contain Markdown
+                                                                 syntax and is not required.
+available_from                        datetime                   The first date time at which this content will be shown
+                                                                 (or ``null``).
+available_until                       datetime                   The last date time at which this content will b e shown
+                                                                 (or ``null``).
+all_products                          boolean                    If ``true``, the content is available to all buyers of tickets for this event. The ``limit_products`` field is ignored in this case.
+limit_products                        list of integers           List of product/item IDs. This content is only shown to buyers of these ticket types.
+position                              integer                    An integer, used for sorting
+subevent                              integer                    Date in an event series this content should be shown for. Should be ``null`` if this is not an event series or if this should be shown to all customers.
+jwt_template                          string                     Template for JWT token generation
+jwt_secret                            string                     Secret for JWT token generation
+jwt_validity                          integer                    JWT validity in days
+===================================== ========================== =======================================================
+
+API Endpoints
+-------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/
+
+   Returns a list of all digital content configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "count": 1,
+        "next": null,
+        "previous": null,
+        "results": [
+          {
+            "id": 1,
+            "subevent": null,
+            "title": {
+                "en": "Concert livestream"
+            },
+            "content_type": "link",
+            "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+            "description": {
+                "en": "Watch our event live here on YouTube!"
+            },
+            "all_products": true,
+            "limit_products": [],
+            "available_from": "2020-03-22T23:00:00Z",
+            "available_until": null,
+            "position": 1
+          }
+        ]
+      }
+
+   :query page: The page number in case of a multi-page result set, default is 1
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
+
+   Returns information on one content item, identified by its ID.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 1,
+        "subevent": null,
+        "title": {
+            "en": "Concert livestream"
+        },
+        "content_type": "link",
+        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "description": {
+            "en": "Watch our event live here on YouTube!"
+        },
+        "all_products": true,
+        "limit_products": [],
+        "available_from": "2020-03-22T23:00:00Z",
+        "available_until": null,
+        "position": 1
+      }
+
+   :param organizer: The ``slug`` field of the organizer to fetch
+   :param event: The ``slug`` field of the event to fetch
+   :param id: The ``id`` field of the content to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to view it.
+
+.. http:post:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/
+
+   Create a new digital content.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      POST /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 166
+
+      {
+        "subevent": null,
+        "title": {
+            "en": "Concert livestream"
+        },
+        "content_type": "link",
+        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "description": {
+            "en": "Watch our event live here on YouTube!"
+        },
+        "all_products": true,
+        "limit_products": [],
+        "available_from": "2020-03-22T23:00:00Z",
+        "available_until": null,
+        "position": 1
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 201 Created
+      Vary: Accept
+      Content-Type: application/json
+
+      {
+        "id": 2,
+        "subevent": null,
+        "title": {
+            "en": "Concert livestream"
+        },
+        "content_type": "link",
+        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
+        "description": {
+            "en": "Watch our event live here on YouTube!"
+        },
+        "all_products": true,
+        "limit_products": [],
+        "available_from": "2020-03-22T23:00:00Z",
+        "available_until": null,
+        "position": 1
+      }
+
+   :param organizer: The ``slug`` field of the organizer to create new content for
+   :param event: The ``slug`` field of the event to create new content for
+   :statuscode 201: no error
+   :statuscode 400: The content could not be created due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event does not exist **or** you have no permission to create digital contents.
+
+
+.. http:patch:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
+
+   Update a content. You can also use ``PUT`` instead of ``PATCH``. With ``PUT``, you have to provide all fields of
+   the resource, other fields will be reset to default. With ``PATCH``, you only need to provide the fields that you
+   want to change.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      PATCH /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+      Content-Type: application/json
+      Content-Length: 34
+
+      {
+        "url": "https://mywebsite.com"
+      }
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: text/javascript
+
+      {
+        "id": 2,
+        "subevent": null,
+        "title": {
+            "en": "Concert livestream"
+        },
+        "content_type": "link",
+        "url": "https://mywebsite.com",
+        "description": {
+            "en": "Watch our event live here on YouTube!"
+        },
+        "all_products": true,
+        "limit_products": [],
+        "available_from": "2020-03-22T23:00:00Z",
+        "available_until": null,
+        "position": 1
+      }
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the content to modify
+   :statuscode 200: no error
+   :statuscode 400: The content could not be modified due to invalid submitted data.
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to change it.
+
+
+.. http:delete:: /api/v1/organizers/(organizer)/events/(event)/digitalcontents/(id)/
+
+   Delete a digital content.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      DELETE /api/v1/organizers/bigevents/events/sampleconf/digitalcontents/1/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 204 No Content
+      Vary: Accept
+
+   :param organizer: The ``slug`` field of the organizer to modify
+   :param event: The ``slug`` field of the event to modify
+   :param id: The ``id`` field of the content to delete
+   :statuscode 204: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer/event/content does not exist **or** you have no permission to change it
+
+.. _JSON Web Token: https://en.wikipedia.org/wiki/JSON_Web_Token

doc/plugins/index.rst

@@ -15,3 +15,5 @@ If you want to **create** a plugin, please go to the
    ticketoutputpdf
    badges
    campaigns
+   digital
+   webinar

doc/plugins/ticketoutputpdf.rst

@@ -24,14 +24,6 @@ item_assignments                      list of objects            Products this l
 └ item                                integer                    Item ID
 ===================================== ========================== =======================================================
 
-.. versionchanged:: 1.16
-
-   This resource has been added.
-
-.. versionchanged:: 2.3
-
-   The ``item_assignments.sales_channel`` field has been added.
-
 
 Endpoints
 ---------

doc/plugins/webinar.rst

@@ -0,0 +1,43 @@
+pretix Webinar
+==============
+
+Fetch host URLs
+---------------
+
+.. http:get:: /api/v1/organizers/(organizer)/events/(event)/webinars/
+
+   Returns a list of all currently available webinar calls configured for an event.
+
+   **Example request**:
+
+   .. sourcecode:: http
+
+      GET /api/v1/organizers/bigevents/events/sampleconf/webinars/ HTTP/1.1
+      Host: pretix.eu
+      Accept: application/json, text/javascript
+
+   **Example response**:
+
+   .. sourcecode:: http
+
+      HTTP/1.1 200 OK
+      Vary: Accept
+      Content-Type: application/json
+
+      [
+        {
+          "name": "Webinar B – Sept. 8th, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/a9aded3d7bd4df60/30611a34f9fee5d3/"
+        },
+        {
+          "name": "Webinar A – Sept. 8, 2020",
+          "hosturl": "http://pretix.eu/demo/museum/webinar/host/e714x7d4a4a36a04/b9cc444665xxx757/"
+        }
+      ]
+
+   :query subevent: Limit the result to the webinar(s) for a specific subevent.
+   :param organizer: The ``slug`` field of a valid organizer
+   :param event: The ``slug`` field of the event to fetch
+   :statuscode 200: no error
+   :statuscode 401: Authentication failure
+   :statuscode 403: The requested organizer or event does not exist **or** you have no permission to view it.

doc/requirements.txt

@@ -3,7 +3,8 @@ sphinx==2.3.*
 sphinx-rtd-theme
 sphinxcontrib-httpdomain
 sphinxcontrib-images
-sphinxcontrib-spelling
+sphinxcontrib-spelling==4.*
+sphinxemoji
 pygments-markdown-lexer
 # See https://github.com/rfk/pyenchant/pull/130
 git+https://github.com/raphaelm/pyenchant.git@patch-1#egg=pyenchant