Class: MicrosoftGraph::DirectoryObjects::Item::DirectoryObjectItemRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/directory_objects/item/directory_object_item_request_builder.rb

Overview

Provides operations to manage the collection of directoryObject entities.

Defined Under Namespace

Classes: DirectoryObjectItemRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new DirectoryObjectItemRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



51
52
53
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 51

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/directoryObjects/{directoryObject%2Did}{?%24select,%24expand}")
end

Instance Method Details

#check_member_groups ⇒ Object

Provides operations to call the checkMemberGroups method.



22
23
24
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 22

def check_member_groups()
    return MicrosoftGraph::DirectoryObjects::Item::CheckMemberGroups::CheckMemberGroupsRequestBuilder.new(@path_parameters, @request_adapter)
end

#check_member_objects ⇒ Object

Provides operations to call the checkMemberObjects method.



27
28
29
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 27

def check_member_objects()
    return MicrosoftGraph::DirectoryObjects::Item::CheckMemberObjects::CheckMemberObjectsRequestBuilder.new(@path_parameters, @request_adapter)
end

#delete(request_configuration = nil) ⇒ Object

Delete a directory object, for example, a group, user, application, or service principal.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of void



59
60
61
62
63
64
65
66
67
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 59

def delete(request_configuration=nil)
    request_info = self.to_delete_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, nil, error_mapping)
end

#get(request_configuration = nil) ⇒ Object

Retrieve the properties and relationships of a directoryObject object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of directory_object



73
74
75
76
77
78
79
80
81
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 73

def get(request_configuration=nil)
    request_info = self.to_get_request_information(
        request_configuration
    )
    error_mapping = Hash.new
    error_mapping["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }, error_mapping)
end

#get_member_groups ⇒ Object

Provides operations to call the getMemberGroups method.



32
33
34
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 32

def get_member_groups()
    return MicrosoftGraph::DirectoryObjects::Item::GetMemberGroups::GetMemberGroupsRequestBuilder.new(@path_parameters, @request_adapter)
end

#get_member_objects ⇒ Object

Provides operations to call the getMemberObjects method.



37
38
39
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 37

def get_member_objects()
    return MicrosoftGraph::DirectoryObjects::Item::GetMemberObjects::GetMemberObjectsRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Update entity in directoryObjects

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of directory_object

Raises:

  • (StandardError) 


88
89
90
91
92
93
94
95
96
97
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 88

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["4XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrors::ODataError.create_from_discriminator_value(pn) }
    return @request_adapter.send_async(request_info, lambda {|pn| MicrosoftGraph::Models::DirectoryObject.create_from_discriminator_value(pn) }, error_mapping)
end

#restore ⇒ Object

Provides operations to call the restore method.



42
43
44
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 42

def restore()
    return MicrosoftGraph::DirectoryObjects::Item::Restore::RestoreRequestBuilder.new(@path_parameters, @request_adapter)
end

#to_delete_request_information(request_configuration = nil) ⇒ Object

Delete a directory object, for example, a group, user, application, or service principal.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 103

def to_delete_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :DELETE
    unless request_configuration.nil?
        request_info.add_headers_from_raw_object(request_configuration.headers)
        request_info.add_request_options(request_configuration.options)
    end
    return request_info
end

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve the properties and relationships of a directoryObject object.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 119

def to_get_request_information(request_configuration=nil)
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :GET
    request_info.headers.add('Accept', 'application/json')
    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
    return request_info
end

#to_patch_request_information(body, request_configuration = nil) ⇒ Object

Update entity in directoryObjects

Parameters:

  • body —

    The request body

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information

Raises:

  • (StandardError) 


138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/directory_objects/item/directory_object_item_request_builder.rb', line 138

def to_patch_request_information(body, request_configuration=nil)
    raise StandardError, 'body cannot be null' if body.nil?
    request_info = MicrosoftKiotaAbstractions::RequestInformation.new()
    request_info.url_template = @url_template
    request_info.path_parameters = @path_parameters
    request_info.http_method = :PATCH
    request_info.headers.add('Accept', 'application/json')
    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)
    return request_info
end