@microsoft/msgraph-beta-sdk-groups/groups/item/planner/plans/index.d.ts

Groups fluent API for Microsoft Graph

import { type PlannerPlan, type PlannerPlanCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DeltaRequestBuilder } from './delta/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 plans property of the microsoft.graph.plannerGroup entity.
 */
export interface PlansRequestBuilder extends BaseRequestBuilder<PlansRequestBuilder> {
    /**
     * 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 plans property of the microsoft.graph.plannerGroup entity.
     * @param plannerPlanId The unique identifier of plannerPlan
     * @returns {PlannerPlanItemRequestBuilder}
     */
    byPlannerPlanId(plannerPlanId: string): PlannerPlanItemRequestBuilder;
    /**
     * Retrieve a list of plannerPlan objects owned by a group object.
     * @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/plannergroup-list-plans?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<PlansRequestBuilderGetQueryParameters> | undefined): Promise<PlannerPlanCollectionResponse | undefined>;
    /**
     * Create new navigation property to plans for groups
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<PlannerPlan>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: PlannerPlan, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PlannerPlan | undefined>;
    /**
     * Retrieve a list of plannerPlan objects owned by a group object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<PlansRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to plans 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: PlannerPlan, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve a list of plannerPlan objects owned by a group object.
 */
export interface PlansRequestBuilderGetQueryParameters {
    /**
     * 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 PlansRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/planner/plans{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const PlansRequestBuilderNavigationMetadata: Record<Exclude<keyof PlansRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const PlansRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map