UNPKG

@microsoft/msgraph-beta-sdk-groups

Version:
99 lines 5.14 kB
import { type Conversation, type ConversationCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type CountRequestBuilder } from './count/index.js'; import { type ConversationItemRequestBuilder } 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 conversations property of the microsoft.graph.group entity. */ export interface ConversationsRequestBuilder extends BaseRequestBuilder<ConversationsRequestBuilder> { /** * Provides operations to count the resources in the collection. */ get count(): CountRequestBuilder; /** * Provides operations to manage the conversations property of the microsoft.graph.group entity. * @param conversationId The unique identifier of conversation * @returns {ConversationItemRequestBuilder} */ byConversationId(conversationId: string): ConversationItemRequestBuilder; /** * Retrieve the list of conversations in this group. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<ConversationCollectionResponse>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-list-conversations?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<ConversationsRequestBuilderGetQueryParameters> | undefined): Promise<ConversationCollectionResponse | undefined>; /** * Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<Conversation>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/opentypeextension-post-opentypeextension?view=graph-rest-beta|Find more info here} */ post(body: Conversation, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Conversation | undefined>; /** * Retrieve the list of conversations in this group. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<ConversationsRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create an open extension (openTypeExtension object) and add custom properties in a new or existing instance of a resource. You can create an open extension in a resource instance and store custom data to it all in the same operation, except for specific resources. The table in the Permissions section lists the resources that support open extensions. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: Conversation, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Retrieve the list of conversations in this group. */ export interface ConversationsRequestBuilderGetQueryParameters { /** * 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 ConversationsRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}/conversations{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const ConversationsRequestBuilderNavigationMetadata: Record<Exclude<keyof ConversationsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const ConversationsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map