@microsoft/msgraph-beta-sdk-places
Version:
Places fluent API for Microsoft Graph
62 lines • 4.37 kB
TypeScript
import { type Building } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CheckInsRequestBuilder } from './checkIns/index.js';
import { type ChildrenRequestBuilder } from './children/index.js';
import { type MapRequestBuilder } from './map/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Casts the previous resource to building.
*/
export interface GraphBuildingRequestBuilder extends BaseRequestBuilder<GraphBuildingRequestBuilder> {
/**
* Provides operations to manage the checkIns property of the microsoft.graph.place entity.
*/
get checkIns(): CheckInsRequestBuilder;
/**
* Provides operations to manage the children property of the microsoft.graph.place entity.
*/
get children(): ChildrenRequestBuilder;
/**
* Provides operations to manage the map property of the microsoft.graph.building entity.
*/
get map(): MapRequestBuilder;
/**
* Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:- List all buildings.- List all floors.- List all sections.- List all desks.- List all rooms.- List all workspaces.- List all room lists.- List rooms in a specific room list.- List workspaces in a specific room list. Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. For details about how they compare, see Using the places API.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Building>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/place-list?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<GraphBuildingRequestBuilderGetQueryParameters> | undefined): Promise<Building | undefined>;
/**
* Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:- List all buildings.- List all floors.- List all sections.- List all desks.- List all rooms.- List all workspaces.- List all room lists.- List rooms in a specific room list.- List workspaces in a specific room list. Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. For details about how they compare, see Using the places API.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<GraphBuildingRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
* Get a collection of the specified type of place objects defined in a tenant. You can do the following for a given tenant:- List all buildings.- List all floors.- List all sections.- List all desks.- List all rooms.- List all workspaces.- List all room lists.- List rooms in a specific room list.- List workspaces in a specific room list. Compared with the findRooms and findRoomLists functions, this operation returns a richer payload for rooms and room lists. For details about how they compare, see Using the places API.
*/
export interface GraphBuildingRequestBuilderGetQueryParameters {
/**
* Expand related entities
*/
expand?: string[];
/**
* Select properties to be returned
*/
select?: string[];
}
/**
* Uri template for the request builder.
*/
export declare const GraphBuildingRequestBuilderUriTemplate = "{+baseurl}/places/{place%2Did}/graph.building{?%24expand,%24select}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const GraphBuildingRequestBuilderNavigationMetadata: Record<Exclude<keyof GraphBuildingRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const GraphBuildingRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map