AppStd/EnvelopeGenerator
8
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

refactor: Deutsche Dokumentation für Umschlagbefehlsdatensätze hinzugefügt

Browse Source 
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.
This commit is contained in:
Developer 02 2025-04-10 18:03:38 +02:00
parent b02ab585cb
commit 049827a133
1 changed files with 28 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

68
EnvelopeGenerator.Application/EnvelopeReceivers/Commands/Create/CreateEnvelopeCommand.cs
View File

@ -3,6 +3,30 @@ using System.ComponentModel.DataAnnotations;
namespace EnvelopeGenerator.Application.EnvelopeReceivers.Commands.Create;
/// <summary>
/// Befehl zur Erstellung eines Umschlags.
/// </summary>
/// <param name="Title">Der Titel des Umschlags. Dies ist ein Pflichtfeld.</param>
/// <param name="Message">Die Nachricht, die im Umschlag enthalten sein soll. Dies ist ein Pflichtfeld.</param>
/// <param name="Document">Das mit dem Umschlag verknüpfte Dokument. Dies ist ein Pflichtfeld.</param>
/// <param name="Receivers">Eine Sammlung von Empfängern, die den Umschlag erhalten. Dies ist ein Pflichtfeld.</param>
/// <param name="Language">Die Sprache des Umschlags. Standardmäßig "de-DE", wenn nicht angegeben.</param>
/// <param name="ExpiresWhen">Das Ablaufdatum des Umschlags. Optional.</param>
/// <param name="ExpiresWarningWhen">Das Datum, an dem vor dem Ablauf eine Warnung ausgegeben werden soll. Optional.</param>
/// <param name="ContractType">Der Vertragstyp, der mit dem Umschlag verknüpft ist. Standardmäßig der Typ "Contract".</param>
/// <param name="TFAEnabled">Gibt an, ob die Zwei-Faktor-Authentifizierung für den Umschlag aktiviert ist. Standardmäßig false.</param>
public record CreateEnvelopeCommand(
[Required] string Title,
[Required] string Message,
[Required] DocumentCreateDto Document,
[Required] IEnumerable<ReceiverGetOrCreateDto> Receivers,
string Language = "de-DE",
DateTime? ExpiresWhen = null,
DateTime? ExpiresWarningWhen = null,
int ContractType = (int)Common.Constants.ContractType.Contract,
bool TFAEnabled = false
) : IRequest;
#region DTOs
/// <summary>
/// Signaturposition auf einem Dokument.
@ -31,49 +55,13 @@ public record ReceiverGetOrCreateDto([Required] IEnumerable<Signature> Signature
};
/// <summary>
/// DTO for creating a document.
/// DTO zum Erstellen eines Dokuments.
/// </summary>
/// <param name="DataAsByte">
/// 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.
/// </param>
/// <param name="DataAsBase64">
/// 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.
/// </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,
[Required] DocumentCreateDto Document,
[Required] IEnumerable<ReceiverGetOrCreateDto> Receivers,
string Language = "de-DE",
DateTime? ExpiresWhen = null,
DateTime? ExpiresWarningWhen = null,
int ContractType = (int)Common.Constants.ContractType.Contract,
bool TFAEnabled = false
) : IRequest;
#endregion