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


Models / Effects
================

.. automodule:: teksi_hooks.models.effects

Effect
------

.. autoclass:: teksi_hooks.models.effects.Effect
   :members:


EffectDocument
--------------

.. autoclass:: teksi_hooks.models.effects.EffectDocument
   :members:

Fields
~~~~~~

``source``
   Type: ``EffectSource``

   Source object from which the effects were generated.

``effects``
   Type: ``tuple[Effect, ...]``

   Effects generated from the source object.

``created_at``
   Type: ``datetime``

   Timestamp when the effect document was created.

``version``
   Type: ``int``

   Version of the effect-document contract.


EffectEvaluationResult
----------------------

.. autoclass:: teksi_hooks.models.effects.EffectEvaluationResult
   :members:

Fields
~~~~~~

``effect_index``
   Type: ``int``

   Zero-based index of the evaluated effect in the corresponding EffectDocument.effects sequence.

``status``
   Type: ``EffectEvaluationStatus``

   Evaluation status describing whether the desired-state effect is satisfied, remediable through persistence, or blocked.

``findings``
   Type: ``tuple[ValidationFinding, ...]``

   Ordered validation findings produced while evaluating the effect. Remediable findings describe discrepancies that may be reconciled during persistence. Blocking findings explain why the effect cannot safely be applied.

``metadata``
   Type: ``dict[str, Any]``

   Optional implementation-specific evaluation metadata. This may include observed canonical values, resolved identities, mapping provenance, target classifications or diagnostic context. Generic consumers must not assign semantics to these entries.


EffectSource
------------

.. autoclass:: teksi_hooks.models.effects.EffectSource
   :members:

Fields
~~~~~~

``model``
   Type: ``str``

   Source model identifier.

``class_id``
   Type: ``str``

   Source class identifier.

``object_id``
   Type: ``str``

   Source object identifier.


EnforceExistsEffect
-------------------

.. autoclass:: teksi_hooks.models.effects.EnforceExistsEffect
   :members:

Base class: ``Effect``

Fields
~~~~~~

``kind``
   Type: ``EffectKind``

   Effect kind discriminator.

``identity``
   Type: ``CanonicalObjectIdentity``

   Canonical object identity used to locate the target object.


EnforceNotExistsEffect
----------------------

.. autoclass:: teksi_hooks.models.effects.EnforceNotExistsEffect
   :members:

Base class: ``Effect``

Fields
~~~~~~

``kind``
   Type: ``EffectKind``

   Effect kind discriminator.

``identity``
   Type: ``CanonicalObjectIdentity``

   Canonical object identity used to locate the target object.


UpdateAttributeEffect
---------------------

.. autoclass:: teksi_hooks.models.effects.UpdateAttributeEffect
   :members:

Base class: ``Effect``

Fields
~~~~~~

``kind``
   Type: ``EffectKind``

   Effect kind discriminator.

``identity``
   Type: ``CanonicalObjectIdentity``

   Canonical object identity used to locate the target object.

``attribute_id``
   Type: ``str``

   Canonical attribute identifier being updated.

``value``
   Type: ``Any``

   New value that should be assigned to the target attribute.