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

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

Overview

Builds and executes requests for operations under #leaderboards#teams#identifier#rank

Defined Under Namespace

Classes: RankRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new RankRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



27
28
29
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 27

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/leaderboards/teams/{identifier}/rank{?gameSlug*,sortBy*}")
end

Instance Method Details

#get(request_configuration = nil) ⇒ Object

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.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a Fiber of leaderboard_rank_response



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 35

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["400"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["401"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["403"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["404"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["429"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    error_mapping["500"] = lambda {|pn| TeamBattlesSdk::Generated::Models::Error.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Models::LeaderboardRankResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

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.

Parameters:

  • request_configuration (defaults to: nil) —

    Configuration for the request such as headers, query parameters, and middleware options.

Returns:

  • a request_information



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 53

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.set_query_string_parameters_from_raw_object(request_configuration.query_parameters)
        request_info.add_request_options(request_configuration.options)
    end
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.try_add('Accept', 'application/json')
    return request_info
end

#with_url(raw_url) ⇒ Object

Returns a request builder with the provided arbitrary URL. Using this method means any other path or query parameters are ignored.

Parameters:

  • raw_url —

    The raw URL to use for the request builder.

Returns:

  • a rank_request_builder

Raises:

  • (StandardError) 


71
72
73
74
 
# File 'lib/teambattles_sdk/generated/leaderboards/teams/item/rank/rank_request_builder.rb', line 71

def with_url(raw_url)
    raise StandardError, 'raw_url cannot be null' if raw_url.nil?
    return RankRequestBuilder.new(raw_url, @request_adapter)
end