Class: TeamBattlesSdk::Generated::Game::Matches::Item::WithMatchItemRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb

Overview

Builds and executes requests for operations under #game#matches#matchId

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new WithMatchItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters

    Path parameters for the request

  • request_adapter

    The request adapter to use to execute the requests.



54
55
56
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 54

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/game/matches/{matchId}")
end

Instance Method Details

#forfeitObject

The forfeit property



25
26
27
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 25

def forfeit()
    return TeamBattlesSdk::Generated::Game::Matches::Item::Forfeit::ForfeitRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Returns detailed info for one match, validated to belong to the API key owner’s approved game. Requires the game.lifecycle:read permission.

Parameters:

  • request_configuration (defaults to: nil)

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

Returns:

  • a Fiber of game_match_detail_response



62
63
64
65
66
67
68
69
70
71
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 62

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    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) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Models::GameMatchDetailResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#player_statsObject

The playerStats property



30
31
32
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 30

def player_stats()
    return TeamBattlesSdk::Generated::Game::Matches::Item::PlayerStats::PlayerStatsRequestBuilder.new(@path_parameters, @request_adapter)
end

#rostersObject

The rosters property



35
36
37
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 35

def rosters()
    return TeamBattlesSdk::Generated::Game::Matches::Item::Rosters::RostersRequestBuilder.new(@path_parameters, @request_adapter)
end

#scoresObject

The scores property



40
41
42
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 40

def scores()
    return TeamBattlesSdk::Generated::Game::Matches::Item::Scores::ScoresRequestBuilder.new(@path_parameters, @request_adapter)
end

#statusObject

The status property



45
46
47
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 45

def status()
    return TeamBattlesSdk::Generated::Game::Matches::Item::Status::StatusRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Returns detailed info for one match, validated to belong to the API key owner’s approved game. Requires the game.lifecycle:read permission.

Parameters:

  • request_configuration (defaults to: nil)

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

Returns:

  • a request_information



77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 77

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.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 with_match_item_request_builder

Raises:

  • (StandardError)


94
95
96
97
# File 'lib/teambattles_sdk/generated/game/matches/item/with_match_item_request_builder.rb', line 94

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