@microsoft/msgraph-beta-sdk-education/education/schools/item/users/index.d.ts

Education fluent API for Microsoft Graph

import { type EducationUserCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type EducationUserItemRequestBuilder } from './item/index.js';
import { type RefRequestBuilder } from './ref/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the users property of the microsoft.graph.educationSchool entity.
 */
export interface UsersRequestBuilder extends BaseRequestBuilder<UsersRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the collection of educationRoot entities.
     */
    get ref(): RefRequestBuilder;
    /**
     * Gets an item from the github.com/microsoftgraph/msgraph-sdk-typescript/.education.schools.item.users.item collection
     * @param educationUserId The unique identifier of educationUser
     * @returns {EducationUserItemRequestBuilder}
     */
    byEducationUserId(educationUserId: string): EducationUserItemRequestBuilder;
    /**
     * Retrieve a list of users at a school.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<EducationUserCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/educationschool-list-users?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<UsersRequestBuilderGetQueryParameters> | undefined): Promise<EducationUserCollectionResponse | undefined>;
    /**
     * Retrieve a list of users at a school.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<UsersRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
 * Retrieve a list of users at a school.
 */
export interface UsersRequestBuilderGetQueryParameters {
    /**
     * 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 UsersRequestBuilderUriTemplate = "{+baseurl}/education/schools/{educationSchool%2Did}/users{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const UsersRequestBuilderNavigationMetadata: Record<Exclude<keyof UsersRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const UsersRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map