Class: MicrosoftGraph::Oauth2PermissionGrants::Oauth2PermissionGrantsRequestBuilder

Inherits:
MicrosoftKiotaAbstractions::BaseRequestBuilder
  • Object
show all
Defined in:
lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb

Overview

Provides operations to manage the collection of oAuth2PermissionGrant entities.

Defined Under Namespace

Classes: Oauth2PermissionGrantsRequestBuilderGetQueryParameters

Instance Method Summary collapse

Constructor Details

#initialize(path_parameters, request_adapter) ⇒ Object

Instantiates a new Oauth2PermissionGrantsRequestBuilder and sets the default values.

Parameters:

  • path_parameters —

    Path parameters for the request

  • request_adapter —

    The request adapter to use to execute the requests.



44
45
46
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 44

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

Instance Method Details

#by_o_auth2_permission_grant_id(o_auth2_permission_grant_id) ⇒ Object

Provides operations to manage the collection of oAuth2PermissionGrant entities.

Parameters:

  • o_auth2_permission_grant_id —

    The unique identifier of oAuth2PermissionGrant

Returns:

  • a o_auth2_permission_grant_item_request_builder

Raises:

  • (StandardError) 


32
33
34
35
36
37
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 32

def by_o_auth2_permission_grant_id(o_auth2_permission_grant_id)
    raise StandardError, 'o_auth2_permission_grant_id cannot be null' if o_auth2_permission_grant_id.nil?
    url_tpl_params = @path_parameters.clone
    url_tpl_params["oAuth2PermissionGrant%2Did"] = o_auth2_permission_grant_id
    return MicrosoftGraph::Oauth2PermissionGrants::Item::OAuth2PermissionGrantItemRequestBuilder.new(url_tpl_params, @request_adapter)
end

#count ⇒ Object

Provides operations to count the resources in the collection.



19
20
21
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 19

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

#delta ⇒ Object

Provides operations to call the delta method.



24
25
26
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 24

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

#get(request_configuration = nil) ⇒ Object

Retrieve a list of oAuth2PermissionGrant objects, representing delegated permissions which have been granted for client applications to access APIs on behalf of signed-in users.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a Fiber of o_auth2_permission_grant_collection_response



52
53
54
55
56
57
58
59
60
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 52

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

#post(body, request_configuration = nil) ⇒ Object

Create a delegated permission grant represented by an oAuth2PermissionGrant object. A delegated permission grant authorizes a client service principal (representing a client application) to access a resource service principal (representing an API), on behalf of a signed-in user, for the level of access limited by the delegated permissions which were granted.

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 o_auth2_permission_grant

Raises:

  • (StandardError) 


67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 67

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

#to_get_request_information(request_configuration = nil) ⇒ Object

Retrieve a list of oAuth2PermissionGrant objects, representing delegated permissions which have been granted for client applications to access APIs on behalf of signed-in users.

Parameters:

  • request_configuration (defaults to: nil) —

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

Returns:

  • a request_information



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 82

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 delegated permission grant represented by an oAuth2PermissionGrant object. A delegated permission grant authorizes a client service principal (representing a client application) to access a resource service principal (representing an API), on behalf of a signed-in user, for the level of access limited by the delegated permissions which were granted.

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) 


101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oauth2_permission_grants/oauth2_permission_grants_request_builder.rb', line 101

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