using EnvelopeGenerator.Application.Common.Dto;
using EnvelopeGenerator.Application.Common.Dto.Receiver;
using Microsoft.AspNetCore.Mvc;

namespace EnvelopeGenerator.Application.Common.Dto.EnvelopeReceiverReadOnly;

/// <summary>
/// Represents a read-only Data Transfer Object (DTO) for an envelope receiver.
/// Contains information about the receiver, associated envelope, and audit details.
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class EnvelopeReceiverReadOnlyDto
{
    /// <summary>
    /// Gets or inits the unique identifier of the envelope receiver.
    /// </summary>
    public long Id { get; init; }

    /// <summary>
    /// Gets or inits the identifier of the associated envelope.
    /// </summary>
    public long EnvelopeId { get; init; }

    /// <summary>
    /// Gets or inits the email address of the receiver.
    /// </summary>
    public required string ReceiverMail { get; set; }

    /// <summary>
    /// Gets or inits the date until which the receiver is valid.
    /// </summary>
    public DateTime DateValid { get; set; }

    /// <summary>
    /// Gets or inits the date and time when the receiver was added.
    /// </summary>
    public DateTime AddedWhen { get; init; }

    /// <summary>
    /// Gets or inits the user who added the receiver.
    /// Default value is 'unknown'.
    /// </summary>
    public string AddedWho { get; init; } = "Unknown";

    /// <summary>
    /// Gets or inits the associated envelope details.
    /// </summary>
    public EnvelopeDto? Envelope { get; set; }

    /// <summary>
    /// Gets or inits the user who last changed the receiver, if any.
    /// </summary>
    public string? ChangedWho { get; set; }

    /// <summary>
    /// Gets or inits the date and time when the receiver was last changed, if any.
    /// </summary>
    public DateTime? ChangedWhen { get; set; }

    /// <summary>
    /// Gets or inits the associated receiver details.
    /// </summary>
    public ReceiverDto? Receiver { get; set; }
}