using Microsoft.AspNetCore.Mvc;

namespace EnvelopeGenerator.Application.Dto;

/// <summary>
/// Data Transfer Object representing a document within an envelope, including optional binary data and form elements.
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class EnvelopeDocumentDto
{
    /// <summary>
    /// Gets or sets the unique identifier of the document.
    /// </summary>
    public int Id { get; set; }

    /// <summary>
    /// Gets or sets the envelope ID to which the document belongs.
    /// </summary>
    public int EnvelopeId { get; set; }

    /// <summary>
    /// Gets or sets the date and time when the document was added.
    /// </summary>
    public DateTime AddedWhen { get; set; }

    /// <summary>
    /// Gets or sets the binary data of the document, if available.
    /// </summary>
    public byte[]? ByteData { get; set; }

    /// <summary>
    /// Gets or sets the collection of elements associated with the document for receiver interactions, if any.
    /// </summary>
    public IEnumerable<DocumentReceiverElementDto>? Elements { get; set; }
}