@microsoft/msgraph-sdk-chats/chats/item/index.d.ts

Chats fluent API for Microsoft Graph

import { type Chat } from '@microsoft/msgraph-sdk/models/index.js';
import { type HideForUserRequestBuilder } from './hideForUser/index.js';
import { type InstalledAppsRequestBuilder } from './installedApps/index.js';
import { type LastMessagePreviewRequestBuilder } from './lastMessagePreview/index.js';
import { type MarkChatReadForUserRequestBuilder } from './markChatReadForUser/index.js';
import { type MarkChatUnreadForUserRequestBuilder } from './markChatUnreadForUser/index.js';
import { type MembersRequestBuilder } from './members/index.js';
import { type MessagesRequestBuilder } from './messages/index.js';
import { type PermissionGrantsRequestBuilder } from './permissionGrants/index.js';
import { type PinnedMessagesRequestBuilder } from './pinnedMessages/index.js';
import { type SendActivityNotificationRequestBuilder } from './sendActivityNotification/index.js';
import { type TabsRequestBuilder } from './tabs/index.js';
import { type UnhideForUserRequestBuilder } from './unhideForUser/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Provides operations to manage the collection of chat entities.
 */
export interface ChatItemRequestBuilder extends BaseRequestBuilder<ChatItemRequestBuilder> {
    /**
     * Provides operations to call the hideForUser method.
     */
    get hideForUser(): HideForUserRequestBuilder;
    /**
     * Provides operations to manage the installedApps property of the microsoft.graph.chat entity.
     */
    get installedApps(): InstalledAppsRequestBuilder;
    /**
     * Provides operations to manage the lastMessagePreview property of the microsoft.graph.chat entity.
     */
    get lastMessagePreview(): LastMessagePreviewRequestBuilder;
    /**
     * Provides operations to call the markChatReadForUser method.
     */
    get markChatReadForUser(): MarkChatReadForUserRequestBuilder;
    /**
     * Provides operations to call the markChatUnreadForUser method.
     */
    get markChatUnreadForUser(): MarkChatUnreadForUserRequestBuilder;
    /**
     * Provides operations to manage the members property of the microsoft.graph.chat entity.
     */
    get members(): MembersRequestBuilder;
    /**
     * Provides operations to manage the messages property of the microsoft.graph.chat entity.
     */
    get messages(): MessagesRequestBuilder;
    /**
     * Provides operations to manage the permissionGrants property of the microsoft.graph.chat entity.
     */
    get permissionGrants(): PermissionGrantsRequestBuilder;
    /**
     * Provides operations to manage the pinnedMessages property of the microsoft.graph.chat entity.
     */
    get pinnedMessages(): PinnedMessagesRequestBuilder;
    /**
     * Provides operations to call the sendActivityNotification method.
     */
    get sendActivityNotification(): SendActivityNotificationRequestBuilder;
    /**
     * Provides operations to manage the tabs property of the microsoft.graph.chat entity.
     */
    get tabs(): TabsRequestBuilder;
    /**
     * Provides operations to call the unhideForUser method.
     */
    get unhideForUser(): UnhideForUserRequestBuilder;
    /**
     * Soft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/chat-delete?view=graph-rest-1.0|Find more info here}
     */
    delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Retrieve a single chat (without its messages). This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Chat>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/chat-get?view=graph-rest-1.0|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<ChatItemRequestBuilderGetQueryParameters> | undefined): Promise<Chat | undefined>;
    /**
     * Update the properties of a chat object.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Chat>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/chat-patch?view=graph-rest-1.0|Find more info here}
     */
    patch(body: Chat, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Chat | undefined>;
    /**
     * Soft-delete a chat. When invoked with delegated permissions, this operation only works for tenant admins and Teams service admins.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
    /**
     * Retrieve a single chat (without its messages). This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<ChatItemRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Update the properties of a chat object.
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPatchRequestInformation(body: Chat, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve a single chat (without its messages). This method supports federation. To access a chat, at least one chat member must belong to the tenant the request initiated from.
 */
export interface ChatItemRequestBuilderGetQueryParameters {
    /**
     * Expand related entities
     */
    expand?: string[];
    /**
     * Select properties to be returned
     */
    select?: string[];
}
/**
 * Uri template for the request builder.
 */
export declare const ChatItemRequestBuilderUriTemplate = "{+baseurl}/chats/{chat%2Did}{?%24expand,%24select}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const ChatItemRequestBuilderNavigationMetadata: Record<Exclude<keyof ChatItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const ChatItemRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map