rudder-csharp-sdk/Services/BattlePassService.cs

using System;
using System.Threading;
using System.Threading.Tasks;
using RudderSdk.Core.Models.BattlePass;

namespace RudderSdk.Core;

/// <summary>
/// Battle pass progress and rewards. Battle pass state is tied to a scenario
/// battle pass node, so every call carries the scenario/node ids (and a run id
/// for the mutating calls) — <see cref="BattlePassSession"/> supplies them
/// during scenario runs.
/// </summary>
public sealed class BattlePassService
{
    /// <summary>Free reward track, see <see cref="ClaimRewardAsync(ClaimBattlePassRewardRequest, CancellationToken)"/>.</summary>
    public const string TrackFree = "free";

    /// <summary>Premium reward track, see <see cref="ClaimRewardAsync(ClaimBattlePassRewardRequest, CancellationToken)"/>.</summary>
    public const string TrackPremium = "premium";

    private readonly RudderClient _client;

    internal BattlePassService(RudderClient client) => _client = client;

    /// <summary>Reads current progress: xp, level, premium ownership, claimed tiers.</summary>
    public Task<GetBattlePassProgressResponse> GetProgressAsync(string scenarioId, string nodeId, CancellationToken cancellationToken = default)
        => _client.SendAsync<GetBattlePassProgressRequest, GetBattlePassProgressResponse>(
            "POST",
            "/sdk/v1/battlepass/progress",
            new GetBattlePassProgressRequest { ScenarioId = scenarioId, NodeId = nodeId },
            cancellationToken);

    /// <summary>Credits xp and returns the new xp/level and level-up flags.</summary>
    public Task<AddBattlePassXpResponse> AddXpAsync(AddBattlePassXpRequest request, CancellationToken cancellationToken = default)
        => _client.SendAsync<AddBattlePassXpRequest, AddBattlePassXpResponse>(
            "POST",
            "/sdk/v1/battlepass/xp",
            request,
            cancellationToken);

    /// <summary>
    /// Claims a tier reward at a reached level (idempotent server-side).
    /// <see cref="ClaimBattlePassRewardRequest.Track"/> is <see cref="TrackFree"/> or <see cref="TrackPremium"/>.
    /// </summary>
    public Task<ClaimBattlePassRewardResponse> ClaimRewardAsync(ClaimBattlePassRewardRequest request, CancellationToken cancellationToken = default)
        => _client.SendAsync<ClaimBattlePassRewardRequest, ClaimBattlePassRewardResponse>(
            "POST",
            "/sdk/v1/battlepass/claim",
            request,
            cancellationToken);

    /// <summary>
    /// Purchases the premium track (charges the wallet). When
    /// <see cref="PurchaseBattlePassPremiumRequest.IdempotencyKey"/> is null, a random one is generated.
    /// </summary>
    public Task<PurchaseBattlePassPremiumResponse> PurchasePremiumAsync(PurchaseBattlePassPremiumRequest request, CancellationToken cancellationToken = default)
    {
        request.IdempotencyKey ??= Guid.NewGuid().ToString();
        return _client.SendAsync<PurchaseBattlePassPremiumRequest, PurchaseBattlePassPremiumResponse>(
            "POST",
            "/sdk/v1/battlepass/premium",
            request,
            cancellationToken);
    }
}