refactor(EnvelopeGenerator.Application.DTOs): Umbenennen in EnvelopeGenerator.Application.Dto

EnvelopeGenerator.Application/Dto/EnvelopeHistory/EnvelopeHistoryCreateDto.cs

@@ -0,0 +1,34 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace EnvelopeGenerator.Application.Dto.EnvelopeHistory;
+
+/// <summary>
+/// Data Transfer Object for creating a new envelope history record.
+/// </summary>
+public class EnvelopeHistoryCreateDto
+{
+    /// <summary>
+    /// Gets or sets the identifier of the envelope.
+    /// </summary>
+    public int EnvelopeId { get; set; }
+
+    /// <summary>
+    /// Gets or sets the user reference associated with the action.
+    /// </summary>
+    public required string UserReference { get; set; }
+
+    /// <summary>
+    /// Gets or sets the status of the envelope at the time of the action.
+    /// </summary>
+    public int Status { get; set; }
+
+    /// <summary>
+    /// Gets or sets the date and time when the action occurred.
+    /// </summary>
+    public DateTime? ActionDate { get; set; }
+
+    /// <summary>
+    /// Gets or sets an optional comment related to the action.
+    /// </summary>
+    public string? Comment { get; set; }
+}

EnvelopeGenerator.Application/Dto/EnvelopeHistory/EnvelopeHistoryDto.cs

@@ -0,0 +1,69 @@
+using DigitalData.UserManager.Application.DTOs.User;
+using EnvelopeGenerator.Application.Dto.Receiver;
+using static EnvelopeGenerator.Domain.Constants;
+
+namespace EnvelopeGenerator.Application.Dto.EnvelopeHistory;
+
+/// <summary>
+/// Data Transfer Object representing the history of an envelope, including status, sender, receiver, and related metadata.
+/// </summary>
+public record EnvelopeHistoryDto
+{
+    /// <summary>
+    /// Unique identifier for the envelope history entry.
+    /// </summary>
+    public long Id { get; set; }
+
+    /// <summary>
+    /// Identifier of the associated envelope.
+    /// </summary>
+    public int EnvelopeId { get; set; }
+
+    /// <summary>
+    /// Reference string for the user related to this history entry.
+    /// </summary>
+    public required string UserReference { get; set; }
+
+    /// <summary>
+    /// Status code of the envelope at this history point.
+    /// </summary>
+    public int Status { get; set; }
+
+    /// <summary>
+    /// Human-readable name of the status.
+    /// </summary>
+    public string? StatusName { get; set; }
+
+    /// <summary>
+    /// Date and time when this history entry was added.
+    /// </summary>
+    public DateTime AddedWhen { get; set; }
+
+    /// <summary>
+    /// Date and time when an action was performed, if applicable.
+    /// </summary>
+    public DateTime? ActionDate { get; set; }
+
+    /// <summary>
+    /// Information about the sender associated with this history entry.
+    /// </summary>
+    public UserCreateDto? Sender { get; set; }
+
+    /// <summary>
+    /// Information about the receiver associated with this history entry.
+    /// </summary>
+    public ReceiverReadDto? Receiver { get; set; }
+
+    /// <summary>
+    /// Type of reference for this history entry.
+    /// </summary>
+    public ReferenceType ReferenceType { get; set; }
+
+    /// <summary>
+    /// Optional comment related to this history entry.
+    /// </summary>
+    public string? Comment { get; set; }
+
+    /// <inheritdoc/>
+    public override int GetHashCode() => Id.GetHashCode();
+};