@microsoft/msgraph-sdk-sites
Version:
Sites fluent API for Microsoft Graph
98 lines • 4.59 kB
TypeScript
import { type RichLongRunningOperation, type RichLongRunningOperationCollectionResponse } from '@microsoft/msgraph-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type RichLongRunningOperationItemRequestBuilder } 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 operations property of the microsoft.graph.site entity.
*/
export interface OperationsRequestBuilder extends BaseRequestBuilder<OperationsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the operations property of the microsoft.graph.site entity.
* @param richLongRunningOperationId The unique identifier of richLongRunningOperation
* @returns {RichLongRunningOperationItemRequestBuilder}
*/
byRichLongRunningOperationId(richLongRunningOperationId: string): RichLongRunningOperationItemRequestBuilder;
/**
* Get a list of rich long-running operations associated with a site.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<RichLongRunningOperationCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/site-list-operations?view=graph-rest-1.0|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<OperationsRequestBuilderGetQueryParameters> | undefined): Promise<RichLongRunningOperationCollectionResponse | undefined>;
/**
* Create new navigation property to operations for sites
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<RichLongRunningOperation>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: RichLongRunningOperation, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<RichLongRunningOperation | undefined>;
/**
* Get a list of rich long-running operations associated with a site.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<OperationsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to operations for sites
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: RichLongRunningOperation, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get a list of rich long-running operations associated with a site.
*/
export interface OperationsRequestBuilderGetQueryParameters {
/**
* 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 OperationsRequestBuilderUriTemplate = "{+baseurl}/sites/{site%2Did}/operations{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const OperationsRequestBuilderNavigationMetadata: Record<Exclude<keyof OperationsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const OperationsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map