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.
This commit is contained in:
Developer 02
2025-04-10 12:45:51 +02:00
parent 396c6014fb
commit 17902c4824
7 changed files with 130 additions and 6 deletions

View File

@@ -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,