evolution-api-sdk/lib/modules/groups/index.d.mts

Unofficial SDK for the Evolution Whatsapp API v2

import { ApiService } from '../../api/service.mjs';
import { MethodOptions } from '../../types/api.mjs';
import { GroupInviteCode, GroupJid } from '../../types/tags.mjs';
import { AcceptInviteCodeRequest, AcceptInviteCodeResponse } from './schemas/accept-invite-code.mjs';
import { CreateGroupRequest, CreateGroupResponse } from './schemas/create.mjs';
import { FetchInviteCodeRequest, FetchInviteCodeResponse } from './schemas/fetch-invite-code.mjs';
import { FindAllGroupsResponse, FindAllGroupsWithParticipantsResponse } from './schemas/find-all.mjs';
import { FindGroupByInviteCodeResponse } from './schemas/find-by-invite-code.mjs';
import { FindGroupByJidResponse } from './schemas/find-by-jid.mjs';
import { FindMembersRequest, FindMembersResponse } from './schemas/find-members.mjs';
import { LeaveRequest, LeaveResponse } from './schemas/leave.mjs';
import { RevokeInviteCodeRequest, RevokeInviteCodeResponse } from './schemas/revoke-invite-code.mjs';
import { SendGroupInviteRequest, SendGroupInviteResponse } from './schemas/send-group-invite.mjs';
import { ToggleEphemeralRequest, ToggleEphemeralResponse } from './schemas/toggle-ephemeral.mjs';
import { UpdateDescriptionRequest, UpdateDescriptionResponse } from './schemas/update-description.mjs';
import { UpdateMembersRequest, UpdateMembersResponse } from './schemas/update-members.mjs';
import { UpdatePictureRequest, UpdatePictureResponse } from './schemas/update-picture.mjs';
import { UpdateSettingRequest, UpdateSettingResponse } from './schemas/update-setting.mjs';
import { UpdateSubjectRequest, UpdateSubjectResponse } from './schemas/update-subject.mjs';
import '../../schemas/client.mjs';
import './schemas/common.mjs';

declare class GroupsModule {
    private readonly api;
    constructor(api: ApiService);
    /**
     * Gets all groups
     * @param getParticipants - Whether to get participants
     * @param methodOptions - Method-specific options (instance override)
     */
    findAll(getParticipants: false, methodOptions?: MethodOptions): Promise<FindAllGroupsResponse>;
    findAll(getParticipants: true, methodOptions?: MethodOptions): Promise<FindAllGroupsWithParticipantsResponse>;
    /**
     * Gets a group by invite code
     * @param inviteCode - The group invite code (not the URL)
     * @param methodOptions - Method-specific options (instance override)
     */
    findByInviteCode(inviteCode: string | GroupInviteCode, methodOptions?: MethodOptions): Promise<FindGroupByInviteCodeResponse>;
    /**
     * Gets a group by JID
     * @param groupJid - The group JID terminated with \@g.us
     * @param methodOptions - Method-specific options (instance override)
     */
    findByJid(groupJid: string | GroupJid, methodOptions?: MethodOptions): Promise<FindGroupByJidResponse>;
    create(options: CreateGroupRequest, methodOptions?: MethodOptions): Promise<CreateGroupResponse>;
    updatePicture(options: UpdatePictureRequest, methodOptions?: MethodOptions): Promise<UpdatePictureResponse>;
    updateSubject(options: UpdateSubjectRequest, methodOptions?: MethodOptions): Promise<UpdateSubjectResponse>;
    updateDescription(options: UpdateDescriptionRequest, methodOptions?: MethodOptions): Promise<UpdateDescriptionResponse>;
    fetchInviteCode(options: FetchInviteCodeRequest, methodOptions?: MethodOptions): Promise<FetchInviteCodeResponse>;
    acceptInviteCode(options: AcceptInviteCodeRequest, methodOptions?: MethodOptions): Promise<AcceptInviteCodeResponse>;
    revokeInviteCode(options: RevokeInviteCodeRequest, methodOptions?: MethodOptions): Promise<RevokeInviteCodeResponse>;
    sendGroupInvite(options: SendGroupInviteRequest, methodOptions?: MethodOptions): Promise<SendGroupInviteResponse>;
    findMembers(options: FindMembersRequest, methodOptions?: MethodOptions): Promise<FindMembersResponse>;
    updateMembers(options: UpdateMembersRequest, methodOptions?: MethodOptions): Promise<UpdateMembersResponse>;
    updateSetting(options: UpdateSettingRequest, methodOptions?: MethodOptions): Promise<UpdateSettingResponse>;
    toggleEphemeral(options: ToggleEphemeralRequest, methodOptions?: MethodOptions): Promise<ToggleEphemeralResponse>;
    leave(options: LeaveRequest, methodOptions?: MethodOptions): Promise<LeaveResponse>;
}

export { GroupsModule };