using EnvelopeGenerator.Common;
using MediatR;
using System.ComponentModel.DataAnnotations;

namespace EnvelopeGenerator.Application.Histories.Queries.Read;

//TODO: Add sender query
/// <summary>
/// Repräsentiert eine Abfrage für die Verlaufshistorie eines Umschlags.
/// </summary>
/// <param name="EnvelopeId">Die eindeutige Kennung des Umschlags.</param>
/// <param name="Status">Der Status des Umschlags, der abgefragt werden soll. Kann optional angegeben werden, um die Ergebnisse zu filtern.</param>
/// <param name="OnlyLast">Abfrage zur Steuerung, ob nur der aktuelle Status oder der gesamte Datensatz zurückgegeben wird.</param>
public record ReadHistoryQuery(
    [Required]
    int EnvelopeId,
    Constants.EnvelopeStatus? Status = null,
    bool? OnlyLast = true) : IRequest<IEnumerable<ReadHistoryResponse>>
{
};