Class: MicrosoftGraph::Users::UsersRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/users/users_request_builder.rb

Overview

Provides operations to manage the collection of user entities.

Defined Under Namespace

Classes: UsersRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new UsersRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



62
63
64
 
# File 'lib/users/users_request_builder.rb', line 62

def initialize(path_parameters, request_adapter)
    super(path_parameters, request_adapter, "{+baseurl}/users{?%24top,%24search,%24filter,%24count,%24orderby,%24select,%24expand}")
end

Instance Method Details

#by_user_id(user_id) ⇒ Object

Provides operations to manage the collection of user entities.

Parameters:

  • user_id —

    The unique identifier of user

Returns:

  • a user_item_request_builder

Raises:

  • (StandardError) 


50
51
52
53
54
55
 
# File 'lib/users/users_request_builder.rb', line 50

def by_user_id(user_id)
    raise StandardError, 'user_id cannot be null' if user_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["user%2Did"] = user_id
    return MicrosoftGraph::Users::Item::UserItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



22
23
24
 
# File 'lib/users/users_request_builder.rb', line 22

def count()
    return MicrosoftGraph::Users::Count::CountRequestBuilder.new(@path_parameters, @request_adapter)
end

#delta ⇒ Object

Provides operations to call the delta method.



27
28
29
 
# File 'lib/users/users_request_builder.rb', line 27

def delta()
    return MicrosoftGraph::Users::Delta::DeltaRequestBuilder.new(@path_parameters, @request_adapter)
end

#get(request_configuration = nil) ⇒ Object

Retrieve a list of user objects.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of user_collection_response



70
71
72
73
74
75
76
77
78
 
# File 'lib/users/users_request_builder.rb', line 70

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

#get_available_extension_properties ⇒ Object

Provides operations to call the getAvailableExtensionProperties method.



32
33
34
 
# File 'lib/users/users_request_builder.rb', line 32

def get_available_extension_properties()
    return MicrosoftGraph::Users::GetAvailableExtensionProperties::GetAvailableExtensionPropertiesRequestBuilder.new(@path_parameters, @request_adapter)
end

#get_by_ids ⇒ Object

Provides operations to call the getByIds method.



37
38
39
 
# File 'lib/users/users_request_builder.rb', line 37

def get_by_ids()
    return MicrosoftGraph::Users::GetByIds::GetByIdsRequestBuilder.new(@path_parameters, @request_adapter)
end

#post(body, request_configuration = nil) ⇒ Object

Create a new user.The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.

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 user

Raises:

  • (StandardError) 


85
86
87
88
89
90
91
92
93
94
 
# File 'lib/users/users_request_builder.rb', line 85

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

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve a list of user objects.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/users/users_request_builder.rb', line 100

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_post_request_information(body, request_configuration = nil) ⇒ Object

Create a new user.The request body contains the user to create. At a minimum, you must specify the required properties for the user. You can optionally specify any other writable properties.

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) 


119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/users/users_request_builder.rb', line 119

def to_post_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 = :POST
    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

#validate_properties ⇒ Object

Provides operations to call the validateProperties method.



42
43
44
 
# File 'lib/users/users_request_builder.rb', line 42

def validate_properties()
    return MicrosoftGraph::Users::ValidateProperties::ValidatePropertiesRequestBuilder.new(@path_parameters, @request_adapter)
end