@microsoft/msgraph-sdk-security/security/labels/retentionLabels/item/index.d.ts

Security fluent API for Microsoft Graph

import { type RetentionLabel } from '@microsoft/msgraph-sdk/models/security/index.js';
import { type DescriptorsRequestBuilder } from './descriptors/index.js';
import { type DispositionReviewStagesRequestBuilder } from './dispositionReviewStages/index.js';
import { type RetentionEventTypeRequestBuilder } from './retentionEventType/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the retentionLabels property of the microsoft.graph.security.labelsRoot entity.
 */
export interface RetentionLabelItemRequestBuilder extends BaseRequestBuilder<RetentionLabelItemRequestBuilder> {
    /**
     * Provides operations to manage the descriptors property of the microsoft.graph.security.retentionLabel entity.
     */
    get descriptors(): DescriptorsRequestBuilder;
    /**
     * Provides operations to manage the dispositionReviewStages property of the microsoft.graph.security.retentionLabel entity.
     */
    get dispositionReviewStages(): DispositionReviewStagesRequestBuilder;
    /**
     * Provides operations to manage the retentionEventType property of the microsoft.graph.security.retentionLabel entity.
     */
    get retentionEventType(): RetentionEventTypeRequestBuilder;
    /**
     * Delete a retentionLabel object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/security-retentionlabel-delete?view=graph-rest-1.0|Find more info here}
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Represents how customers can manage their data, whether and for how long to retain or delete it.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<RetentionLabel>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    get(requestConfiguration?: RequestConfiguration<RetentionLabelItemRequestBuilderGetQueryParameters> | undefined): Promise<RetentionLabel | undefined>;
    /**
     * Update the properties of a retentionLabel object. To update a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<RetentionLabel>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/security-retentionlabel-update?view=graph-rest-1.0|Find more info here}
     */
    patch(body: RetentionLabel, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<RetentionLabel | undefined>;
    /**
     * Delete a retentionLabel object.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Represents how customers can manage their data, whether and for how long to retain or delete it.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<RetentionLabelItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update the properties of a retentionLabel object. To update a disposition review stage, include the actionAfterRetentionPeriod property in the request body with one of the possible values specified.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: RetentionLabel, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Represents how customers can manage their data, whether and for how long to retain or delete it.
 */
export interface RetentionLabelItemRequestBuilderGetQueryParameters {
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Select properties to be returned
     */
    select?: string[];
}
/**
 * Uri template for the request builder.
 */
export declare const RetentionLabelItemRequestBuilderUriTemplate = "{+baseurl}/security/labels/retentionLabels/{retentionLabel%2Did}{?%24expand,%24select}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const RetentionLabelItemRequestBuilderNavigationMetadata: Record<Exclude<keyof RetentionLabelItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const RetentionLabelItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map