================
Notification API
================

Notifications
=============

Example Use Inside of an Adapter Action

.. code-block:: python

    from artificial.client.notificationapi.v1.notificationapi import Severity

    @action()
    async def send_notifications(self, actx: ActionExecutionContext) -> None:
        # This example will surface an error to Artificial LabOps System Monitor
        await self.artificial_api.notification_api_v1.raise_notification(actx=actx, message='Info Message', severity=Severity.INFO)
        await self.artificial_api.notification_api_v1.raise_notification(actx=actx, message='Warning Message', severity=Severity.WARNING)
        await self.artificial_api.notification_api_v1.raise_notification(actx=actx, message='Error Message', severity=Severity.ERROR)

.. automodule:: artificial.client.notificationapi.v1.notificationapi
   :members:

.. toctree::
   :maxdepth: 1
   :hidden: