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

Users fluent API for Microsoft Graph

import { type Chat, type ChatCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type AllMessagesRequestBuilder } from './allMessages/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type GetAllMessagesRequestBuilder } from './getAllMessages/index.js';
import { type GetAllRetainedMessagesRequestBuilder } from './getAllRetainedMessages/index.js';
import { type ChatItemRequestBuilder } 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 chats property of the microsoft.graph.user entity.
 */
export interface ChatsRequestBuilder extends BaseRequestBuilder<ChatsRequestBuilder> {
    /**
     * Provides operations to call the allMessages method.
     */
    get allMessages(): AllMessagesRequestBuilder;
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to call the getAllMessages method.
     */
    get getAllMessages(): GetAllMessagesRequestBuilder;
    /**
     * Provides operations to call the getAllRetainedMessages method.
     */
    get getAllRetainedMessages(): GetAllRetainedMessagesRequestBuilder;
    /**
     * Provides operations to manage the chats property of the microsoft.graph.user entity.
     * @param chatId The unique identifier of chat
     * @returns {ChatItemRequestBuilder}
     */
    byChatId(chatId: string): ChatItemRequestBuilder;
    /**
     * Retrieve the list of chats that the user is part of. This method supports federation. When a user ID is provided, the calling application must belong to the same tenant that the user belongs to.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<ChatCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/chat-list?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<ChatsRequestBuilderGetQueryParameters> | undefined): Promise<ChatCollectionResponse | undefined>;
    /**
     * Create new navigation property to chats for users
     * @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
     */
    post(body: Chat, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Chat | undefined>;
    /**
     * Retrieve the list of chats that the user is part of. This method supports federation. When a user ID is provided, the calling application must belong to the same tenant that the user belongs to.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<ChatsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to chats for users
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: Chat, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve the list of chats that the user is part of. This method supports federation. When a user ID is provided, the calling application must belong to the same tenant that the user belongs to.
 */
export interface ChatsRequestBuilderGetQueryParameters {
    /**
     * 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 ChatsRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/chats{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const ChatsRequestBuilderNavigationMetadata: Record<Exclude<keyof ChatsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const ChatsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map