using DigitalData.Core.Abstractions;
using Microsoft.AspNetCore.Mvc;

namespace EnvelopeGenerator.Application.DTOs;

/// <summary>
/// Data Transfer Object representing a user receiver with associated details.
/// </summary>
[ApiExplorerSettings(IgnoreApi = true)]
public class UserReceiverDto : IUnique<int>
{
    /// <summary>
    /// Gets or sets the unique identifier of the user receiver.
    /// </summary>
    public int Id { get; set; }

    /// <summary>
    /// Gets or sets the identifier of the user associated with the receiver.
    /// </summary>
    public int UserId { get; set; }

    /// <summary>
    /// Gets or sets the identifier of the receiver.
    /// </summary>
    public int ReceiverId { get; set; }

    /// <summary>
    /// Gets or sets the name of the receiver.
    /// </summary>
    public string Name { get; set; }

    /// <summary>
    /// Gets or sets the company name of the receiver.
    /// </summary>
    public string CompanyName { get; set; }

    /// <summary>
    /// Gets or sets the job title of the receiver.
    /// </summary>
    public string JobTitle { get; set; }

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