Class: TeamBattlesSdk::Generated::Leaderboards::Teams::Item::Rank::RankRequestBuilder::RankRequestBuilderGetQueryParameters

Inherits:
Object
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb

Overview

Resolves a single team by slug or ID and returns its 1-indexed rank on the public team leaderboard. ‘sortBy` selects the ranking field: wins (default), winRate, or experience. Pass `gameSlug` to rank within one game’s leaderboard; omit it for the global (all-games) board. An unknown ‘gameSlug` returns 404. `rank` is null when the team is excluded from the leaderboard (private or disabled) and also when the team ranks beyond the internal scan window, since the rank is a bounded best-effort computation rather than a full-table sort. A missing or inactive team returns 404; an active but excluded team returns 200 with rank null. Requires teams.profile:read.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#game_slug ⇒ Object

Returns the value of attribute game_slug.



80
81
82
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 80

def game_slug
  @game_slug
end

#sort_by ⇒ Object

Returns the value of attribute sort_by.



81
82
83
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 81

def sort_by
  @sort_by
end

Instance Method Details

#get_query_parameter(original_name) ⇒ Object

Maps the query parameters names to their encoded names for the URI template parsing.

Parameters:

  • original_name —

    The original query parameter name in the class.

Returns:

  • a string

Raises:

  • (StandardError) 


87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 87

def get_query_parameter(original_name)
    raise StandardError, 'original_name cannot be null' if original_name.nil?
    case original_name
        when "game_slug"
            return "gameSlug"
        when "sort_by"
            return "sortBy"
        else
            return original_name
    end
end