UNPKG

@microsoft/msgraph-beta-sdk-groups

Version:
98 lines 4.26 kB
import { type Endpoint, type EndpointCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type EndpointItemRequestBuilder } 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 endpoints property of the microsoft.graph.group entity. */ export interface EndpointsRequestBuilder extends BaseRequestBuilder<EndpointsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the endpoints property of the microsoft.graph.group entity. * @param endpointId The unique identifier of endpoint * @returns {EndpointItemRequestBuilder} */ byEndpointId(endpointId: string): EndpointItemRequestBuilder; /** * Retrieve a list of endpoint objects. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<EndpointCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-list-endpoints?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<EndpointsRequestBuilderGetQueryParameters> | undefined): Promise<EndpointCollectionResponse | undefined>; /** * Create new navigation property to endpoints for groups * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<Endpoint>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code */ post(body: Endpoint, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Endpoint | undefined>; /** * Retrieve a list of endpoint objects. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<EndpointsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create new navigation property to endpoints for groups * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: Endpoint, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Retrieve a list of endpoint objects. */ export interface EndpointsRequestBuilderGetQueryParameters { /** * 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 EndpointsRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/endpoints{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const EndpointsRequestBuilderNavigationMetadata: Record<Exclude<keyof EndpointsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const EndpointsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map