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


Models / Diff Snapshot
======================

.. automodule:: teksi_hooks.models.diff_snapshot

DiffSnapshot
------------

.. autoclass:: teksi_hooks.models.diff_snapshot.DiffSnapshot
   :members:

Fields
~~~~~~

``metadata``
   Type: ``SnapshotMetadata``

   Snapshot creation metadata.

``snapshot_id``
   Type: ``UUID``

   Stable identifier of this immutable snapshot. Persistence decisions must reference this identifier to prevent decisions from being applied to another snapshot.

``objects``
   Type: ``tuple[SnapshotObject, ...]``

   Canonical objects referenced by the snapshot.

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

   Canonical effects captured in the snapshot.


SnapshotMetadata
----------------

.. autoclass:: teksi_hooks.models.diff_snapshot.SnapshotMetadata
   :members:

Fields
~~~~~~

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

   Timestamp when the snapshot was generated.

``source_model``
   Type: ``str``

   Source model from which the snapshot was generated.

``source_class_id``
   Type: ``str``

   Source class that initiated snapshot creation.

``source_object_id``
   Type: ``str``

   Source object identifier that initiated snapshot creation.


SnapshotObject
--------------

.. autoclass:: teksi_hooks.models.diff_snapshot.SnapshotObject
   :members:

Fields
~~~~~~

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

   Canonical identity of the referenced object.

``last_modification``
   Type: ``datetime``

   Object last_modification value recorded when the snapshot was generated.


SnapshotValidationFinding
-------------------------

.. autoclass:: teksi_hooks.models.diff_snapshot.SnapshotValidationFinding
   :members:

Fields
~~~~~~

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

   Canonical identity of the referenced object.

``state``
   Type: ``SnapshotState``

   Snapshot state (enumeration)