Class: TeamBattlesSdk::Generated::Teams::Item::WithIdentifierItemRequestBuilder

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

Overview

Builds and executes requests for operations under #teams#identifier

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new WithIdentifierItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



42
43
44
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 42

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

Instance Method Details

#captaincy ⇒ Object

The captaincy property



23
24
25
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 23

def captaincy()
    return TeamBattlesSdk::Generated::Teams::Item::Captaincy::CaptaincyRequestBuilder.new(@path_parameters, @request_adapter)
end

#delete(request_configuration = nil) ⇒ Object

Disbands a team (soft-deletes it and deactivates its members). The caller (key owner) must be the team captain. Requires teams.profile:read-write.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of disband_team_response



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 50

def delete(request_configuration=nil)
    request_info = self.to_delete_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) }
    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::DisbandTeamResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#get(request_configuration = nil) ⇒ Object

Returns an API-safe team profile projection. Active team members are treated as public visibility for their own team. 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 with_identifier_get_response



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 67

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) }
    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::Teams::Item::WithIdentifierGetResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#matches ⇒ Object

The matches property



28
29
30
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 28

def matches()
    return TeamBattlesSdk::Generated::Teams::Item::Matches::MatchesRequestBuilder.new(@path_parameters, @request_adapter)
end

#members ⇒ Object

The members property



33
34
35
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 33

def members()
    return TeamBattlesSdk::Generated::Teams::Item::Members::MembersRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Updates a team’s profile fields. The caller (key owner) must be the team captain. Requires teams.profile:read-write.

Parameters:

  • body —

    Fields to update on the team. All optional.

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of update_team_response

Raises:

  • (StandardError) 


85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 85

def patch(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = self.to_patch_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) }
    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::UpdateTeamResponse.create_from_discriminator_value(pn) }, error_mapping)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Disbands a team (soft-deletes it and deactivates its members). The caller (key owner) must be the team captain. Requires teams.profile:read-write.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 104

def to_delete_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 = :DELETE
    request_info.headers.try_add('Accept', 'application/json')
    return request_info
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Returns an API-safe team profile projection. Active team members are treated as public visibility for their own team. 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



121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 121

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

#to_patch_request_information(body, request_configuration = nil) ⇒ Object

Updates a team’s profile fields. The caller (key owner) must be the team captain. Requires teams.profile:read-write.

Parameters:

  • body —

    Fields to update on the team. All optional.

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information

Raises:

  • (StandardError) 


139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 139

def to_patch_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 = :PATCH
    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_identifier_item_request_builder

Raises:

  • (StandardError) 


158
159
160
161
 
# File 'lib/teambattles_sdk/generated/teams/item/with_identifier_item_request_builder.rb', line 158

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