Refactor DTOs und Queries für Klarheit und Konsistenz

- Aktualisiert `ReceiverGetOrCreateDto`, um E-Mail in Kleinbuchstaben korrekt zuzuordnen und verbesserte Dokumentation.
- Der Parameter `Receiver` wurde aus der `EnvelopeReceiverQuery` entfernt.
- Verbesserte Kommentare in `ReadEnvelopeReceiverQuery`, um den Zweck zu verdeutlichen.
- Detaillierte Zusammenfassungskommentare zu `ReadEnvelopeReceiverResponse` und `ReadEnvelopeResponse` zum besseren Verständnis der Eigenschaften hinzugefügt.
- Es wurden neue zusammenfassende Kommentare in `ReadReceiverQuery` und `ReadReceiverResponse` eingeführt, um ihre Rollen und Beziehungen zu beschreiben.

EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs

@@ -27,18 +27,45 @@ public record ReceiverGetOrCreateDto([Required] IEnumerable<Signature> Signature
     /// E-Mail-Adresse des Empfängers.
     /// </summary>
     [Required]
-    public required string EmailAddress { get => _emailAddress.ToLower(); init => _emailAddress.ToLower(); }
+    public required string EmailAddress { get => _emailAddress.ToLower(); init => _emailAddress = _emailAddress.ToLower(); }
 };
 
 /// <summary>
-/// DTO für die Erstellung eines Dokuments.
+/// DTO for creating a document.
 /// </summary>
+/// <param name="DataAsByte">
+/// The document data in byte array format. This is used when the document is provided as raw binary data.
+/// </param>
+/// <param name="DataAsBase64">
+/// The document data in Base64 string format. This is used when the document is provided as a Base64-encoded string.
+/// </param>
 public record DocumentCreateDto(byte[]? DataAsByte = null, string? DataAsBase64 = null);
 #endregion
 
 /// <summary>
+/// <summary>
+/// Command to create an envelope.
+/// </summary>
+/// <param name="Title">The title of the envelope. This is a required field.</param>
+/// <param name="Message">The message to be included in the envelope. This is a required field.</param>
+/// <param name="Document">The document associated with the envelope. This is a required field.</param>
+/// <param name="Receivers">A collection of receivers who will receive the envelope. This is a required field.</param>
+/// <param name="Language">The language of the envelope. Defaults to "de-DE" if not specified.</param>
+/// <param name="ExpiresWhen">The expiration date of the envelope. Optional.</param>
+/// <param name="ExpiresWarningWhen">The date when a warning should be issued before expiration. Optional.</param>
+/// <param name="ContractType">The type of contract associated with the envelope. Defaults to the "Contract" type.</param>
+/// <param name="TFAEnabled">Indicates whether two-factor authentication is enabled for the envelope. Defaults to false.</param>
 /// Befehl zur Erstellung eines Umschlags.
 /// </summary>
