using AyCode.Core.Serializers.Attributes;
using AyCode.Core.Serializers.Toons;

namespace Nop.Core.Domain.Orders;

/// <summary>
/// Represents an order note
/// </summary>
[AcBinarySerializable(false, true, false, true, false)]
[ToonDescription("NopCommerce order note entity")]
public partial class OrderNote : BaseEntity
{
    /// <summary>
    /// Gets or sets the order identifier
    /// </summary>
    [ToonDescription($"Foreign key to parent {nameof(Order)}", ForeignKey = nameof(Order))]
    public int OrderId { get; set; }

    /// <summary>
    /// Gets or sets the note
    /// </summary>
    public string Note { get; set; }

    /// <summary>
    /// Gets or sets the attached file (download) identifier
    /// </summary>
    public int DownloadId { get; set; }

    /// <summary>
    /// Gets or sets a value indicating whether a customer can see a note
    /// </summary>
    public bool DisplayToCustomer { get; set; }

    /// <summary>
    /// Gets or sets the date and time of order note creation
    /// </summary>
    public DateTime CreatedOnUtc { get; set; }
}