UNPKG

@microsoft/msgraph-beta-sdk-users

Version:
98 lines 4.37 kB
import { type UsageRight, type UsageRightCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type UsageRightItemRequestBuilder } from './item/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the usageRights property of the microsoft.graph.user entity. */ export interface UsageRightsRequestBuilder extends BaseRequestBuilder<UsageRightsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the usageRights property of the microsoft.graph.user entity. * @param usageRightId The unique identifier of usageRight * @returns {UsageRightItemRequestBuilder} */ byUsageRightId(usageRightId: string): UsageRightItemRequestBuilder; /** * Retrieve a list of usageRight objects for a given user. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<UsageRightCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/user-list-usagerights?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<UsageRightsRequestBuilderGetQueryParameters> | undefined): Promise<UsageRightCollectionResponse | undefined>; /** * Create new navigation property to usageRights for users * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<UsageRight>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code */ post(body: UsageRight, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<UsageRight | undefined>; /** * Retrieve a list of usageRight objects for a given user. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<UsageRightsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create new navigation property to usageRights for users * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: UsageRight, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Retrieve a list of usageRight objects for a given user. */ export interface UsageRightsRequestBuilderGetQueryParameters { /** * Include count of items */ count?: boolean; /** * Expand related entities */ expand?: string[]; /** * Filter items by property values */ filter?: string; /** * Order items by property values */ orderby?: string[]; /** * Search items by search phrases */ search?: string; /** * Select properties to be returned */ select?: string[]; /** * Skip the first n items */ skip?: number; /** * Show only the first n items */ top?: number; } /** * Uri template for the request builder. */ export declare const UsageRightsRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/usageRights{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const UsageRightsRequestBuilderNavigationMetadata: Record<Exclude<keyof UsageRightsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const UsageRightsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map