@microsoft/msgraph-beta-sdk-compliance
Version:
Compliance fluent API for Microsoft Graph
105 lines • 5.82 kB
TypeScript
import { type CaseCollectionResponse, type CaseEscaped } from '@microsoft/msgraph-beta-sdk/models/ediscovery/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type CaseItemRequestBuilder } 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 cases property of the microsoft.graph.ediscovery.ediscoveryroot entity.
*/
export interface CasesRequestBuilder extends BaseRequestBuilder<CasesRequestBuilder> {
/**
* 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 cases property of the microsoft.graph.ediscovery.ediscoveryroot entity.
* @param caseId The unique identifier of case
* @returns {CaseItemRequestBuilder}
* @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
*/
byCaseId(caseId: string): CaseItemRequestBuilder;
/**
* Retrieve a list of case objects.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<CaseCollectionResponse>}
* @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
* @see {@link https://learn.microsoft.com/graph/api/ediscovery-case-list?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<CasesRequestBuilderGetQueryParameters> | undefined): Promise<CaseCollectionResponse | undefined>;
/**
* Create a new case object.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<CaseEscaped>}
* @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
* @see {@link https://learn.microsoft.com/graph/api/ediscovery-case-post?view=graph-rest-beta|Find more info here}
*/
post(body: CaseEscaped, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CaseEscaped | undefined>;
/**
* Retrieve a list of case objects.
* @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<CasesRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create a new case object.
* @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: CaseEscaped, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Retrieve a list of case objects.
*/
export interface CasesRequestBuilderGetQueryParameters {
/**
* 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 CasesRequestBuilderUriTemplate = "{+baseurl}/compliance/ediscovery/cases{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const CasesRequestBuilderNavigationMetadata: Record<Exclude<keyof CasesRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const CasesRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map