using EnvelopeGenerator.Application.Common.Dto.History;
using EnvelopeGenerator.Domain.Constants;
using MediatR;
using System.ComponentModel.DataAnnotations;

namespace EnvelopeGenerator.Application.Histories.Queries;

//TODO: Add sender query
/// <summary>
/// Repräsentiert eine Abfrage für die Verlaufshistorie eines Umschlags.
/// </summary>
public record ReadHistoryQuery : IRequest<IEnumerable<HistoryDto>>
{
    /// <summary>
    /// Die eindeutige Kennung des Umschlags.
    /// </summary>
    [Required]
    public int EnvelopeId { get; init; }

    /// <summary>
    /// Der Include des Umschlags, der abgefragt werden soll. Kann optional angegeben werden, um die Ergebnisse zu filtern.
    /// </summary>
    public EnvelopeStatus? Status { get; init; }

    /// <summary>
    /// Abfrage zur Steuerung, ob nur der aktuelle Include oder der gesamte Datensatz zurückgegeben wird.
    /// </summary>
    public bool? OnlyLast { get; init; } = true;
}