QRBee/QRBeeApi/Services/Database/IStorage.cs

namespace QRBee.Api.Services.Database
{
    /// <summary>
    /// Database interface
    /// </summary>
    public interface IStorage
    {
        /// <summary>
        /// Insert userInfo into database
        /// </summary>
        /// <param name="info"> Information to be inserted</param>
        Task<string> PutUserInfo(UserInfo info);

        /// <summary>
        /// Retrieve user information from database
        /// </summary>
        /// <param name="email">Identifier by which user information will be retrieved</param>
        /// <returns>User information</returns>
        Task<UserInfo> GetUserInfo(string email);

        /// <summary>
        /// Update user record
        /// </summary>
        /// <param name="info">New user record</param>
        /// <returns></returns>
        Task UpdateUser(UserInfo info);

        /// <summary>
        /// Insert transactionInfo into database
        /// </summary>
        /// <param name="info">Information to be inserted</param>
        Task PutTransactionInfo(TransactionInfo info);

        /// <summary>
        /// Try to find if the Transaction already exists in the database
        /// </summary>
        /// <param name="id">parameter by which to find TransactionInfo</param>
        /// <returns>null if transaction doesn't exist or TransactionInfo</returns>
        Task<TransactionInfo?> TryGetTransactionInfoByTransactionId(string id);
        /// <summary>
        /// Retrieve transaction information from database
        /// </summary>
        /// <param name="id">Identifier by which transaction information will be retrieved</param>
        /// <returns>Transaction information</returns>
        Task<TransactionInfo> GetTransactionInfoByTransactionId(string id);

        Task<List<TransactionInfo>> GetTransactionsByStatus(TransactionInfo.TransactionStatus status);

        /// <summary>
        /// Update transaction after execution
        /// </summary>
        /// <param name="info">Transaction to be updated</param>
        Task UpdateTransaction(TransactionInfo info);

        /// <summary>
        /// Inserts CertificateInfo into database
        /// </summary>
        /// <param name="info">Information to be inserted</param>
        /// <returns></returns>
        Task InsertCertificate(CertificateInfo info);

        /// <summary>
        /// Retrieve certificate information from database
        /// </summary>
        /// <param name="id">Identifier by which certificate information will be retrieved</param>
        /// <returns>Certificate information</returns>
        Task<CertificateInfo> GetCertificateInfoByCertificateId(string id);

        /// <summary>
        /// Retrieve certificate information from database
        /// </summary>
        /// <param name="clientId">Identifier by which certificate information will be retrieved</param>
        /// <returns>Certificate information</returns>
        Task<CertificateInfo> GetCertificateInfoByUserId(string clientId);

        
    }
}