using EnvelopeGenerator.Domain.Constants;

namespace EnvelopeGenerator.Application.EmailTemplates;

/// <summary>
/// Stellt eine Schnittstelle für Abfragen von E-Mail-Vorlagen dar, die für Absender und Empfänger von Umschlägen verwendet werden.
/// Die Standardkultur ist "de-DE".
/// </summary>
public interface IEmailTemplateQuery
{
    /// <summary>
    /// Die eindeutige Kennung der E-Mail-Vorlage (optional).
    /// </summary>
    int? Id { get; set; }

    /// <summary>
    /// Der Typ der E-Mail-Vorlage, z. B. <see cref="EmailTemplateType"/> (optional). Beispiele:<br/>
    /// 0 - DocumentReceived: Benachrichtigung über den Empfang eines Dokuments.<br/>
    /// 1 - DocumentSigned: Benachrichtigung über die Unterzeichnung eines Dokuments.<br/>
    /// 2 - DocumentDeleted: Benachrichtigung über das Löschen eines Dokuments.<br/>
    /// 3 - DocumentCompleted: Benachrichtigung über den Abschluss eines Dokuments.<br/>
    /// 4 - DocumentAccessCodeReceived: Benachrichtigung über den Erhalt eines Zugangscodes.<br/>
    /// 5 - DocumentShared: Benachrichtigung über das Teilen eines Dokuments.<br/>
    /// 6 - TotpSecret: Benachrichtigung über ein TOTP-Geheimnis.<br/>
    /// 7 - DocumentRejected_ADM (für den Absender): Mail an den Absender, wenn das Dokument abgelehnt wird.<br/>
    /// 8 - DocumentRejected_REC (für den ablehnenden Empfänger): Mail an den ablehnenden Empfänger, wenn das Dokument abgelehnt wird.<br/>
    /// 9 - DocumentRejected_REC_2 (für sonstige Empfänger): Mail an andere Empfänger (Brief), wenn das Dokument abgelehnt wird.
    /// </summary>
    EmailTemplateType? Type { get; set; }
}