using EnvelopeGenerator.CommonServices;
using EnvelopeGenerator.Domain;

namespace EnvelopeGenerator.Application.Envelopes.Queries.Read;

/// <summary>
/// Repräsentiert die Antwort für das Lesen eines Umschlags.
/// </summary>
/// <param name="Id">Die eindeutige Kennung des Umschlags.</param>
/// <param name="UserId">Die Kennung des Benutzers, der den Umschlag erstellt hat.</param>
/// <param name="Status">Der Status des Umschlags als numerischer Wert.</param>
/// <param name="Uuid">Die universelle eindeutige Kennung (UUID) des Umschlags.</param>
/// <param name="Message">Eine optionale Nachricht, die mit dem Umschlag verknüpft ist.</param>
/// <param name="AddedWhen">Das Datum und die Uhrzeit, wann der Umschlag hinzugefügt wurde.</param>
/// <param name="ChangedWhen">Das Datum und die Uhrzeit, wann der Umschlag zuletzt geändert wurde (falls vorhanden).</param>
/// <param name="Title">Ein optionaler Titel des Umschlags.</param>
/// <param name="Language">Die Sprache, die mit dem Umschlag verknüpft ist.</param>
/// <param name="TFAEnabled">Gibt an, ob die Zwei-Faktor-Authentifizierung (TFA) aktiviert ist.</param>
/// <param name="User">Das Benutzerobjekt, das mit dem Umschlag verknüpft ist.</param>
public record ReadEnvelopeResponse(
    int Id,
    int UserId,
    int Status,
    string Uuid,
    string? Message,
    DateTime AddedWhen,
    DateTime? ChangedWhen,
    string? Title,
    string Language,
    bool TFAEnabled,
    DigitalData.UserManager.Domain.Entities.User User)
{
    /// <summary>
    /// Gibt den Namen des Status zurück, der dem numerischen Statuswert entspricht.
    /// </summary>
    public string StatusName => ((Constants.EnvelopeStatus)Status).ToString();
}