using Microsoft.AspNetCore.Mvc;

namespace EnvelopeGenerator.Application.Dto.EnvelopeHistory;

/// <summary>
/// Data Transfer Object for creating a new envelope history record.
/// </summary>
public class EnvelopeHistoryCreateDto
{
    /// <summary>
    /// Gets or sets the identifier of the envelope.
    /// </summary>
    public int EnvelopeId { get; set; }

    /// <summary>
    /// Gets or sets the user reference associated with the action.
    /// </summary>
    public required string UserReference { get; set; }

    /// <summary>
    /// Gets or sets the status of the envelope at the time of the action.
    /// </summary>
    public int Status { get; set; }

    /// <summary>
    /// Gets or sets the date and time when the action occurred.
    /// </summary>
    public DateTime? ActionDate { get; set; }

    /// <summary>
    /// Gets or sets an optional comment related to the action.
    /// </summary>
    public string? Comment { get; set; }
}