Loyalty Operations
Interface defining loyalty-related operations for user engagement, rankings, and leaderboards.
Configuration
-
Get Config
suspend fun getConfig(): LoyaltyConfig?
Retrieves loyalty system configuration.
-
Get Client Badges
suspend fun getClientBadges(): BadgesModel?
Fetches available badges for the client.
Templates
-
Get Templates
suspend fun getTemplates(filters: TemplateFilters?): SimpleResponse<List<LeaderboardTemplate>>?
Retrieves templates filtered by status, type, and date ranges.
-
Get Template By ID
suspend fun getTemplateById(templateId: String): SimpleResponse<List<LeaderboardTemplate>>?
Fetches specific template details.
Leaderboards
-
Get Template Leaderboard
suspend fun getLeaderboard(templateId: String, filters: LeaderboardFilters?): PagedResponse<List<LeaderboardModel>>?
Returns leaderboard for a specific template.
-
Get Game Leaderboard
suspend fun getLeaderboardForGame(gameId: String, limit: Int?, page: Int?): PagedResponse<List<LeaderboardModel>>?
Retrieves game-specific leaderboard with pagination.
User Rankings
-
Get Own Rankings
suspend fun getOwnRankings(filters: UserRankingFilters?): PagedResponse<List<ProfileRank>>?
Fetches authenticated user's rankings.
-
Get User Rankings
suspend fun getUserRankings(userId: String, filters: UserRankingFilters?): PagedResponse<List<ProfileRank>>?
Retrieves rankings for specific user.
Success Rates
- Get Highest Success Rate
Returns top 100 users with highest prediction success rates.
suspend fun getHighestSuccessRate(filters: HighestSuccessRateFilters?): SimpleResponse<List<LeaderboardHighestSuccessRate>>?
Updated 24 days ago