UNPKG

@microsoft/msgraph-beta-sdk-education

Version:
82 lines 3.33 kB
import { type EducationClassCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type EducationClassItemRequestBuilder } 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 classes property of the microsoft.graph.educationUser entity. */ export interface ClassesRequestBuilder extends BaseRequestBuilder<ClassesRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the classes property of the microsoft.graph.educationUser entity. * @param educationClassId The unique identifier of educationClass * @returns {EducationClassItemRequestBuilder} */ byEducationClassId(educationClassId: string): EducationClassItemRequestBuilder; /** * Classes to which the user belongs. Nullable. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<EducationClassCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code */ get(requestConfiguration?: RequestConfiguration<ClassesRequestBuilderGetQueryParameters> | undefined): Promise<EducationClassCollectionResponse | undefined>; /** * Classes to which the user belongs. Nullable. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<ClassesRequestBuilderGetQueryParameters> | undefined): RequestInformation; } /** * Classes to which the user belongs. Nullable. */ export interface ClassesRequestBuilderGetQueryParameters { /** * 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 ClassesRequestBuilderUriTemplate = "{+baseurl}/education/users/{educationUser%2Did}/classes{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const ClassesRequestBuilderNavigationMetadata: Record<Exclude<keyof ClassesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const ClassesRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map