Class: TeamBattlesSdk::Generated::Leagues::Item::Bans::BansRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb

Overview

Builds and executes requests for operations under #leagues#identifier#bans

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new BansRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



43
44
45
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 43

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/leagues/{identifier}/bans")
end

Instance Method Details

#by_ban_id(ban_id) ⇒ Object

Gets an item from the TeamBattlesSdk::Generated.leagues.item.bans.item collection

Parameters:

  • ban_id —

    League ban ID.

Returns:

  • a with_ban_item_request_builder

Raises:

  • (StandardError) 


31
32
33
34
35
36
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 31

def by_ban_id(ban_id)
    raise StandardError, 'ban_id cannot be null' if ban_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["banId"] = ban_id
    return TeamBattlesSdk::Generated::Leagues::Item::Bans::Item::WithBanItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#create ⇒ Object

The create property



23
24
25
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 23

def create()
    return TeamBattlesSdk::Generated::Leagues::Item::Bans::Create::CreateRequestBuilder.new(@path_parameters, @request_adapter)
end

#post(body, request_configuration = nil) ⇒ Object

Returns team bans for a league resolved by slug, with optional status filtering. The API key owner must have a MANAGER+ league role or be TeamBattles staff. Requires the leagues.league_admin:read permission.

Parameters:

  • body —

    Status filter for league team bans.

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of league_bans

Raises:

  • (StandardError) 


52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 52

def post(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_post_request_information(
        body, 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) }
    return @request_adapter.send_async(request_info, lambda {|pn| TeamBattlesSdk::Generated::Models::LeagueBans.create_from_discriminator_value(pn) }, error_mapping)
end

#to_post_request_information(body, request_configuration = nil) ⇒ Object

Returns team bans for a league resolved by slug, with optional status filtering. The API key owner must have a MANAGER+ league role or be TeamBattles staff. Requires the leagues.league_admin:read permission.

Parameters:

  • body —

    Status filter for league team bans.

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information

Raises:

  • (StandardError) 


70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 70

def to_post_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.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.set_content_from_parsable(@request_adapter, 'application/json', body)
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :POST
    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 bans_request_builder

Raises:

  • (StandardError) 


89
90
91
92
 
# File 'lib/teambattles_sdk/generated/leagues/item/bans/bans_request_builder.rb', line 89

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