fsi.models.course_notification_template
=======================================

.. py:module:: fsi.models.course_notification_template


Attributes
----------

.. autoapisummary::

   fsi.models.course_notification_template.NotificationType
   fsi.models.course_notification_template.NOTIFICATION_TYPES
   fsi.models.course_notification_template.NOTIFICATION_TYPE_TRANSLATIONS
   fsi.models.course_notification_template.GERMAN_TYPE_TRANSLATIONS


Classes
-------

.. autoapisummary::

   fsi.models.course_notification_template.CourseInvitationTemplate
   fsi.models.course_notification_template.CourseNotificationTemplate
   fsi.models.course_notification_template.InfoTemplate
   fsi.models.course_notification_template.SubscriptionTemplate
   fsi.models.course_notification_template.ReminderTemplate
   fsi.models.course_notification_template.CancellationTemplate


Functions
---------

.. autoapisummary::

   fsi.models.course_notification_template.template_type_choices
   fsi.models.course_notification_template.get_template_default
   fsi.models.course_notification_template.template_name


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

.. py:type:: NotificationType
   :canonical: Literal['info', 'reservation', 'reminder', 'cancellation']


.. py:data:: NOTIFICATION_TYPES
   :type:  tuple[NotificationType, Ellipsis]
   :value: ('info', 'reservation', 'reminder', 'cancellation')


.. py:data:: NOTIFICATION_TYPE_TRANSLATIONS

.. py:data:: GERMAN_TYPE_TRANSLATIONS

.. py:function:: template_type_choices(request: onegov.fsi.request.FsiRequest | None = None) -> tuple[tuple[str, str], Ellipsis]

.. py:function:: get_template_default(context: Any, type: str | None = None) -> str

.. py:function:: template_name(type: NotificationType | Literal['invitation'], request: onegov.fsi.request.FsiRequest | None = None) -> str

.. py:class:: CourseInvitationTemplate

   This is kind of a dummy db model for using as the template for
   CourseInviteMailLayout. If needed, this can be replaced with
   a real model without changing too much code.


   .. py:attribute:: text
      :value: None



   .. py:attribute:: text_html
      :value: None



   .. py:attribute:: type
      :type:  Literal['invitation']
      :value: 'invitation'



   .. py:attribute:: subject


.. py:class:: CourseNotificationTemplate

   Bases: :py:obj:`onegov.core.orm.Base`, :py:obj:`onegov.core.orm.mixins.ContentMixin`, :py:obj:`onegov.core.orm.mixins.TimestampMixin`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __tablename__
      :value: 'fsi_notification_templates'



   .. py:attribute:: __table_args__


   .. py:attribute:: type
      :type:  sqlalchemy.Column[NotificationType]


   .. py:attribute:: __mapper_args__


   .. py:attribute:: course_event_id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: course_event
      :type:  sqlalchemy.orm.relationship[fsi.models.course_event.CourseEvent]


   .. py:attribute:: id
      :type:  sqlalchemy.Column[uuid.UUID]


   .. py:attribute:: subject
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: text
      :type:  sqlalchemy.Column[str | None]


   .. py:attribute:: last_sent
      :type:  sqlalchemy.Column[datetime.datetime | None]


   .. py:method:: duplicate() -> Self


   .. py:property:: text_html
      :type: markupsafe.Markup | None



.. py:class:: InfoTemplate

   Bases: :py:obj:`CourseNotificationTemplate`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __mapper_args__


.. py:class:: SubscriptionTemplate

   Bases: :py:obj:`CourseNotificationTemplate`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __mapper_args__


.. py:class:: ReminderTemplate

   Bases: :py:obj:`CourseNotificationTemplate`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __mapper_args__


.. py:class:: CancellationTemplate

   Bases: :py:obj:`CourseNotificationTemplate`


   Mixin providing a meta/content JSON pair. Meta is a JSON column loaded
   with each request, content is a JSON column loaded deferred (to be shown
   only in the detail view).



   .. py:attribute:: __mapper_args__