@microsoft/msgraph-beta-sdk-external
Version:
External fluent API for Microsoft Graph
97 lines • 4.83 kB
TypeScript
import { type ExternalItem, type ExternalItemCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/externalConnectors/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type ExternalItemItemRequestBuilder } 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.externalConnectors.externalConnection entity.
*/
export interface ItemsRequestBuilder extends BaseRequestBuilder<ItemsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the items property of the microsoft.graph.externalConnectors.externalConnection entity.
* @param externalItemId The unique identifier of externalItem
* @returns {ExternalItemItemRequestBuilder}
*/
byExternalItemId(externalItemId: string): ExternalItemItemRequestBuilder;
/**
* Get the properties and relationships of an externalitem object. This API is provided for diagnostic purposes only. It isn't intended to be used for any other purpose. Repeated requests to this API might result in 429 HTTP errors.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ExternalItemCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
get(requestConfiguration?: RequestConfiguration<ItemsRequestBuilderGetQueryParameters> | undefined): Promise<ExternalItemCollectionResponse | undefined>;
/**
* Create new navigation property to items for external
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ExternalItem>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
*/
post(body: ExternalItem, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ExternalItem | undefined>;
/**
* Get the properties and relationships of an externalitem object. This API is provided for diagnostic purposes only. It isn't intended to be used for any other purpose. Repeated requests to this API might result in 429 HTTP errors.
* @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 external
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: ExternalItem, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get the properties and relationships of an externalitem object. This API is provided for diagnostic purposes only. It isn't intended to be used for any other purpose. Repeated requests to this API might result in 429 HTTP errors.
*/
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}/external/connections/{externalConnection%2Did}/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