EnvelopeGenerator/EnvelopeGenerator.Application/Common/Interfaces/Services/IEnvelopeReceiverService.cs

using CommandDotNet;
using DigitalData.Core.Abstraction.Application;
using DigitalData.Core.Abstraction.Application.DTO;
using EnvelopeGenerator.Application.Common.Dto.EnvelopeReceiver;
using EnvelopeGenerator.Application.Common.Dto.Messaging;
using EnvelopeGenerator.Application.Envelopes;
using EnvelopeGenerator.Application.Envelopes.Queries;
using EnvelopeGenerator.Application.Receivers.Queries;
using EnvelopeGenerator.Domain;
using EnvelopeGenerator.Domain.Constants;
using EnvelopeGenerator.Domain.Entities;

namespace EnvelopeGenerator.Application.Common.Interfaces.Services;

/// <summary>
/// 
/// </summary>
[Obsolete("Use MediatR")]
public interface IEnvelopeReceiverService : IBasicCRUDService<EnvelopeReceiverDto, EnvelopeReceiver, (int Envelope, int Receiver)>
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <param name="readOnly"></param>
    /// <returns></returns>

    Task<DataResult<IEnumerable<EnvelopeReceiverDto>>> ReadByUuidAsync(string uuid, bool withEnvelope = true, bool withReceiver = false, bool readOnly = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <returns></returns>
    Task<DataResult<IEnumerable<string?>>> ReadAccessCodeByUuidAsync(string uuid, bool withEnvelope = false, bool withReceiver = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="signature"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <param name="readOnly"></param>
    /// <returns></returns>
    Task<DataResult<IEnumerable<EnvelopeReceiverDto>>> ReadBySignatureAsync(string signature, bool withEnvelope = false, bool withReceiver = true, bool readOnly = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <param name="signature"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <param name="readOnly"></param>
    /// <returns></returns>
    Task<DataResult<EnvelopeReceiverDto>> ReadByUuidSignatureAsync(string uuid, string signature, bool withEnvelope = true, bool withReceiver = true, bool readOnly = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <param name="signature"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <param name="readOnly"></param>
    /// <returns></returns>
    Task<DataResult<EnvelopeReceiverSecretDto>> ReadWithSecretByUuidSignatureAsync(string uuid, string signature, bool withEnvelope = true, bool withReceiver = true, bool readOnly = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeReceiverId"></param>
    /// <param name="withEnvelope"></param>
    /// <param name="withReceiver"></param>
    /// <param name="readOnly"></param>
    /// <returns></returns>
    Task<DataResult<EnvelopeReceiverDto>> ReadByEnvelopeReceiverIdAsync(string envelopeReceiverId, bool withEnvelope = true, bool withReceiver = true, bool readOnly = true);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="receiverId"></param>
    /// <returns></returns>
    Task<DataResult<string>> ReadAccessCodeByIdAsync(int envelopeId, int receiverId);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <param name="signature"></param>
    /// <param name="accessCode"></param>
    /// <returns></returns>
    Task<DataResult<bool>> VerifyAccessCodeAsync(string uuid, string signature, string accessCode);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeReceiverId"></param>
    /// <param name="accessCode"></param>
    /// <returns></returns>
    [Command("verify-access-code-async-by-id")]
    Task<DataResult<bool>> VerifyAccessCodeAsync(string envelopeReceiverId, string accessCode);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeReceiverId"></param>
    /// <returns></returns>
    Task<DataResult<bool>> IsExisting(string envelopeReceiverId);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="username"></param>
    /// <param name="min_status"></param>
    /// <param name="max_status"></param>
    /// <param name="envelopeQuery"></param>
    /// <param name="receiverQuery"></param>
    /// <param name="ignore_statuses"></param>
    /// <returns></returns>
    Task<DataResult<IEnumerable<EnvelopeReceiverDto>>> ReadByUsernameAsync(string username, EnvelopeStatus? min_status = null, EnvelopeStatus? max_status = null, ReadEnvelopeQuery? envelopeQuery = null, ReadReceiverQuery? receiverQuery = null, params EnvelopeStatus[] ignore_statuses);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="mail"></param>
    /// <param name="id"></param>
    /// <param name="signature"></param>
    /// <returns></returns>
    Task<DataResult<string>> ReadLastUsedReceiverNameByMailAsync(string? mail = null, int? id = null, string? signature = null);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeReceiverId"></param>
    /// <param name="message"></param>
    /// <returns></returns>
    Task<DataResult<SmsResponse>> SendSmsAsync(string envelopeReceiverId, string message);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="uuid"></param>
    /// <returns></returns>
    Task<DataResult<IEnumerable<EnvelopeReceiverSecretDto>>> ReadWithSecretByUuidAsync(string uuid);
}