Class: TeamBattlesSdk::Generated::Orgs::Item::WithIdentifierItemRequestBuilder

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

Overview

Builds and executes requests for operations under #orgs#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.



54
55
56
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 54

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

Instance Method Details

#delete(request_configuration = nil) ⇒ Object

Deletes an organization. The caller (key owner) must be the organization owner. Requires orgs.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 delete_org_response



62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 62

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

#get(request_configuration = nil) ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 79

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

#matchesObject

The matches property



25
26
27
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 25

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

#membersObject

The members property



30
31
32
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 30

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

#ownershipObject

The ownership property



35
36
37
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 35

def ownership()
    return TeamBattlesSdk::Generated::Orgs::Item::Ownership::OwnershipRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Updates an organization’s profile fields. The caller (key owner) must be an organization owner or admin. Requires orgs.profile:read-write.

Parameters:

  • body

    Fields to update on the organization. All optional.

  • request_configuration (defaults to: nil)

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

Returns:

  • a Fiber of update_org_response

Raises:

  • (StandardError)


97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 97

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

#statsObject

The stats property



40
41
42
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 40

def stats()
    return TeamBattlesSdk::Generated::Orgs::Item::Stats::StatsRequestBuilder.new(@path_parameters, @request_adapter)
end

#teamsObject

The teams property



45
46
47
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 45

def teams()
    return TeamBattlesSdk::Generated::Orgs::Item::Teams::TeamsRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Deletes an organization. The caller (key owner) must be the organization owner. Requires orgs.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



116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 116

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 organization profile projection. Active organization members are treated as public visibility for their own organization. Requires orgs.profile:read.

Parameters:

  • request_configuration (defaults to: nil)

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

Returns:

  • a request_information



133
134
135
136
137
138
139
140
141
142
143
144
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 133

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 an organization’s profile fields. The caller (key owner) must be an organization owner or admin. Requires orgs.profile:read-write.

Parameters:

  • body

    Fields to update on the organization. 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)


151
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 151

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)


170
171
172
173
# File 'lib/teambattles_sdk/generated/orgs/item/with_identifier_item_request_builder.rb', line 170

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