evolution-api-sdk/lib/modules/chats/index.d.ts

Unofficial SDK for the Evolution Whatsapp API v2

import { ApiService } from '../../api/service.js';
import { MethodOptions } from '../../types/api.js';
import { ArchiveRequest, ArchiveResponse } from './schemas/archive.js';
import { CheckOptions, CheckResponse } from './schemas/check.js';
import { DeleteMessageRequest, DeleteMessageResponse } from './schemas/delete-message.js';
import { FetchProfilePictureRequest, FetchProfilePictureResponse } from './schemas/fetch-profile-picture.js';
import { FindAllChatsResponse } from './schemas/find-all.js';
import { FindContactsRequest, FindContactsResponse } from './schemas/find-contacts.js';
import { FindMessagesRequest, FindMessagesResponse } from './schemas/find-messages.js';
import { FindStatusMessageRequest, FindStatusMessageResponse } from './schemas/find-status-message.js';
import { MarkAsReadRequest, MarkAsReadResponse } from './schemas/mark-as-read.js';
import { MarkAsUnreadRequest, MarkAsUnreadResponse } from './schemas/mark-as-unread.js';
import { PresenceOptions } from './schemas/presence.js';
import { UpdateMessageRequest, UpdateMessageResponse } from './schemas/update-message.js';
import '../../schemas/client.js';
import '../../types/tags.js';
import '../../types/webhooks.js';

declare class ChatsModule {
    private readonly api;
    constructor(api: ApiService);
    /**
     * Checks if phone numbers are registered on WhatsApp
     * @param numbers - Array of phone numbers to check
     * @param methodOptions - Method-specific options (instance override)
     */
    check(numbers: CheckOptions, methodOptions?: MethodOptions): Promise<CheckResponse>;
    /**
     * Gets all chats
     * @param methodOptions - Method-specific options (instance override)
     */
    findAll(methodOptions?: MethodOptions): Promise<FindAllChatsResponse>;
    /**
     * Updates presence status
     * @param params - Presence parameters
     * @param methodOptions - Method-specific options (instance override)
     */
    updatePresence(options: PresenceOptions, methodOptions?: MethodOptions): Promise<void>;
    /**
     * Marks messages as read
     * @param options - Mark as read options
     * @param methodOptions - Method-specific options (instance override)
     */
    markAsRead(options: MarkAsReadRequest, methodOptions?: MethodOptions): Promise<MarkAsReadResponse>;
    /**
     * Marks messages as unread
     * @param options - Mark as unread options
     * @param methodOptions - Method-specific options (instance override)
     */
    markAsUnread(options: MarkAsUnreadRequest, methodOptions?: MethodOptions): Promise<MarkAsUnreadResponse>;
    /**
     * Archives a chat
     * @param options - Archive options
     * @param methodOptions - Method-specific options (instance override)
     */
    archive(options: ArchiveRequest, methodOptions?: MethodOptions): Promise<ArchiveResponse>;
    /**
     * Deletes a message
     * @param options - Delete message options
     * @param methodOptions - Method-specific options (instance override)
     */
    deleteMessage(options: DeleteMessageRequest, methodOptions?: MethodOptions): Promise<DeleteMessageResponse>;
    /**
     * Fetches profile picture
     * @param options - Fetch profile picture options
     * @param methodOptions - Method-specific options (instance override)
     */
    fetchProfilePicture(options: FetchProfilePictureRequest, methodOptions?: MethodOptions): Promise<FetchProfilePictureResponse>;
    /**
     * Finds contacts
     * @param options - Find contacts options
     * @param methodOptions - Method-specific options (instance override)
     */
    findContacts(options: FindContactsRequest, methodOptions?: MethodOptions): Promise<FindContactsResponse>;
    /**
     * Finds messages
     * @param options - Find messages options
     * @param methodOptions - Method-specific options (instance override)
     */
    findMessages(options: FindMessagesRequest, methodOptions?: MethodOptions): Promise<FindMessagesResponse>;
    /**
     * Finds status messages
     * @param options - Find status message options
     * @param methodOptions - Method-specific options (instance override)
     */
    findStatusMessage(options: FindStatusMessageRequest, methodOptions?: MethodOptions): Promise<FindStatusMessageResponse>;
    /**
     * Updates a message
     * @param options - Update message options
     * @param methodOptions - Method-specific options (instance override)
     */
    updateMessage(options: UpdateMessageRequest, methodOptions?: MethodOptions): Promise<UpdateMessageResponse>;
}

export { ChatsModule };