@microsoft/msgraph-beta-sdk-compliance/compliance/ediscovery/cases/item/legalHolds/index.d.ts

Compliance fluent API for Microsoft Graph

import { type LegalHold, type LegalHoldCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/ediscovery/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type LegalHoldItemRequestBuilder } 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 legalHolds property of the microsoft.graph.ediscovery.case entity.
 */
export interface LegalHoldsRequestBuilder extends BaseRequestBuilder<LegalHoldsRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the legalHolds property of the microsoft.graph.ediscovery.case entity.
     * @param legalHoldId The unique identifier of legalHold
     * @returns {LegalHoldItemRequestBuilder}
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    byLegalHoldId(legalHoldId: string): LegalHoldItemRequestBuilder;
    /**
     * Read the properties and relationships of a legalHold object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<LegalHoldCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    get(requestConfiguration?: RequestConfiguration<LegalHoldsRequestBuilderGetQueryParameters> | undefined): Promise<LegalHoldCollectionResponse | undefined>;
    /**
     * Create new navigation property to legalHolds for compliance
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<LegalHold>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    post(body: LegalHold, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<LegalHold | undefined>;
    /**
     * Read the properties and relationships of a legalHold object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<LegalHoldsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to legalHolds for compliance
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     * @deprecated The ediscovery Apis are deprecated under /compliance and will stop returning data from February 01, 2023. Please use the new ediscovery Apis under /security. as of 2022-12/ediscoveryNamespace on 2022-12-05 and will be removed 2023-02-01
     */
    toPostRequestInformation(body: LegalHold, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Read the properties and relationships of a legalHold object.
 */
export interface LegalHoldsRequestBuilderGetQueryParameters {
    /**
     * 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 LegalHoldsRequestBuilderUriTemplate = "{+baseurl}/compliance/ediscovery/cases/{case%2Did}/legalHolds{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const LegalHoldsRequestBuilderNavigationMetadata: Record<Exclude<keyof LegalHoldsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const LegalHoldsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map