59 lines
2.7 KiB
C#

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using gehGassiApp.Domain.Vouchers;
namespace gehGassiApp.Core.Interfaces
{
/// <summary>
/// Schnittstellenbeschreibung für einen Service der die Gutscheine verwalten kann
/// </summary>
public interface IVoucherService
{
/// <summary>
/// Validieren eines Gutschein-Codes für einen AppUser
/// </summary>
/// <param name="voucherCode">Gutscheincode</param>
/// <param name="appUserId">Id des AppUsers</param>
/// <param name="accessToken">Aktuelles Accesstoken</param>
/// <param name="token">CancellationToken</param>
/// <returns>CommunicationResult</returns>
Task<CommunicationResult<CheckVoucherCodeResult>> CheckVoucherCodeAsync(string voucherCode, string appUserId, string accessToken, CancellationToken token);
/// <summary>
/// Versucht einen Gutscheincode mit Hilfe eines QR-Codes zu holen
/// </summary>
/// <param name="qrCode">QR-Code in Text</param>
/// <param name="accessToken">Aktuelles Accesstoken</param>
/// <param name="token">CancellationToken</param>
/// <returns>CommunicationResult</returns>
Task<CommunicationResult<string>> GetVoucherCodeByQrCode(string qrCode, string accessToken, CancellationToken token);
/// <summary>
/// Versucht einen Gutschein zu reservieren
/// </summary>
/// <param name="voucherId">Id des Gutscheins</param>
/// <param name="code">Code des Gutscheins</param>
/// <param name="appUserId">Id des AppUsers</param>
/// <param name="walkId">Id des Walks</param>
/// <param name="ammount">Betrag - kann kleiner Gutscheinwert sein</param>
/// <param name="accessToken">Aktuelles Accesstoken</param>
/// <param name="token">CancellationToken</param>
/// <returns>CommunicationResult</returns>
Task<CommunicationResult<ReserveVoucherResult>> ReserveVoucherAsync(string voucherId, string code, string appUserId, string walkId, decimal ammount, string accessToken, CancellationToken token);
/// <summary>
/// Stornieren eines Gutscheins
/// </summary>
/// <param name="voucherId">Id des Gutscheins</param>
/// <param name="appUserId">Id des AppUsers</param>
/// <param name="walkId">Id des Walks</param>
/// <param name="accessToken">Aktuelles Accesstoken</param>
/// <param name="token">CancellationToken</param>
/// <returns>CommunicationResult</returns>
Task<CommunicationResult<bool>> CancelVoucherAsync(string voucherId, string appUserId, string walkId, string accessToken, CancellationToken token);
}
}