using DigitalData.Core.Abstraction.Application;
using DigitalData.Core.Abstraction.Application.DTO;
using EnvelopeGenerator.Application.Common.Dto.History;
using EnvelopeGenerator.Application.Common.Dto.Receiver;
using EnvelopeGenerator.Domain.Constants;
using EnvelopeGenerator.Domain.Entities;

namespace EnvelopeGenerator.Application.Common.Interfaces.Services;

/// <summary>
/// 
/// </summary>
[Obsolete("Use MediatR")]
public interface IEnvelopeHistoryService : ICRUDService<HistoryCreateDto, HistoryDto, History, long>
{
    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <param name="status"></param>
    /// <returns></returns>
    Task<int> CountAsync(int? envelopeId = null, string? userReference = null, EnvelopeStatus? status = null);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <returns></returns>
    Task<bool> AccessCodeAlreadyRequested(int envelopeId, string userReference);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <returns></returns>
    Task<bool> IsSigned(int envelopeId, string userReference);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <returns></returns>
    Task<bool> IsRejected(int envelopeId, string? userReference = null);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <param name="referenceType"></param>
    /// <param name="status"></param>
    /// <param name="withSender"></param>
    /// <param name="withReceiver"></param>
    /// <returns></returns>
    Task<IEnumerable<HistoryDto>> ReadAsync(int? envelopeId = null, string? userReference = null, ReferenceType? referenceType = null, EnvelopeStatus? status = null, bool withSender = false, bool withReceiver = false);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <returns></returns>
    Task<IEnumerable<HistoryDto>> ReadRejectedAsync(int envelopeId, string? userReference = null);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <returns></returns>
    Task<IEnumerable<ReceiverDto>> ReadRejectingReceivers(int envelopeId);

    /// <summary>
    /// 
    /// </summary>
    /// <param name="envelopeId"></param>
    /// <param name="userReference"></param>
    /// <param name="status"></param>
    /// <param name="comment"></param>
    /// <returns></returns>
    Task<DataResult<long>> RecordAsync(int envelopeId, string userReference, EnvelopeStatus status, string? comment = null);
}