@microsoft/msgraph-beta-sdk-groups
Version:
Groups fluent API for Microsoft Graph
97 lines • 4.04 kB
TypeScript
import { type Shift, type ShiftCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type ShiftItemRequestBuilder } 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 shifts property of the microsoft.graph.schedule entity.
*/
export interface ShiftsRequestBuilder extends BaseRequestBuilder<ShiftsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the shifts property of the microsoft.graph.schedule entity.
* @param shiftId The unique identifier of shift
* @returns {ShiftItemRequestBuilder}
*/
byShiftId(shiftId: string): ShiftItemRequestBuilder;
/**
* The shifts in the schedule.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ShiftCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<ShiftsRequestBuilderGetQueryParameters> | undefined): Promise<ShiftCollectionResponse | undefined>;
/**
* Create new navigation property to shifts for groups
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<Shift>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: Shift, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Shift | undefined>;
/**
* The shifts in the schedule.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<ShiftsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to shifts for groups
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: Shift, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The shifts in the schedule.
*/
export interface ShiftsRequestBuilderGetQueryParameters {
/**
* 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 ShiftsRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/team/schedule/shifts{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ShiftsRequestBuilderNavigationMetadata: Record<Exclude<keyof ShiftsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ShiftsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map