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

Education fluent API for Microsoft Graph

import { type EducationSchool } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type AdministrativeUnitRequestBuilder } from './administrativeUnit/index.js';
import { type ClassesRequestBuilder } from './classes/index.js';
import { type UsersRequestBuilder } from './users/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the schools property of the microsoft.graph.educationRoot entity.
 */
export interface EducationSchoolItemRequestBuilder extends BaseRequestBuilder<EducationSchoolItemRequestBuilder> {
    /**
     * Provides operations to manage the administrativeUnit property of the microsoft.graph.educationSchool entity.
     */
    get administrativeUnit(): AdministrativeUnitRequestBuilder;
    /**
     * Provides operations to manage the classes property of the microsoft.graph.educationSchool entity.
     */
    get classes(): ClassesRequestBuilder;
    /**
     * Provides operations to manage the users property of the microsoft.graph.educationSchool entity.
     */
    get users(): UsersRequestBuilder;
    /**
     * Delete a school.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/educationschool-delete?view=graph-rest-beta|Find more info here}
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Retrieve the properties and relationships of the school object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<EducationSchool>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/educationschool-get?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<EducationSchoolItemRequestBuilderGetQueryParameters> | undefined): Promise<EducationSchool | undefined>;
    /**
     * Update the properties of a school object.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<EducationSchool>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/educationschool-update?view=graph-rest-beta|Find more info here}
     */
    patch(body: EducationSchool, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<EducationSchool | undefined>;
    /**
     * Delete a school.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Retrieve the properties and relationships of the school object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<EducationSchoolItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update the properties of a school object.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: EducationSchool, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve the properties and relationships of the school object.
 */
export interface EducationSchoolItemRequestBuilderGetQueryParameters {
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Select properties to be returned
     */
    select?: string[];
}
/**
 * Uri template for the request builder.
 */
export declare const EducationSchoolItemRequestBuilderUriTemplate = "{+baseurl}/education/schools/{educationSchool%2Did}{?%24expand,%24select}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const EducationSchoolItemRequestBuilderNavigationMetadata: Record<Exclude<keyof EducationSchoolItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const EducationSchoolItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map