+/// <param name="Title"></param>
+/// <param name="Message"></param>
+/// <param name="Document"></param>
+/// <param name="Receivers"></param>
+/// <param name="Language"></param>
+/// <param name="ExpiresWhen"></param>
+/// <param name="ExpiresWarningWhen"></param>
+/// <param name="ContractType"></param>
+/// <param name="TFAEnabled"></param>
 public record CreateEnvelopeCommand(
     [Required] string Title,
     [Required] string Message,

EnvelopeGenerator.Application/EnvelopeReceivers/EnvelopeReceiverQuery.cs

@@ -9,7 +9,6 @@ namespace EnvelopeGenerator.Application.EnvelopeReceivers;
 /// <param name="MinStatus"></param>
 /// <param name="MaxStatus"></param>
 /// <param name="IgnoreStatus"></param>
-/// <param name="Receiver"></param>
 public record EnvelopeReceiverQuery(
     int? MinStatus = null,
     int? MaxStatus = null,

EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverQuery.cs

@@ -5,11 +5,24 @@ using MediatR;
 namespace EnvelopeGenerator.Application.EnvelopeReceivers.Queries.Read;
 
 /// <summary>
-/// Stellt eine Abfrage zum Lesen eines Envelope-Empfängers dar.
+/// Repräsentiert eine Abfrage zum Lesen eines Envelope-Empfängers.
 /// </summary>
+/// <remarks>
+/// Diese Abfrage kombiniert Informationen über einen Umschlag (<see cref="ReadEnvelopeQuery"/>) 
+/// und einen Empfänger (<see cref="ReadReceiverQuery"/>), um eine vollständige Antwort 
+/// (<see cref="ReadEnvelopeReceiverResponse"/>) zu generieren. 
+/// Die Antwort enthält Details wie den Status, die Zuordnung zwischen Umschlag und Empfänger 
+/// sowie zusätzliche Metadaten.
+/// </remarks>
 public record ReadEnvelopeReceiverQuery : EnvelopeReceiverQuery, IRequest<ReadEnvelopeReceiverResponse>
 {
+    /// <summary>
+    /// Der Umschlag, der mit dem Empfänger verknüpft ist.
+    /// </summary>
     public ReadEnvelopeQuery? Envelope { get; init; }
 
+    /// <summary>
+    /// Der Empfänger, der mit dem Umschlag verknüpft ist.
+    /// </summary>
     public ReadReceiverQuery? Receiver { get; init; }
-};
+};

EnvelopeGenerator.Application/EnvelopeReceivers/Queries/Read/ReadEnvelopeReceiverResponse.cs

@@ -12,35 +12,80 @@ namespace EnvelopeGenerator.Application.EnvelopeReceivers.Queries.Read;
 /// <param name="Receiver">Der angeforderte Empfänger.</param>
 public record ReadEnvelopeReceiverResponse(int UserId, int Status)
 {
+    /// <summary>
+    /// Repräsentiert die Antwort für das Lesen eines Envelope-Empfängers.
+    /// </summary>
+    /// <remarks>
+    /// Diese Klasse enthält Informationen über einen spezifischen Empfänger eines Umschlags (Envelope).
+    /// Sie verknüpft die Empfängerinformationen mit den zugehörigen Umschlagsdaten und bietet zusätzliche Metadaten.
+    /// </remarks>
+    /// <param name="UserId">Die eindeutige Kennung des Benutzers, der den Empfänger erstellt hat.</param>
+    /// <param name="Status">Der Status des Empfängers als numerischer Wert.</param>
     [NotMapped]
     public (int Envelope, int Receiver) Id => (Envelope: EnvelopeId, Receiver: ReceiverId);
 
+    /// <summary>
+    /// Die eindeutige Kennung des zugehörigen Umschlags.
+    /// </summary>
     [Required]
     public int EnvelopeId { get; init; }
 
+    /// <summary>
+    /// Die eindeutige Kennung des Empfängers.
+    /// </summary>
     [Required]
     public int ReceiverId { get; init; }
 
+    /// <summary>
+    /// Die Reihenfolge des Empfängers innerhalb des Umschlags.
+    /// </summary>
     public int Sequence { get; init; }
 
+    /// <summary>
+    /// Der Name des Empfängers. Kann als Platzhalter verwendet werden.
+    /// </summary>
     [TemplatePlaceholder("[NAME_RECEIVER]")]
     public string? Name { get; init; }
 
+    /// <summary>
+    /// Die Berufsbezeichnung des Empfängers.
+    /// </summary>
     public string? JobTitle { get; init; }
 
+    /// <summary>
+    /// Der Firmenname des Empfängers.
+    /// </summary>
     public string? CompanyName { get; init; }
 
+    /// <summary>
+    /// Eine private Nachricht, die mit dem Empfänger verknüpft ist.
+    /// </summary>
     public string? PrivateMessage { get; init; }
 
+    /// <summary>
+    /// Das Datum und die Uhrzeit, wann der Empfänger hinzugefügt wurde.
+    /// </summary>
     public DateTime AddedWhen { get; init; }
 
+    /// <summary>
+    /// Das Datum und die Uhrzeit, wann der Empfänger zuletzt geändert wurde (falls vorhanden).
+    /// </summary>
     public DateTime? ChangedWhen { get; init; }
 
+    /// <summary>
+    /// Gibt an, ob der Empfänger eine Telefonnummer hat.
+    /// </summary>
     public bool HasPhoneNumber { get; init; }
 
+    /// <summary>
+    /// Die zugehörigen Umschlagsdaten.
+    /// </summary>
     [Required]
     public required ReadEnvelopeResponse Envelope { get; init; }
 
+    /// <summary>
+    /// Die Liste der Empfängerinformationen.
+    /// </summary>
     [Required]
     public IEnumerable<ReadReceiverResponse> Receiver { get; init; } = new List<ReadReceiverResponse>();
 }

EnvelopeGenerator.Application/Envelopes/Queries/Read/ReadEnvelopeResponse.cs

@@ -2,7 +2,35 @@
 
 namespace EnvelopeGenerator.Application.Envelopes.Queries.Read;
 
-public record ReadEnvelopeResponse(int Id, int UserId, int Status, string Uuid, string? Message, DateTime AddedWhen, DateTime? ChangedWhen, string? Title, string Language, bool TFAEnabled, DigitalData.UserManager.Domain.Entities.User User)
+/// <summary>
+/// Repräsentiert die Antwort für das Lesen eines Umschlags.
+/// </summary>
+/// <param name="Id">Die eindeutige Kennung des Umschlags.</param>
+/// <param name="UserId">Die Kennung des Benutzers, der den Umschlag erstellt hat.</param>
+/// <param name="Status">Der Status des Umschlags als numerischer Wert.</param>
+/// <param name="Uuid">Die universelle eindeutige Kennung (UUID) des Umschlags.</param>
+/// <param name="Message">Eine optionale Nachricht, die mit dem Umschlag verknüpft ist.</param>
+/// <param name="AddedWhen">Das Datum und die Uhrzeit, wann der Umschlag hinzugefügt wurde.</param>
+/// <param name="ChangedWhen">Das Datum und die Uhrzeit, wann der Umschlag zuletzt geändert wurde (falls vorhanden).</param>
+/// <param name="Title">Ein optionaler Titel des Umschlags.</param>
+/// <param name="Language">Die Sprache, die mit dem Umschlag verknüpft ist.</param>
+/// <param name="TFAEnabled">Gibt an, ob die Zwei-Faktor-Authentifizierung (TFA) aktiviert ist.</param>
+/// <param name="User">Das Benutzerobjekt, das mit dem Umschlag verknüpft ist.</param>
+public record ReadEnvelopeResponse(
+    int Id,
+    int UserId,
+    int Status,
+    string Uuid,
+    string? Message,
+    DateTime AddedWhen,
+    DateTime? ChangedWhen,
+    string? Title,
+    string Language,
+    bool TFAEnabled,
+    DigitalData.UserManager.Domain.Entities.User User)
 {
+    /// <summary>
+    /// Gibt den Namen des Status zurück, der dem numerischen Statuswert entspricht.
+    /// </summary>
     public string StatusName => ((Constants.EnvelopeStatus)Status).ToString();
 }

EnvelopeGenerator.Application/Receivers/Queries/Read/ReadReceiverQuery.cs

@@ -1,5 +1,10 @@
 namespace EnvelopeGenerator.Application.Receivers.Queries.Read;
 
+/// <summary>
+/// Stellt eine Abfrage dar, um die Details eines Empfängers zu lesen.
+/// Diese Abfrage erbt von <see cref="ReceiverQuery"/> und wird verwendet, 
+/// um spezifische Informationen über einen Empfänger abzurufen.
+/// </summary>
 public record ReadReceiverQuery : ReceiverQuery
 {
 }

EnvelopeGenerator.Application/Receivers/Queries/Read/ReadReceiverResponse.cs

@@ -1,5 +1,12 @@
 namespace EnvelopeGenerator.Application.Receivers.Queries.Read;
 
+/// <summary>
+/// Repräsentiert die Antwort auf eine Abfrage, um einen Empfänger zu lesen.
+/// </summary>
+/// <param name="Id">Die eindeutige Identifikationsnummer des Empfängers.</param>
+/// <param name="EmailAddress">Die E-Mail-Adresse des Empfängers.</param>
+/// <param name="AddedWhen">Das Datum und die Uhrzeit, wann der Empfänger hinzugefügt wurde.</param>
+/// <param name="Signature">Die Signatur des Empfängers.</param>
 public record ReadReceiverResponse(int Id, string EmailAddress, DateTime AddedWhen, string Signature)
 {
 }