@microsoft/msgraph-beta-sdk-termstore/termStore/sets/item/terms/index.d.ts

TermStore fluent API for Microsoft Graph

import { type Term, type TermCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/termStore/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type TermItemRequestBuilder } 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 terms property of the microsoft.graph.termStore.set entity.
 */
export interface TermsRequestBuilder extends BaseRequestBuilder<TermsRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the terms property of the microsoft.graph.termStore.set entity.
     * @param termId The unique identifier of term
     * @returns {TermItemRequestBuilder}
     */
    byTermId(termId: string): TermItemRequestBuilder;
    /**
     * All the terms under the set.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<TermCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    get(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined): Promise<TermCollectionResponse | undefined>;
    /**
     * Create new navigation property to terms for termStore
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Term>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: Term, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Term | undefined>;
    /**
     * All the terms under the set.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<TermsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to terms for termStore
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: Term, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * All the terms under the set.
 */
export interface TermsRequestBuilderGetQueryParameters {
    /**
     * 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 TermsRequestBuilderUriTemplate = "{+baseurl}/termStore/sets/{set%2Did}/terms{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const TermsRequestBuilderNavigationMetadata: Record<Exclude<keyof TermsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const TermsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map