@microsoft/msgraph-beta-sdk-users
Version:
Users fluent API for Microsoft Graph
102 lines • 4.3 kB
TypeScript
import { type Event, type EventCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DeltaRequestBuilder } from './delta/index.js';
import { type EventItemRequestBuilder } 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 events property of the microsoft.graph.calendar entity.
*/
export interface EventsRequestBuilder extends BaseRequestBuilder<EventsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to call the delta method.
*/
get delta(): DeltaRequestBuilder;
/**
* Provides operations to manage the events property of the microsoft.graph.calendar entity.
* @param eventId The unique identifier of event
* @returns {EventItemRequestBuilder}
*/
byEventId(eventId: string): EventItemRequestBuilder;
/**
* The events in the calendar. Navigation property. Read-only.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<EventCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<EventsRequestBuilderGetQueryParameters> | undefined): Promise<EventCollectionResponse | undefined>;
/**
* Create new navigation property to events for users
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Event>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: Event, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Event | undefined>;
/**
* The events in the calendar. Navigation property. Read-only.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<EventsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to events for users
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: Event, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The events in the calendar. Navigation property. Read-only.
*/
export interface EventsRequestBuilderGetQueryParameters {
/**
* 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 EventsRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/calendar/events{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const EventsRequestBuilderNavigationMetadata: Record<Exclude<keyof EventsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const EventsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map