@microsoft/msgraph-beta-sdk-users/users/item/planner/rosterPlans/index.d.ts

Users fluent API for Microsoft Graph

import { type PlannerPlanCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type PlannerPlanItemRequestBuilder } 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 rosterPlans property of the microsoft.graph.plannerUser entity.
 */
export interface RosterPlansRequestBuilder extends BaseRequestBuilder<RosterPlansRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the rosterPlans property of the microsoft.graph.plannerUser entity.
     * @param plannerPlanId The unique identifier of plannerPlan
     * @returns {PlannerPlanItemRequestBuilder}
     */
    byPlannerPlanId(plannerPlanId: string): PlannerPlanItemRequestBuilder;
    /**
     * Get the list of plannerPlans that are contained by the plannerRosters of which the user is a member.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<PlannerPlanCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/planneruser-list-rosterplans?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<RosterPlansRequestBuilderGetQueryParameters> | undefined): Promise<PlannerPlanCollectionResponse | undefined>;
    /**
     * Get the list of plannerPlans that are contained by the plannerRosters of which the user is a member.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<RosterPlansRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
 * Get the list of plannerPlans that are contained by the plannerRosters of which the user is a member.
 */
export interface RosterPlansRequestBuilderGetQueryParameters {
    /**
     * 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 RosterPlansRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/planner/rosterPlans{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const RosterPlansRequestBuilderNavigationMetadata: Record<Exclude<keyof RosterPlansRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const RosterPlansRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map