Class: MicrosoftGraph::Directory::DeletedItems::Item::DirectoryObjectItemRequestBuilder

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

Overview

Provides operations to manage the deletedItems property of the microsoft.graph.directory entity.

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.



89
90
91
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 89

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

Instance Method Details

#check_member_groups ⇒ Object

Provides operations to call the checkMemberGroups method.



30
31
32
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 30

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

#check_member_objects ⇒ Object

Provides operations to call the checkMemberObjects method.



35
36
37
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 35

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

#delete(request_configuration = nil) ⇒ Object

Permanently delete a recently deleted application, group, servicePrincipal, or user object from deleted items. After an item is permanently deleted, it cannot be restored. Administrative units cannot be permanently deleted by using the deletedItems API. Soft-deleted administrative units will be permanently deleted 30 days after initial deletion unless they are restored.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of void



97
98
99
100
101
102
103
104
105
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 97

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

#get(request_configuration = nil) ⇒ Object

Retrieve the properties of a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of directory_object



111
112
113
114
115
116
117
118
119
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 111

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::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.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.



40
41
42
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 40

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

#get_member_objects ⇒ Object

Provides operations to call the getMemberObjects method.



45
46
47
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 45

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

#graph_administrative_unit ⇒ Object

Casts the previous resource to administrativeUnit.



50
51
52
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 50

def graph_administrative_unit()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphAdministrativeUnit::GraphAdministrativeUnitRequestBuilder.new(@path_parameters, @request_adapter)
end

#graph_application ⇒ Object

Casts the previous resource to application.



55
56
57
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 55

def graph_application()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphApplication::GraphApplicationRequestBuilder.new(@path_parameters, @request_adapter)
end

#graph_device ⇒ Object

Casts the previous resource to device.



60
61
62
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 60

def graph_device()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphDevice::GraphDeviceRequestBuilder.new(@path_parameters, @request_adapter)
end

#graph_group ⇒ Object

Casts the previous resource to group.



65
66
67
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 65

def graph_group()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphGroup::GraphGroupRequestBuilder.new(@path_parameters, @request_adapter)
end

#graph_service_principal ⇒ Object

Casts the previous resource to servicePrincipal.



70
71
72
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 70

def graph_service_principal()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphServicePrincipal::GraphServicePrincipalRequestBuilder.new(@path_parameters, @request_adapter)
end

#graph_user ⇒ Object

Casts the previous resource to user.



75
76
77
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 75

def graph_user()
    return MicrosoftGraph::Directory::DeletedItems::Item::GraphUser::GraphUserRequestBuilder.new(@path_parameters, @request_adapter)
end

#patch(body, request_configuration = nil) ⇒ Object

Update the navigation property deletedItems in directory

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) 


126
127
128
129
130
131
132
133
134
135
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 126

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::ODataErrorsODataError.create_from_discriminator_value(pn) }
    error_mapping["5XX"] = lambda {|pn| MicrosoftGraph::Models::ODataErrorsODataError.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.



80
81
82
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 80

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

#to_delete_request_information(request_configuration = nil) ⇒ Object

Permanently delete a recently deleted application, group, servicePrincipal, or user object from deleted items. After an item is permanently deleted, it cannot be restored. Administrative units cannot be permanently deleted by using the deletedItems API. Soft-deleted administrative units will be permanently deleted 30 days after initial deletion unless they are restored.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 141

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 of a recently deleted application, group, servicePrincipal, administrative unit, or user object from deleted items.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 157

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 the navigation property deletedItems in directory

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) 


176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/directory/deleted_items/item/directory_object_item_request_builder.rb', line 176

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