using EnvelopeGenerator.Domain.Constants;
using Microsoft.AspNetCore.Mvc;

namespace EnvelopeGenerator.Application.Common.Dto;

/// <summary>
/// Data Transfer Object representing the status of a document for a specific receiver.
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class DocumentStatusDto
{
    /// <summary>
    /// Gets or sets the unique identifier of the document status entry.
    /// </summary>
    public int Id { get; set; }

    /// <summary>
    /// Gets or sets the ID of the associated envelope.
    /// </summary>
    public int EnvelopeId { get; set; }

    /// <summary>
    /// Gets or sets the ID of the receiver associated with this status.
    /// </summary>
    public int ReceiverId { get; set; }

    /// <summary>
    /// Gets or sets the current status code.
    /// </summary>
    public EnvelopeStatus Status { get; set; }

    /// <summary>
    /// Gets or sets the timestamp when the status was changed.
    /// </summary>
    public DateTime? StatusChangedWhen { get; set; }

    /// <summary>
    /// Gets or sets the timestamp when this record was added.
    /// </summary>
    public DateTime AddedWhen { get; set; }

    /// <summary>
    /// Gets or sets the timestamp when this record was last changed.
    /// </summary>
    public DateTime? ChangedWhen { get; set; }

    /// <summary>
    /// Gets or sets the display value associated with the status.
    /// </summary>
    public string? Value { get; set; }
}