.. This page is generated by scripts/generate_dataclass_docs.py.
   Do not edit manually.


Models / Conditions
===================

.. automodule:: teksi_hooks.models.conditions

AllOfCondition
--------------

.. autoclass:: teksi_hooks.models.conditions.AllOfCondition
   :members:

Base class: ``Condition``

Fields
~~~~~~

``conditions``
   Type: ``tuple``

   Conditions that must all evaluate to true.


AnyOfCondition
--------------

.. autoclass:: teksi_hooks.models.conditions.AnyOfCondition
   :members:

Base class: ``Condition``

Fields
~~~~~~

``conditions``
   Type: ``tuple``

   Conditions of which at least one must evaluate to true.


LocalCondition
--------------

.. autoclass:: teksi_hooks.models.conditions.LocalCondition
   :members:

Base class: ``Condition``

Fields
~~~~~~

``attribute``
   Type: ``str``

   Name of the local attribute to evaluate.

``operator``
   Type: ``str``

   Comparison operator to apply, for example `equals`, `is_null`, `in` or `equals_context`.

``value``
   Type: ``str | None``

   Optional comparison value. Some operators, such as `is_null`, may not require a value.


RemoteCondition
---------------

.. autoclass:: teksi_hooks.models.conditions.RemoteCondition
   :members:

Base class: ``Condition``

Fields
~~~~~~

``relation``
   Type: ``str``

   Name of the relation used to reach the related object.

``attribute``
   Type: ``str``

   Name of the attribute on the related object to evaluate.

``operator``
   Type: ``str``

   Comparison operator to apply, for example `equals`, `is_null`, `in` or `equals_context`.

``value``
   Type: ``str | None``

   Optional comparison value. Some operators may not require a value.