flip_api.model_services.utils.audit_helper
==========================================

.. py:module:: flip_api.model_services.utils.audit_helper


Functions
---------

.. autoapisummary::

   flip_api.model_services.utils.audit_helper.audit_model_action
   flip_api.model_services.utils.audit_helper.audit_model_actions


Module Contents
---------------

.. py:function:: audit_model_action(model_id: uuid.UUID, action: flip_api.domain.schemas.actions.ModelAuditAction, user_id: uuid.UUID, session: sqlmodel.Session) -> flip_api.db.models.main_models.ModelsAudit

   Insert a single audit log into the ModelsAudit table.

   :param model_id: The ID of the model being audited.
   :type model_id: UUID
   :param action: The action performed on the model.
   :type action: ModelAuditAction
   :param user_id: The ID of the user performing the action.
   :type user_id: UUID
   :param session: SQLModel session.
   :type session: Session

   :returns: The created ModelsAudit entry.
   :rtype: ModelsAudit


.. py:function:: audit_model_actions(actions: list[flip_api.domain.interfaces.model.IModelAuditAction], session: sqlmodel.Session) -> list[flip_api.db.models.main_models.ModelsAudit]

   Bulk insert multiple audit logs into the ModelsAudit table.

   :param actions: List of actions to audit.
   :type actions: list[IModelAuditAction]
   :param session: SQLModel session.
   :type session: Session

   :returns: List of created ModelsAudit entries.
   :rtype: list[ModelsAudit]

   :raises RuntimeError: If ``actions`` is non-empty but no audit rows ended up being created.