049827a133
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.
67 lines
3.2 KiB
C#
67 lines
3.2 KiB
C#
using MediatR;
|
|
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.
|
|
/// </summary>
|
|
/// <param name="X">X-Position</param>
|
|
/// <param name="Y">Y-Position</param>
|
|
/// <param name="Page">Seite, auf der sie sich befindet</param>
|
|
public record Signature([Required] int X, [Required] int Y, [Required] int Page);
|
|
|
|
/// <summary>
|
|
/// DTO für Empfänger, die erstellt oder abgerufen werden sollen.
|
|
/// Wenn nicht, wird sie erstellt und mit einer Signatur versehen.
|
|
/// </summary>
|
|
/// <param name="Signatures">Unterschriften auf Dokumenten.</param>
|
|
/// <param name="Name">Der Name, mit dem der Käufer angesprochen werden soll. Bei Null oder keinem Wert wird der zuletzt verwendete Name verwendet.</param>
|
|
/// <param name="PhoneNumber">Sollte mit Vorwahl geschrieben werden</param>
|
|
public record ReceiverGetOrCreateDto([Required] IEnumerable<Signature> Signatures, string? Name = null, string? PhoneNumber = null)
|
|
{
|
|
private string _emailAddress = string.Empty;
|
|
|
|
/// <summary>
|
|
/// E-Mail-Adresse des Empfängers.
|
|
/// </summary>
|
|
[Required]
|
|
public required string EmailAddress { get => _emailAddress.ToLower(); init => _emailAddress = _emailAddress.ToLower(); }
|
|
};
|
|
|
|
/// <summary>
|
|
/// DTO zum Erstellen eines Dokuments.
|
|
/// </summary>
|
|
/// <param name="DataAsByte">
|
|
/// Die Dokumentdaten im Byte-Array-Format. Wird verwendet, wenn das Dokument als Roh-Binärdaten bereitgestellt wird.
|
|
/// </param>
|
|
/// <param name="DataAsBase64">
|
|
/// 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 |