UNPKG

@microsoft/msgraph-beta-sdk-places

Version:
76 lines 4.38 kB
import { type RoomCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Casts the previous resource to room. */ export interface GraphRoomRequestBuilder extends BaseRequestBuilder<GraphRoomRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * 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<RoomCollectionResponse>} * @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<GraphRoomRequestBuilderGetQueryParameters> | undefined): Promise<RoomCollectionResponse | 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<GraphRoomRequestBuilderGetQueryParameters> | 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 GraphRoomRequestBuilderGetQueryParameters { /** * 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 GraphRoomRequestBuilderUriTemplate = "{+baseurl}/places/graph.room{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const GraphRoomRequestBuilderNavigationMetadata: Record<Exclude<keyof GraphRoomRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const GraphRoomRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map