From 049827a1332602dee99c9f9af1b0581903330eaa Mon Sep 17 00:00:00 2001 From: Developer 02 Date: Thu, 10 Apr 2025 18:03:38 +0200 Subject: [PATCH] =?UTF-8?q?refactor:=20Deutsche=20Dokumentation=20f=C3=BCr?= =?UTF-8?q?=20Umschlagbefehlsdatens=C3=A4tze=20hinzugef=C3=BCgt?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit XML-Dokumentationskommentare für `CreateEnvelopeCommand`, `ReceiverGetOrCreateDto` und `DocumentCreateDto` auf Deutsch aktualisiert. Die bestehende englische Dokumentation wurde entfernt, um eine einheitliche Sprache in der Codebasis zu gewährleisten. --- .../Commands/Create/CreateEnvelopeCommand.cs | 68 ++++++++----------- 1 file changed, 28 insertions(+), 40 deletions(-) diff --git a/EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs b/EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs index 5f726bca..12efa25b 100644 --- a/EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs +++ b/EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs @@ -3,6 +3,30 @@ using System.ComponentModel.DataAnnotations; namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands.Create; +/// +/// Befehl zur Erstellung eines Umschlags. +/// +/// Der Titel des Umschlags. Dies ist ein Pflichtfeld. +/// Die Nachricht, die im Umschlag enthalten sein soll. Dies ist ein Pflichtfeld. +/// Das mit dem Umschlag verknüpfte Dokument. Dies ist ein Pflichtfeld. +/// Eine Sammlung von Empfängern, die den Umschlag erhalten. Dies ist ein Pflichtfeld. +/// Die Sprache des Umschlags. Standardmäßig "de-DE", wenn nicht angegeben. +/// Das Ablaufdatum des Umschlags. Optional. +/// Das Datum, an dem vor dem Ablauf eine Warnung ausgegeben werden soll. Optional. +/// Der Vertragstyp, der mit dem Umschlag verknüpft ist. Standardmäßig der Typ "Contract". +/// Gibt an, ob die Zwei-Faktor-Authentifizierung für den Umschlag aktiviert ist. Standardmäßig false. +public record CreateEnvelopeCommand( + [Required] string Title, + [Required] string Message, + [Required] DocumentCreateDto Document, + [Required] IEnumerable Receivers, + string Language = "de-DE", + DateTime? ExpiresWhen = null, + DateTime? ExpiresWarningWhen = null, + int ContractType = (int)Common.Constants.ContractType.Contract, + bool TFAEnabled = false + ) : IRequest; + #region DTOs /// /// Signaturposition auf einem Dokument. @@ -31,49 +55,13 @@ public record ReceiverGetOrCreateDto([Required] IEnumerable Signature }; /// -/// DTO for creating a document. +/// DTO zum Erstellen eines Dokuments. /// /// -/// The document data in byte array format. This is used when the document is provided as raw binary data. +/// Die Dokumentdaten im Byte-Array-Format. Wird verwendet, wenn das Dokument als Roh-Binärdaten bereitgestellt wird. /// /// -/// The document data in Base64 string format. This is used when the document is provided as a Base64-encoded string. +/// Die Dokumentdaten im Base64-String-Format. Wird verwendet, wenn das Dokument als Base64-codierter String bereitgestellt wird. /// public record DocumentCreateDto(byte[]? DataAsByte = null, string? DataAsBase64 = null); -#endregion - -/// -/// -/// Command to create an envelope. -/// -/// The title of the envelope. This is a required field. -/// The message to be included in the envelope. This is a required field. -/// The document associated with the envelope. This is a required field. -/// A collection of receivers who will receive the envelope. This is a required field. -/// The language of the envelope. Defaults to "de-DE" if not specified. -/// The expiration date of the envelope. Optional. -/// The date when a warning should be issued before expiration. Optional. -/// The type of contract associated with the envelope. Defaults to the "Contract" type. -/// Indicates whether two-factor authentication is enabled for the envelope. Defaults to false. -/// Befehl zur Erstellung eines Umschlags. -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -public record CreateEnvelopeCommand( - [Required] string Title, - [Required] string Message, - [Required] DocumentCreateDto Document, - [Required] IEnumerable Receivers, - string Language = "de-DE", - DateTime? ExpiresWhen = null, - DateTime? ExpiresWarningWhen = null, - int ContractType = (int)Common.Constants.ContractType.Contract, - bool TFAEnabled = false - ) : IRequest; \ No newline at end of file +#endregion \ No newline at end of file