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

Unofficial SDK for the Evolution Whatsapp API v2

export { AudioMessage, ConnectionUpdatePayload, ContactPayload, ContextInfo, DeviceListMetadata, DisappearingMode, ExtendedTextMessage, ImageMessage, Instance, Message, MessageContent, MessageContextInfo, MessagePayload, MessageUpdate, StickerMessage, WebhookData, WebhookEvent, WebhookEventSetup } from './types/webhooks.js';
import { ApiService } from './api/service.js';
import { ChatsModule } from './modules/chats/index.js';
import { GroupsModule } from './modules/groups/index.js';
import { InstanceModule } from './modules/instance/index.js';
import { MessagesModule } from './modules/messages/index.js';
import { ProfileModule } from './modules/profile/index.js';
import { SettingsModule } from './modules/settings/index.js';
import { WebhookModule } from './modules/webhook/index.js';
import { ClientOptions } from './schemas/client.js';
export { EvolutionApiError } from './api/errors.js';
export { ChatId, GroupJid, Jid, MessageId } from './types/tags.js';
export { phoneNumberFromJid } from './utils/phone-numer-from-jid.js';
export { ArchiveOptions, ArchiveResponse } from './modules/chats/schemas/archive.js';
export { CheckOptions, CheckResponse } from './modules/chats/schemas/check.js';
export { DeleteMessageOptions, DeleteMessageResponse } from './modules/chats/schemas/delete-message.js';
export { FetchProfilePictureOptions, FetchProfilePictureResponse } from './modules/chats/schemas/fetch-profile-picture.js';
export { FindAllChatsResponse } from './modules/chats/schemas/find-all.js';
export { FindContactsOptions, FindContactsResponse } from './modules/chats/schemas/find-contacts.js';
export { FindMessagesOptions, FindMessagesResponse } from './modules/chats/schemas/find-messages.js';
export { FindStatusMessageOptions, FindStatusMessageResponse } from './modules/chats/schemas/find-status-message.js';
export { MarkAsReadOptions, MarkAsReadResponse } from './modules/chats/schemas/mark-as-read.js';
export { PresenceOptions, PresenceParams } from './modules/chats/schemas/presence.js';
export { UpdateMessageOptions, UpdateMessageResponse } from './modules/chats/schemas/update-message.js';
export { AcceptInviteCodeOptions, AcceptInviteCodeResponse } from './modules/groups/schemas/accept-invite-code.js';
export { GroupResponse, GroupWithParticipantsResponse, ParticipantResponse } from './modules/groups/schemas/common.js';
export { CreateGroupOptions, CreateGroupResponse } from './modules/groups/schemas/create.js';
export { FetchInviteCodeOptions, FetchInviteCodeResponse } from './modules/groups/schemas/fetch-invite-code.js';
export { FindAllGroupsResponse, FindAllGroupsWithParticipantsResponse } from './modules/groups/schemas/find-all.js';
export { FindGroupByInviteCodeResponse } from './modules/groups/schemas/find-by-invite-code.js';
export { FindGroupByJidResponse } from './modules/groups/schemas/find-by-jid.js';
export { FindMembersOptions, FindMembersResponse } from './modules/groups/schemas/find-members.js';
export { LeaveOptions, LeaveResponse } from './modules/groups/schemas/leave.js';
export { RevokeInviteCodeOptions, RevokeInviteCodeResponse } from './modules/groups/schemas/revoke-invite-code.js';
export { SendGroupInviteOptions, SendGroupInviteResponse } from './modules/groups/schemas/send-group-invite.js';
export { ToggleEphemeralOptions, ToggleEphemeralResponse } from './modules/groups/schemas/toggle-ephemeral.js';
export { UpdateDescriptionOptions, UpdateDescriptionResponse } from './modules/groups/schemas/update-description.js';
export { UpdateMembersOptions, UpdateMembersResponse } from './modules/groups/schemas/update-members.js';
export { UpdatePictureOptions as UpdateGroupPictureOptions, UpdatePictureResponse as UpdateGroupPictureResponse } from './modules/groups/schemas/update-picture.js';
export { UpdateSettingOptions, UpdateSettingResponse } from './modules/groups/schemas/update-setting.js';
export { UpdateSubjectOptions, UpdateSubjectResponse } from './modules/groups/schemas/update-subject.js';
export { AudioMessageOptions, AudioMessageResponse } from './modules/messages/schemas/audio.js';
export { BaseMessageOptions } from './modules/messages/schemas/base.js';
export { ContactMessageOptions, ContactMessageResponse } from './modules/messages/schemas/contact.js';
export { DocumentMessageOptions, DocumentMessageResponse } from './modules/messages/schemas/document.js';
export { ImageMessageOptions, ImageMessageResponse } from './modules/messages/schemas/image.js';
export { ListMessageOptions, ListMessageResponse } from './modules/messages/schemas/list.js';
export { LocationMessageOptions, LocationMessageResponse } from './modules/messages/schemas/location.js';
export { PollMessageOptions, PollMessageResponse } from './modules/messages/schemas/poll.js';
export { ReactionMessageOptions, ReactionMessageResponse } from './modules/messages/schemas/reaction.js';
export { StatusMessageOptions, StatusMessageResponse } from './modules/messages/schemas/status.js';
export { StickerMessageOptions, StickerMessageResponse } from './modules/messages/schemas/sticker.js';
export { TemplateMessageOptions, TemplateMessageResponse } from './modules/messages/schemas/template.js';
export { TextMessageOptions, TextMessageResponse } from './modules/messages/schemas/text.js';
export { VideoMessageOptions, VideoMessageResponse } from './modules/messages/schemas/video.js';
export { VoiceMessageOptions, VoiceMessageResponse } from './modules/messages/schemas/voice.js';
export { ConnectHash, ConnectInstanceInfo, ConnectOptions, ConnectQRCode, ConnectRequest, ConnectResponse } from './modules/instance/schemas/connect.js';
export { ConnectionStateOptions, ConnectionStateRequest, ConnectionStateResponse } from './modules/instance/schemas/connection-state.js';
export { CreateInstanceRequest, CreateInstanceResponse, InstanceInfo, InstanceSettings, QRCodeInfo, RabbitMQConfig, SQSConfig, WebhookConfig } from './modules/instance/schemas/create.js';
export { DeleteInstanceInfo, DeleteOptions, DeleteRequest, DeleteResponse } from './modules/instance/schemas/delete.js';
export { Count, FetchAllRequest, FetchAllResponse, InstanceDetails, Setting } from './modules/instance/schemas/fetch-all.js';
export { LogoutInstanceInfo, LogoutOptions, LogoutRequest, LogoutResponse } from './modules/instance/schemas/logout.js';
export { RestartOptions, RestartRequest, RestartResponse } from './modules/instance/schemas/restart.js';
export { SetPresenceData, SetPresenceOptions, SetPresenceRequest, SetPresenceResponse } from './modules/instance/schemas/set-presence.js';
export { BusinessHours, BusinessHoursConfig, FetchBusinessProfileOptions, FetchBusinessProfileRequest, FetchBusinessProfileResponse } from './modules/profile/schemas/fetch-business-profile.js';
export { FetchProfileOptions, FetchProfileRequest, FetchProfileResponse, ProfileStatus } from './modules/profile/schemas/fetch-profile.js';
export { FetchPrivacySettingsResponse, PrivacySetting } from './modules/profile/schemas/fetch-privacy-settings.js';
export { RemovePictureResponse } from './modules/profile/schemas/remove-picture.js';
export { UpdateNameOptions, UpdateNameRequest, UpdateNameResponse } from './modules/profile/schemas/update-name.js';
export { UpdatePictureOptions as UpdateProfilePictureOptions, UpdatePictureResponse as UpdateProfilePictureResponse } from './modules/profile/schemas/update-picture.js';
export { UpdatePrivacySettingsOptions, UpdatePrivacySettingsRequest, UpdatePrivacySettingsResponse } from './modules/profile/schemas/update-privacy-settings.js';
export { UpdateStatusOptions, UpdateStatusRequest, UpdateStatusResponse } from './modules/profile/schemas/update-status.js';
export { FindResponse as FindWebhookResponse } from './modules/webhook/schemas/find.js';
export { SetOptions as SetWebhookOptions, SetResponse as SetWebhookResponse } from './modules/webhook/schemas/set.js';
export { FindResponse as FindSettingsResponse } from './modules/settings/schemas/find.js';
export { SetOptions as SetSettingsOptions, SetResponse as SetSettingsResponse } from './modules/settings/schemas/set.js';
export { APIRequestInit, MethodOptions } from './types/api.js';
import './modules/chats/schemas/mark-as-unread.js';
import 'libphonenumber-js';
import './modules/messages/schemas/media.js';
import './schemas/common.js';

declare class EvolutionClient {
    options: ClientOptions;
    /**
     * API service for directly interacting with the Evolution API (no specific typings)
     */
    readonly api: ApiService;
    /**
     * Find and manage chats, send presences and check numbers
     */
    readonly chats: ChatsModule;
    /**
     * Find and manage groups
     */
    readonly groups: GroupsModule;
    /**
     * Send messages
     */
    readonly messages: MessagesModule;
    /**
     * Create and manage instances
     */
    readonly instances: InstanceModule;
    /**
     * Manage profile settings
     */
    readonly profile: ProfileModule;
    /**
     * Manage webhooks
     */
    readonly webhook: WebhookModule;
    /**
     * Manage settings
     */
    readonly settings: SettingsModule;
    /**
     * Evolution Client - API client for interacting with the Evolution API
     * @param options - Client options
     */
    constructor(options: ClientOptions);
    setInstance(instance: string): void;
}

export { ClientOptions, EvolutionClient };