@microsoft/msgraph-sdk-shares
Version:
Shares fluent API for Microsoft Graph
104 lines • 4.38 kB
TypeScript
import { type ListItem, type ListItemCollectionResponse } from '@microsoft/msgraph-sdk/models/index.js';
import { type DeltaRequestBuilder } from './delta/index.js';
import { type DeltaWithTokenRequestBuilder } from './deltaWithToken/index.js';
import { type ListItemItemRequestBuilder } 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 items property of the microsoft.graph.list entity.
*/
export interface ItemsRequestBuilder extends BaseRequestBuilder<ItemsRequestBuilder> {
/**
* Provides operations to call the delta method.
*/
get delta(): DeltaRequestBuilder;
/**
* Provides operations to manage the items property of the microsoft.graph.list entity.
* @param listItemId The unique identifier of listItem
* @returns {ListItemItemRequestBuilder}
*/
byListItemId(listItemId: string): ListItemItemRequestBuilder;
/**
* Provides operations to call the delta method.
* @param token Usage: token='{token}'
* @returns {DeltaWithTokenRequestBuilder}
*/
deltaWithToken(token: string | undefined): DeltaWithTokenRequestBuilder;
/**
* All items contained in the list.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ListItemCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<ItemsRequestBuilderGetQueryParameters> | undefined): Promise<ListItemCollectionResponse | undefined>;
/**
* Create new navigation property to items for shares
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ListItem>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: ListItem, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ListItem | undefined>;
/**
* All items contained in the list.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<ItemsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to items for shares
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: ListItem, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* All items contained in the list.
*/
export interface ItemsRequestBuilderGetQueryParameters {
/**
* 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 ItemsRequestBuilderUriTemplate = "{+baseurl}/shares/{sharedDriveItem%2Did}/list/items{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ItemsRequestBuilderNavigationMetadata: Record<Exclude<keyof ItemsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ItemsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map