@open-wa/wa-automate 4.76.0 → 5.0.0-alpha.2

package/dist/api/Client.d.ts

@@ -1,2255 +0,0 @@
-/// <reference types="node" />
-import { Page } from 'puppeteer';
-import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatCreationResponse, EphemeralDuration } from './model/chat';
-import { BusinessProfile, Contact, NumberCheck } from './model/contact';
-import { Message, MessageInfo, MessagePinDuration, PollData } from './model/message';
-import { AxiosRequestConfig } from 'axios';
-import { NewCommunityGroup, ParticipantChangedEventModel, GenericGroupChangeEvent, GroupMetadata } from './model/group-metadata';
-import { ConfigObject, STATE, LicenseType, Webhook, EventPayload } from './model';
-import PQueue, { DefaultAddOptions, Options } from 'p-queue';
-import { HealthCheck, SessionInfo } from './model/sessionInfo';
-import { ChatId, GroupChatId, Content, Base64, MessageId, ContactId, DataURL, AdvancedFile, GroupId } from './model/aliases';
-import { CustomProduct, Order, Product } from './model/product';
-import { Label } from './model/label';
-import { Mp4StickerConversionProcessOptions, StickerMetadata } from './model/media';
-import { SimpleListener } from './model/events';
-import { AwaitMessagesOptions, Collection, CollectorFilter, CollectorOptions } from '../structures/Collector';
-import { MessageCollector } from '../structures/MessageCollector';
-import { Listener } from 'eventemitter2';
-import PriorityQueue from 'p-queue/dist/priority-queue';
-import { NextFunction, Request, Response } from 'express';
-import { Call } from './model/call';
-import { AdvancedButton, Button, LocationButtonBody, Section } from './model/button';
-import { JsonObject } from 'type-fest';
-import { ReactionEvent } from './model/reactions';
-export declare enum namespace {
-    Chat = "Chat",
-    Msg = "Msg",
-    Contact = "Contact",
-    GroupMetadata = "GroupMetadata"
-}
-export declare class Client {
-    private _loadedModules;
-    private _registeredWebhooks;
-    private _registeredEvListeners;
-    private _webhookQueue;
-    private _createConfig;
-    private _sessionInfo;
-    private _listeners;
-    private _page;
-    private _currentlyBeingKilled;
-    private _refreshing;
-    private _loaded;
-    private _hostAccountNumber;
-    private _prio;
-    private _pageListeners;
-    private _registeredPageListeners;
-    private _onLogoutCallbacks;
-    private _queues;
-    private _autoEmojiSet;
-    private _autoEmojiQ;
-    private _onLogoutSet;
-    private _preprocIdempotencyCheck;
-    /**
-     * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
-     * For this reason, listeners assigned to a webhook are only set once and map through all possible webhooks to and fire only if the specific listener is assigned.
-     *
-     * Note: This would be much simpler if eventMode was the default (and only) listener strategy.
-     */
-    private _registeredWebhookListeners;
-    /**
-     * @ignore
-     * @param page [Page] [Puppeteer Page]{@link https://pptr.dev/#?product=Puppeteer&version=v2.1.1&show=api-class-page} running WA Web
-     */
-    constructor(page: Page, createConfig: ConfigObject, sessionInfo: SessionInfo);
-    /**
-     * @private
-     *
-     * DO NOT USE THIS.
-     *
-     * Run all tasks to set up client AFTER init is fully completed
-     */
-    loaded(): Promise<void>;
-    private registerAllSimpleListenersOnEv;
-    getSessionId(): string;
-    getPage(): Page;
-    private _setOnClose;
-    private _reInjectWapi;
-    private _reRegisterListeners;
-    /**
-     * A convinience method to download the [[DataURL]] of a file
-     * @param url The url
-     * @param optionsOverride You can use this to override the [axios request config](https://github.com/axios/axios#request-config)
-     * @returns `Promise<DataURL>`
-     */
-    download(url: string, optionsOverride?: any): Promise<DataURL>;
-    /**
-     * Grab the logger for this session/process
-     */
-    logger(): any;
-    /**
-     * Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory
-     * This will attempt to re register all listeners EXCEPT onLiveLocation and onParticipantChanged
-     */
-    refresh(): Promise<boolean>;
-    /**
-     * Get the session info
-     *
-     * @returns SessionInfo
-     */
-    getSessionInfo(): SessionInfo;
-    /**
-     * Easily resize page on the fly. Useful if you're showing screenshots in a web-app.
-     */
-    resizePage(width?: number, height?: number): Promise<boolean>;
-    /**
-     * Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed
-     *
-     * @returns SessionInfo
-     */
-    getConfig(): ConfigObject;
-    private pup;
-    private responseWrap;
-    /**
-     * ////////////////////////  LISTENERS
-     */
-    removeListener(listener: SimpleListener): boolean;
-    removeAllListeners(): boolean;
-    /**
-     *
-     */
-    private registerListener;
-    private registerPageEventListener;
-    /**
-     * It calls the JavaScript garbage collector
-     * @returns Nothing.
-     */
-    gc(): Promise<void>;
-    /**
-     * Listens to a log out event
-     *
-     * @event
-     * @param fn callback
-     * @param priority A priority of -1 will mean the callback will be triggered after all the non -1 callbacks
-     * @fires `true`
-     */
-    onLogout(fn: (loggedOut?: boolean) => any, priority?: number): Promise<boolean>;
-    /**
-     * Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.
-     */
-    waitWhQIdle(): Promise<true | void>;
-    /**
-     * Wait for all queues to be empty
-     */
-    waitAllQEmpty(): Promise<true | void[]>;
-    /**
-     * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
-     */
-    getListenerQueues(): {
-        [key in SimpleListener]?: PQueue;
-    };
-    private preprocessMessage;
-    /**
-     * Listens to incoming messages
-     *
-     * @event
-     * @param fn callback
-     * @param queueOptions PQueue options. Set to `{}` for default PQueue.
-     * @fires [[Message]]
-     */
-    onMessage(fn: (message: Message) => void, queueOptions?: Options<PriorityQueue, DefaultAddOptions>): Promise<Listener | boolean>;
-    /**
-    * Listens to all new messages
-    *
-    * @event
-    * @param fn callback
-    * @param queueOptions PQueue options. Set to `{}` for default PQueue.
-    * @fires [[Message]]
-    */
-    onAnyMessage(fn: (message: Message) => void, queueOptions?: Options<PriorityQueue, DefaultAddOptions>): Promise<Listener | boolean>;
-    /**
-     *
-     * Listens to when a message is deleted by a recipient or the host account
-     * @event
-     * @param fn callback
-     * @fires [[Message]]
-     */
-    onMessageDeleted(fn: (message: Message) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to when a chat is deleted by the host account
-     * @event
-     * @param fn callback
-     * @fires [[Chat]]
-     */
-    onChatDeleted(fn: (chat: Chat) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to button message responses
-     * @event
-     * @param fn callback
-     * @fires [[Message]]
-     */
-    onButton(fn: (message: Message) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to poll vote events
-     * @event
-     * @param fn callback
-     * @fires [[PollData]]
-     */
-    onPollVote(fn: (pollDate: PollData) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to broadcast messages
-     * @event
-     * @param fn callback
-     * @fires [[Message]]
-     */
-    onBroadcast(fn: (message: Message) => void): Promise<Listener | boolean>;
-    /**
-     * @deprecated
-     *
-     * Listens to battery changes
-     *
-     * :::caution
-     *
-     *  This will most likely not work with multi-device mode (the only remaining mode) since the session is no longer connected to the phone but directly to WA servers.
-     *
-     * :::
-     *
-     * @event
-     * @param fn callback
-     * @fires number
-     */
-    onBattery(fn: (battery: number) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to when host device is plugged/unplugged
-     * @event
-     *
-     * @param fn callback
-     * @fires boolean true if plugged, false if unplugged
-     */
-    onPlugged(fn: (plugged: boolean) => void): Promise<Listener | boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Listens to when a contact posts a new story.
-     * @event
-     *
-     * @param fn callback
-     * @fires e.g
-     *
-     * ```javascript
-     * {
-     * from: '123456789@c.us'
-     * id: 'false_132234234234234@status.broadcast'
-     * }
-     * ```
-     */
-    onStory(fn: (story: Message) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to changes in state
-     *
-     * @event
-     * @fires STATE observable sream of states
-     */
-    onStateChanged(fn: (state: STATE) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to new incoming calls
-     * @event
-     * @returns Observable stream of call request objects
-     */
-    onIncomingCall(fn: (call: Call) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to changes on call state
-     * @event
-     * @returns Observable stream of call objects
-     */
-    onCallState(fn: (call: Call) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to label change events
-     *
-     * @event
-     * @param fn callback
-     * @fires [[Label]]
-     */
-    onLabel(fn: (label: Label) => void): Promise<Listener | boolean>;
-    /**
-     *{@license:insiders@}
-     *
-     * Listens to new orders. Only works on business accounts
-     */
-    onOrder(fn: (order: Order) => void): Promise<Listener | boolean>;
-    /**
-     *{@license:insiders@}
-     *
-     * Listens to new orders. Only works on business accounts
-     */
-    onNewProduct(fn: (product: Product) => void): Promise<Listener | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Listens to reaction add and change events
-     *
-     * @event
-     * @param fn callback
-     * @fires [[ReactionEvent]]
-     */
-    onReaction(fn: (reactionEvent: ReactionEvent) => void): Promise<Listener | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Listens to chat state, including when a specific user is recording and typing within a group chat.
-     *
-     * @event
-     *
-     * Here is an example of the fired object:
-     *
-     * @fires
-     * ```javascript
-     * {
-     * "chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring
-     * "user": "22222222222@c.us", //the user that is causing this state
-     * "state": "composing, //can also be 'available', 'unavailable', 'recording' or 'composing'
-     * }
-     * ```
-     */
-    onChatState(fn: (chatState: ChatState) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to messages acknowledgement Changes
-     *
-     * @param fn callback function that handles a [[Message]] as the first and only parameter.
-     * @event
-     * @returns `true` if the callback was registered
-     */
-    onAck(fn: (message: Message) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to add and remove events on Groups on a global level. It is memory efficient and doesn't require a specific group id to listen to.
-     *
-     * @event
-     * @param fn callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onGlobalParticipantsChanged(fn: (participantChangedEvent: ParticipantChangedEventModel) => void): Promise<Listener | boolean>;
-    /**
-     * Listents to group approval requests. Emits a message object. Use it with `message.isGroupApprovalRequest()` to check if it is a group approval request.
-     *
-     * @event
-     * @param fn callback function that handles a [[Message]] as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onGroupApprovalRequest(fn: (groupApprovalRequestMessage: Message) => void): Promise<Listener | boolean>;
-    /**
-     * Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.
-     *
-     * @event
-     * @param fn callback function that handles a [[ParticipantChangedEventModel]] as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onGroupChange(fn: (genericGroupChangeEvent: GenericGroupChangeEvent) => void): Promise<Listener | boolean>;
-    /**
-     * Fires callback with Chat object every time the host phone is added to a group.
-     *
-     * @event
-     * @param fn callback function that handles a [[Chat]] (group chat) as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onAddedToGroup(fn: (chat: Chat) => any): Promise<Listener | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Fires callback with Chat object every time the host phone is removed to a group.
-     *
-     * @event
-     * @param fn callback function that handles a [[Chat]] (group chat) as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onRemovedFromGroup(fn: (chat: Chat) => any): Promise<Listener | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode.
-     *
-     * @event
-     * @param fn callback function that handles a [[ChatId]] as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onChatOpened(fn: (chat: Chat) => any): Promise<Listener | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Fires callback with contact id when a new contact is added on the host phone.
-     *
-     * @event
-     * @param fn callback function that handles a [[Chat]] as the first and only parameter.
-     * @returns `true` if the callback was registered
-     */
-    onContactAdded(fn: (chat: Chat) => any): Promise<Listener | boolean>;
-    /**
-     * @event
-     * Listens to add and remove events on Groups. This can no longer determine who commited the action and only reports the following events add, remove, promote, demote
-     * @param groupId group id: xxxxx-yyyy@c.us
-     * @param fn callback
-     * @returns Observable stream of participantChangedEvent
-     */
-    onParticipantsChanged(groupId: GroupChatId, fn: (participantChangedEvent: ParticipantChangedEventModel) => void, legacy?: boolean): Promise<Listener | boolean>;
-    /**
-     * @event Listens to live locations from a chat that already has valid live locations
-     * @param chatId the chat from which you want to subscribes to live location updates
-     * @param fn callback that takes in a LiveLocationChangedEvent
-     * @returns boolean, if returns false then there were no valid live locations in the chat of chatId
-     * @emits `<LiveLocationChangedEvent>` LiveLocationChangedEvent
-     */
-    onLiveLocation(chatId: ChatId, fn: (liveLocationChangedEvent: LiveLocationChangedEvent) => void): Promise<boolean>;
-    /**
-     * Use this simple command to test firing callback events.
-     *
-     * @param callbackToTest
-     * @param testData
-     * @returns `false` if the callback was not registered/does not exist
-     */
-    testCallback(callbackToTest: SimpleListener, testData: any): Promise<boolean>;
-    /**
-     * Set presence to available or unavailable.
-     * @param available if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);
-     */
-    setPresence(available: boolean): Promise<boolean | void>;
-    /**
-     * set your about me
-     * @param newStatus String new profile status
-     */
-    setMyStatus(newStatus: string): Promise<boolean | void>;
-    /**
-     * {@license:insiders@}
-     *
-     * Adds label from chat, message or contact. Only for business accounts.
-     * @param label: The desired text of the new label. id will be something simple like anhy nnumber from 1-10, name is the label of the label if that makes sense.
-     * @returns `false` if something went wrong, or the id (usually a number as a string) of the new label (for example `"58"`)
-     */
-    createLabel(label: string): Promise<string | boolean>;
-    /**
-     * Adds label from chat, message or contact. Only for business accounts.
-     * @param label: either the id or the name of the label. id will be something simple like anhy nnumber from 1-10, name is the label of the label if that makes sense.
-     * @param id The Chat, message or contact id to which you want to add a label
-     */
-    addLabel(label: string, chatId: ChatId): Promise<boolean>;
-    /**
-     * Returns all labels and the corresponding tagged items.
-     */
-    getAllLabels(): Promise<Label[]>;
-    /**
-     * Removes label from chat, message or contact. Only for business accounts.
-     * @param label: either the id or the name of the label. id will be something simple like anhy nnumber from 1-10, name is the label of the label if that makes sense.
-     * @param id The Chat, message or contact id to which you want to add a label
-     */
-    removeLabel(label: string, chatId: ChatId): Promise<boolean>;
-    /**
-     * Get an array of chats that match the label parameter. For example, if you want to get an array of chat objects that have the label "New customer".
-     *
-     * This method is case insenstive and only works on business host accounts.
-     *
-     * @label The label name
-     */
-    getChatsByLabel(label: string): Promise<Chat[]>;
-    /**
-     * Send VCARD
-     *
-     * @param {string} chatId '000000000000@c.us'
-     * @param {string} vcard vcard as a string, you can send multiple contacts vcard also.
-     * @param {string} contactName The display name for the contact. Ignored on multiple vcards
-     * @param {string} contactNumber If supplied, this will be injected into the vcard (VERSION 3 ONLY FROM VCARDJS) with the WA id to make it show up with the correct buttons on WA. The format of this param should be including country code, without any other formating. e.g:
-     * `4477777777777`
-     *  Ignored on multiple vcards
-     */
-    sendVCard(chatId: ChatId, vcard: string, contactName?: string, contactNumber?: string): Promise<boolean>;
-    /**
-     * Set your profile name
-     *
-     * Please note, this does not work on business accounts!
-     *
-     * @param newName String new name to set for your profile
-     */
-    setMyName(newName: string): Promise<boolean>;
-    /**
-     * Sets the chat state
-     * @param {ChatState|0|1|2} chatState The state you want to set for the chat. Can be TYPING (0), RECRDING (1) or PAUSED (2).
-     * @param {String} chatId
-     */
-    setChatState(chatState: ChatState, chatId: ChatId): Promise<boolean>;
-    /**
-     * Returns the connection state
-     */
-    getConnectionState(): Promise<STATE>;
-    /**
-     * Retreive an array of messages that are not yet sent to the recipient via the host account device (i.e no ticks)
-     */
-    getUnsentMessages(): Promise<Message[]>;
-    /**
-     * Forces the session to update the connection state.
-     * @param killBeforeAttemptingToReconnect Setting this to true will force the session to drop the current socket connection before attempting to reconnect. This is useful if you want to force the session to reconnect immediately.
-     * @returns updated connection state
-     */
-    forceUpdateConnectionState(killBeforeReconnect?: boolean): Promise<STATE>;
-    /**
-     * Returns a list of contact with whom the host number has an existing chat who are also not contacts.
-     */
-    getChatWithNonContacts(): Promise<Contact[]>;
-    /**
-     * Shuts down the page and browser
-     * @returns true
-     */
-    kill(reason?: string): Promise<boolean>;
-    /**
-     * This is a convinient method to click the `Use Here` button in the WA web session.
-     *
-     * Use this when [[STATE]] is `CONFLICT`. You can read more about managing state here:
-     *
-     * [[Detecting Logouts]]
-     */
-    forceRefocus(): Promise<boolean>;
-    /**
-     * Check if the "Phone not Cconnected" message is showing in the browser. If it is showing, then this will return `true`.
-     *
-     * @returns `boolean`
-     */
-    isPhoneDisconnected(): Promise<boolean>;
-    /**
-     * Runs a health check to help you determine if/when is an appropiate time to restart/refresh the session.
-     */
-    healthCheck(): Promise<HealthCheck>;
-    /**
-     * Get the stats of the current process and the corresponding browser process.
-     */
-    getProcessStats(): Promise<any>;
-    /**
-     * A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.
-     * Please note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation).
-     * @param chatId string Id of the chat you want to force the phone to get the livelocation data for.
-     * @returns `Promise<LiveLocationChangedEvent []>` | boolean
-     */
-    forceUpdateLiveLocation(chatId: ChatId): Promise<LiveLocationChangedEvent[] | boolean>;
-    /**
-     *
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
-     *
-     * :::
-     *
-     * Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658
-     */
-    testButtons(chatId: ChatId): Promise<any>;
-    private link;
-    /**
-     * Generate a license link
-     */
-    getLicenseLink(params?: string): Promise<string>;
-    /**
-     *
-     * {@license:restricted@}
-     *
-     * Sends a text message to given chat
-     *
-     * A license is **NOT** required to send messages with existing chats/contacts. A license is only required for starting conversations with new numbers.
-     *
-     * @param to chat id: `xxxxx@c.us`
-     * @param content text message
-     */
-    sendText(to: ChatId, content: Content): Promise<boolean | MessageId>;
-    /**
-     * Sends a text message to given chat that includes mentions.
-     * In order to use this method correctly you will need to send the text like this:
-     * "@4474747474747 how are you?"
-     * Basically, add a @ symbol before the number of the contact you want to mention.
-     *
-     * @param to chat id: `xxxxx@c.us`
-     * @param content text message
-     * @param hideTags Removes all tags within the message
-     * @param mentions You can optionally add an array of contact IDs to tag only specific people
-     */
-    sendTextWithMentions(to: ChatId, content: Content, hideTags?: boolean, mentions?: ContactId[]): Promise<boolean | MessageId>;
-    /**
-     * NOTE: This is experimental, most accounts do not have access to this feature in their apps.
-     *
-     * Edit an existing message
-     *
-     * @param messageId The message ID to edit
-     * @param text The new text content
-     * @returns
-     */
-    editMessage(messageId: MessageId, text: Content): Promise<boolean | MessageId>;
-    /**
-     * [UNTESTED - REQUIRES FEEDBACK]
-     * Sends a payment request message to given chat
-     *
-     * @param to chat id: `xxxxx@c.us`
-     * @param amount number the amount to request in 1000 format (e.g £10 => 10000)
-     * @param currency string The 3 letter currency code
-     * @param message string optional message to send with the payment request
-     */
-    sendPaymentRequest(to: ChatId, amount: number, currency: string, message?: string): Promise<boolean | MessageId>;
-    /**
-     *
-     * @deprecated
-     *
-     * :::danger
-     *
-     * WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.
-     * THIS IS NOT WORKING FOR GROUPS YET.
-     *
-     * BUTTONS ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.
-     *
-     * :::
-     *
-     * Send generic quick reply buttons. This is an insiders feature for MD accounts.
-     *
-     * @param  {ChatId} to chat id
-     * @param  {string | LocationButtonBody} body The body of the buttons message
-     * @param  {Button[]} buttons Array of buttons - limit is 3!
-     * @param  {string} title The title/header of the buttons message
-     * @param  {string} footer The footer of the buttons message
-     */
-    sendButtons(to: ChatId, body: string | LocationButtonBody, buttons: Button[], title?: string, footer?: string): Promise<boolean | MessageId>;
-    /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.
-     * WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.
-     *
-     * THIS IS NOT WORKING FOR GROUPS YET.
-     *
-     * ADVANCED ARE DEPRECATED FOR NOW. DO NOT GET A LICENSE TO USE BUTTONS.
-     *
-     * :::
-     *
-     *
-     * Send advanced buttons with media body. This is an insiders feature for MD accounts.
-     *
-     * Body can be location, image, video or document. Buttons can be quick reply, url or call buttons.
-     *
-     * @param  {ChatId} to chat id
-     * @param  {string | LocationButtonBody} body The body of the buttons message
-     * @param  {AdvancedButton[]} buttons Array of buttons - limit is 3!
-     * @param  {string} title The title/header of the buttons message
-     * @param  {string} footer The footer of the buttons message
-     * @param  {string} filename Required if body is a file!!
-     */
-    sendAdvancedButtons(to: ChatId, body: string | LocationButtonBody, buttons: AdvancedButton[], text: string, footer: string, filename: string): Promise<boolean | MessageId>;
-    /**
-     * Send a banner image
-     *
-     * Note this is a bit of hack on top of a location message. During testing it is shown to not work on iPhones.
-     *
-     * @param  {ChatId} to
-     * @param  {Base64} base64 base64 encoded jpeg
-     */
-    sendBanner(to: ChatId, base64: Base64): Promise<boolean | MessageId>;
-    /**
-     *
-     * @deprecated
-     *
-     * :::danger
-     *
-     * It is not currently possible to send a listmessage to a group chat. This is a WA limitation.
-     * Please DO NOT get a license solely for access to list messages in group chats.
-     *
-     * LIST MESSAGES ARE DEPRECATED TILL FURTHER NOTICE
-     *
-     * :::
-     *
-     * Send a list message. This will not work when being sent from business accounts!
-     *
-     * @param  {ChatId} to
-     * @param  {Section[]} sections The Sections of rows for the list message
-     * @param  {string} title The title of the list message
-     * @param  {string} description The description of the list message
-     * @param  {string} actionText The action text of the list message
-     */
-    sendListMessage(to: ChatId, sections: Section[], title: string, description: string, actionText: string): Promise<boolean | MessageId>;
-    /**
-     * Sends a reply to given chat that includes mentions, replying to the provided replyMessageId.
-     * In order to use this method correctly you will need to send the text like this:
-     * "@4474747474747 how are you?"
-     * Basically, add a @ symbol before the number of the contact you want to mention.
-     * @param to chat id: `xxxxx@c.us`
-     * @param content text message
-     * @param replyMessageId id of message to reply to
-     * @param hideTags Removes all tags within the message
-     * @param mentions You can optionally add an array of contact IDs to tag only specific people
-     */
-    sendReplyWithMentions(to: ChatId, content: Content, replyMessageId: MessageId, hideTags?: boolean, mentions?: ContactId[]): Promise<boolean | MessageId>;
-    /**
-     * {@license:insiders@}
-     *
-     * Tags everyone in the group with a message
-     *
-     * @param groupId group chat id: `xxxxx@g.us`
-     * @param content text message to add under all of the tags
-     * @param hideTags Removes all tags within the message
-     * @param formatting The formatting of the tags. Use @mention to indicate the actual tag. @default `@mention `
-     * @param messageBeforeTags set to `true` to show the message before all of the tags
-     * @returns `Promise<MessageId>`
-     */
-    tagEveryone(groupId: GroupChatId, content: Content, hideTags?: boolean, formatting?: string, messageBeforeTags?: boolean): Promise<boolean | MessageId>;
-    /**
-     * Sends a link to a chat that includes a link preview.
-     * @param thumb The base 64 data of the image you want to use as the thunbnail. This should be no more than 200x200px. Note: Dont need data url on this param
-     * @param url The link you want to send
-     * @param title The title of the link
-     * @param description The long description of the link preview
-     * @param text The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
-     * @param chatId The chat you want to send this message to.
-     * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail
-     */
-    sendMessageWithThumb(thumb: string, url: string, title: string, description: string, text: Content, chatId: ChatId, quotedMsgId?: MessageId, customSize?: {
-        height: number;
-        width: number;
-    }): Promise<MessageId | boolean>;
-    /**
-     * Note: `address` and `url` are parameters available to insiders only.
-     *
-     * Sends a location message to given chat
-     * @param to chat id: `xxxxx@c.us`
-     * @param lat latitude: '51.5074'
-     * @param lng longitude: '0.1278'
-     * @param loc location text: 'LONDON!'
-     * @param address address text: '1 Regents Park!'
-     * @param url address text link: 'https://example.com'
-     */
-    sendLocation(to: ChatId, lat: string, lng: string, loc: string, address?: string, url?: string): Promise<boolean | MessageId>;
-    /**
-     * Get the generated user agent, this is so you can send it to the decryption module.
-     * @returns String useragent of wa-web session
-     */
-    getGeneratedUserAgent(userA?: string): Promise<string>;
-    /**
-     * Decrypts a media message.
-     * @param message This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID.
-     * @returns `Promise<[[DataURL]]>`
-     */
-    decryptMedia(message: Message | MessageId): Promise<DataURL>;
-    /**
-     * Sends a image to given chat, with caption or not, using base64
-     * @param to chat id `xxxxx@c.us`
-     * @param file DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with `./` or `../`) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] `https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg`).
-     * @param filename string xxxxx
-     * @param caption string xxxxx
-     * @param waitForKey boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
-     * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
-     * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
-     */
-    sendImage(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean, requestConfig?: any): Promise<MessageId | boolean>;
-    /**
-     * Automatically sends a youtube link with the auto generated link preview. You can also add a custom message.
-     * @param chatId
-     * @param url string A youtube link.
-     * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
-     * @param thumbnail string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
-     * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail
-     */
-    sendYoutubeLink(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
-        height: number;
-        width: number;
-    }): Promise<boolean | MessageId>;
-    /**
-     * Automatically sends a link with the auto generated link preview. You can also add a custom message.
-     * @param chatId
-     * @param url string A link.
-     * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
-     * @param thumbnail Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
-     * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail
-     */
-    sendLinkWithAutoPreview(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
-        height: number;
-        width: number;
-    }): Promise<boolean | MessageId>;
-    /**
-     *
-     * Sends a reply to a given message. Please note, you need to have at least sent one normal message to a contact in order for this to work properly.
-     *
-     * @param to string chatid
-     * @param content string reply text
-     * @param quotedMsgId string the msg id to reply to.
-     * @param sendSeen boolean If set to true, the chat will 'blue tick' all messages before sending the reply
-     * @returns `Promise<MessageId | false>` false if didn't work, otherwise returns message id.
-     */
-    reply(to: ChatId, content: Content, quotedMsgId: MessageId, sendSeen?: boolean): Promise<boolean | MessageId>;
-    /**
-     * {@license:insiders@}
-     *
-     * Check if a recipient has read receipts on.
-     *
-     * This will only work if you have chats sent back and forth between you and the contact 1-1.
-     *
-     * @param contactId The Id of the contact with which you have an existing conversation with messages already.
-     * @returns `Promise<string | boolean>` true or false or a string with an explaintaion of why it wasn't able to determine the read receipts.
-     *
-     */
-    checkReadReceipts(contactId: ContactId): Promise<string | boolean>;
-    /**
-     * Sends a file to given chat, with caption or not, using base64. This is exactly the same as sendImage
-     *
-     * Please note that any file that resolves to mime-type `octet-stream` will, by default, resolve to an MP4 file.
-     *
-     * If you want a specific filetype, then explcitly select the correct mime-type from https://www.iana.org/assignments/media-types/media-types.xhtml
-     *
-     *
-     * @param to chat id `xxxxx@c.us`
-     * @param file DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with `./` or `../`) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] `https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg`).
-     * @param filename string xxxxx
-     * @param caption string xxxxx With an [INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program) you can also tag people in groups with `@[number]`. For example if you want to mention the user with the number `44771234567`, just add `@44771234567` in the caption.
-     * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     * @param waitForId boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
-     * @param ptt boolean default: false set this to true if you want to send the file as a push to talk file.
-     * @param withoutPreview boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.
-     * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
-     * @returns `Promise <boolean | MessageId>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
-     */
-    sendFile(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean, requestConfig?: any): Promise<MessageId | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Checks whether or not the group id provided is known to be unsafe by the contributors of the library.
-     * @param groupChatId The group chat you want to deteremine is unsafe
-     * @returns `Promise <boolean | string>` This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string
-     */
-    isGroupIdUnsafe(groupChatId: GroupChatId): Promise<string | boolean>;
-    /**
-     * Attempts to send a file as a voice note. Useful if you want to send an mp3 file.
-     * @param to chat id `xxxxx@c.us`
-     * @param file base64 data:image/xxx;base64,xxx or the path of the file you want to send.
-     * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
-     */
-    sendPtt(to: ChatId, file: AdvancedFile, quotedMsgId?: MessageId): Promise<MessageId>;
-    /**
-     * Send an audio file with the default audio player (not PTT/voice message)
-     * @param to chat id `xxxxx@c.us`
-     * @param base64 base64 data:image/xxx;base64,xxx or the path of the file you want to send.
-     * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     */
-    sendAudio(to: ChatId, file: AdvancedFile, quotedMsgId?: MessageId): Promise<MessageId>;
-    /**
-     * Send a poll to a group chat
-     * @param to chat id - a group chat is required
-     * @param name the name of the poll
-     * @param options an array of poll options
-     * @param quotedMsgId A message to quote when sending the poll
-     * @param allowMultiSelect Whether or not to allow multiple selections. default false
-     */
-    sendPoll(to: GroupChatId, name: string, options: string[], quotedMsgId?: MessageId, allowMultiSelect?: boolean): Promise<MessageId>;
-    /**
-     * Sends a video to given chat as a gif, with caption or not, using base64
-     * @param to chat id `xxxxx@c.us`
-     * @param file DataURL data:image/xxx;base64,xxx or the RELATIVE (should start with `./` or `../`) path of the file you want to send. With the latest version, you can now set this to a normal URL (for example [GET] `https://file-examples-com.github.io/uploads/2017/10/file_example_JPG_2500kB.jpg`).
-     * @param filename string xxxxx
-     * @param caption string xxxxx
-     * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     */
-    sendVideoAsGif(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig?: AxiosRequestConfig): Promise<MessageId>;
-    /**
-     * Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64
-     * @param to chat id `xxxxx@c.us`
-     * @param giphyMediaUrl string https://media.giphy.com/media/oYtVHSxngR3lC/giphy.gif => https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4
-     * @param caption string xxxxx
-     */
-    sendGiphy(to: ChatId, giphyMediaUrl: string, caption: Content): Promise<MessageId>;
-    /**
-     * Sends a file by Url or custom options
-     * @param to chat id `xxxxx@c.us`
-     * @param url string https://i.giphy.com/media/oYtVHSxngR3lC/200w.mp4
-     * @param filename string 'video.mp4'
-     * @param caption string xxxxx
-     * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     * @param waitForId boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
-     * @param ptt boolean default: false set this to true if you want to send the file as a push to talk file.
-     * @param withoutPreview boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.
-     */
-    sendFileFromUrl(to: ChatId, url: string, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig?: AxiosRequestConfig, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
-    /**
-     * Returns an object with all of your host device details
-     */
-    getMe(): Promise<any>;
-    /**
-     * Returns an object with properties of internal features and boolean values that represent if the respective feature is enabled or not.
-     */
-    getFeatures(): Promise<any>;
-    /**
-     * Returns a PNG DataURL screenshot of the session
-     * @param chatId Chat ID to open before taking a snapshot
-     * @param width Width of the viewport for the snapshot. Height also required if you want to resize.
-     * @param height Height of the viewport for the snapshot. Width also required if you want to resize.
-     * @returns `Promise<DataURL>`
-     */
-    getSnapshot(chatId?: ChatId, width?: number, height?: number): Promise<DataURL>;
-    /**
-     * Returns some metrics of the session/page.
-     * @returns `Promise<any>`
-     */
-    metrics(): Promise<any>;
-    /**
-     * Returns an array of group ids where the host account is admin
-     */
-    iAmAdmin(): Promise<GroupChatId[]>;
-    /**
-     * Returns an array of group ids where the host account has been kicked
-     */
-    getKickedGroups(): Promise<GroupChatId[]>;
-    /**
-     * Syncs contacts with phone. This promise does not resolve so it will instantly return true.
-     */
-    syncContacts(): Promise<boolean>;
-    /**
-     * Easily get the amount of messages loaded up in the session. This will allow you to determine when to clear chats/cache.
-     */
-    getAmountOfLoadedMessages(): Promise<number>;
-    /**
-     * Find any product listings of the given number. Use this to query a catalog
-     *
-     * @param id id of business profile (i.e the number with @c.us)
-     * @returns None
-     */
-    getBusinessProfilesProducts(id: ContactId): Promise<any>;
-    /**
-     * Get the business info of a given contact id
-     *
-     * @param id id of business profile (i.e the number with @c.us)
-     * @returns None
-     */
-    getBusinessProfile(id: ContactId): Promise<BusinessProfile>;
-    /**
-     * Sends product with image to chat
-     * @param imgBase64 Base64 image data
-     * @param chatid string the id of the chat that you want to send this product to
-     * @param caption string the caption you want to add to this message
-     * @param bizNumber string the @c.us number of the business account from which you want to grab the product
-     * @param productId string the id of the product within the main catalog of the aforementioned business
-     * @returns
-     */
-    sendImageWithProduct(to: ChatId, image: Base64, caption: Content, bizNumber: ContactId, productId: string): Promise<boolean | MessageId>;
-    /**
-     * @deprecated
-     * Feature Currently only available with Premium License accounts.
-     *
-     * Send a custom product to a chat. Please see [[CustomProduct]] for details.
-     *
-     * Caveats:
-     * - URL will not work (unable to click), you will have to send another message with the URL.
-     * - Recipient will see a thin banner under picture that says "Something went wrong"
-     * - This will only work if you have at least 1 product already in your catalog
-     * - Only works on Business accounts
-     */
-    sendCustomProduct(to: ChatId, image: DataURL, productData: CustomProduct): Promise<MessageId | boolean>;
-    /**
-     * Sends contact card to given chat id. You can use this to send multiple contacts but they will show up as multiple single-contact messages.
-     * @param {string} to 'xxxx@c.us'
-     * @param {string|array} contact 'xxxx@c.us' | ['xxxx@c.us', 'yyyy@c.us', ...]
-     */
-    sendContact(to: ChatId, contactId: ContactId | ContactId[]): Promise<MessageId | boolean>;
-    /**
-     *
-     * {@license:insiders@}
-     *
-     * Sends multiple contacts as a single message
-     *
-     * @param  to 'xxxx@c.us'
-     * @param contact ['xxxx@c.us', 'yyyy@c.us', ...]
-     */
-    sendMultipleContacts(to: ChatId, contactIds: ContactId[]): Promise<MessageId | boolean>;
-    /**
-     * Simulate '...typing' in chat
-     * @param {string} to 'xxxx@c.us'
-     * @param {boolean} on turn on similated typing, false to turn it off you need to manually turn this off.
-     */
-    simulateTyping(to: ChatId, on: boolean): Promise<boolean>;
-    /**
-     * Simulate '...recording' in chat
-     * @param {string} to 'xxxx@c.us'
-     * @param {boolean} on turn on similated recording, false to turn it off you need to manually turn this off.
-     */
-    simulateRecording(to: ChatId, on: boolean): Promise<boolean>;
-    /**
-     * @param id The id of the conversation
-     * @param archive boolean true => archive, false => unarchive
-     * @return boolean true: worked, false: didnt work (probably already in desired state)
-     */
-    archiveChat(id: ChatId, archive: boolean): Promise<boolean>;
-    /**
-     * Pin/Unpin chats
-     *
-     * @param id The id of the conversation
-     * @param pin boolean true => pin, false => unpin
-     * @return boolean true: worked
-     */
-    pinChat(id: ChatId, pin: boolean): Promise<boolean>;
-    /**
-     * Pin/Unpin message
-     *
-     * @param id The id of the message
-     * @param pin boolean true => pin, false => unpin
-     * @param pinDuration The length of time to pin the message. Default `ThirtyDays`
-     * @return boolean true: worked
-     */
-    pinMessage(id: MessageId, pin: boolean, pinDuration?: MessagePinDuration): Promise<boolean>;
-    /**
-     * Keep a message inside an ephemeral chat
-     *
-     * @param id The id of the message
-     * @return boolean true: worked
-     */
-    keepMessage(id: MessageId, keep: boolean): Promise<boolean>;
-    /**
-     *
-     * {@license:insiders@}
-     *
-     * Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called.
-     * @param chatId The id of the conversation you want to mute
-     * @param muteDuration ChatMuteDuration enum of the time you want this chat to be muted for.
-     * @return boolean true: worked or error code or message
-     */
-    muteChat(chatId: ChatId, muteDuration: ChatMuteDuration): Promise<boolean | string | number>;
-    /**
-     * Checks if a chat is muted
-     * @param chatId The id of the chat you want to check
-     * @returns boolean. `false` if the chat does not exist.
-     */
-    isChatMuted(chatId: ChatId): Promise<boolean>;
-    /**
-     *
-     * {@license:insiders@}
-     *
-     * Unmutes a conversation.
-     * @param id The id of the conversation you want to mute
-     * @return boolean true: worked or error code or message
-     */
-    unmuteChat(chatId: ChatId): Promise<boolean | string | number>;
-    /**
-     * Forward an array of messages to a specific chat using the message ids or Objects
-     *
-     * @param to '000000000000@c.us'
-     * @param messages this can be any mixture of message ids or message objects
-     * @param skipMyMessages This indicates whether or not to skip your own messages from the array
-     */
-    forwardMessages(to: ChatId, messages: MessageId | MessageId[], skipMyMessages: boolean): Promise<boolean | MessageId[]>;
-    /**
-     * Ghost forwarding is like a normal forward but as if it were sent from the host phone [i.e it doesn't show up as forwarded.]
-     * Any potential abuse of this method will see it become paywalled.
-     * @param to: Chat id to forward the message to
-     * @param messageId: message id of the message to forward. Please note that if it is not loaded, this will return false - even if it exists.
-     * @returns `Promise<MessageId | boolean>`
-     */
-    ghostForward(to: ChatId, messageId: MessageId): Promise<MessageId | boolean>;
-    /**
-     * Retrieves all contacts
-     * @returns array of [Contact]
-     */
-    getAllContacts(): Promise<Contact[]>;
-    getWAVersion(): Promise<string>;
-    /**
-     * Generate a pre-filled github issue link to easily report a bug
-     */
-    getIssueLink(): Promise<string>;
-    /**
-     * Retrieves if the phone is online. Please note that this may not be real time.
-     * @returns Boolean
-     */
-    isConnected(): Promise<boolean>;
-    /**
-     * Logs out from the session.
-     * @param preserveSessionData skip session.data.json file invalidation
-     * Please be careful when using this as it can exit the whole process depending on your config
-     */
-    logout(preserveSessionData?: boolean): Promise<boolean>;
-    /**
-     * @deprecated No longer works due to multi-device changes
-     * Retrieves Battery Level
-     * @returns Number
-     */
-    getBatteryLevel(): Promise<number>;
-    /**
-     * Retrieves whether or not phone is plugged in (i.e on charge)
-     * @returns Number
-     */
-    getIsPlugged(): Promise<boolean>;
-    /**
-     * Retrieves the host device number. Use this number when registering for a license key
-     * @returns Number
-     */
-    getHostNumber(): Promise<string>;
-    /**
-     * Returns the the type of license key used by the session.
-     * @returns
-     */
-    getLicenseType(): Promise<LicenseType | false>;
-    /**
-     * The EASY API uses this string to secure a subdomain on the openwa public tunnel service.
-     * @returns
-     */
-    getTunnelCode(): Promise<string>;
-    /**
-     * Get an array of chatIds with their respective last message's timestamp.
-     *
-     * This is useful for determining what chats are old/stale and need to be deleted.
-     */
-    getLastMsgTimestamps(): Promise<{
-        id: ChatId;
-        /**
-         * Epoch timestamp (no need to x 1000), works with new Date(t)
-         */
-        t: number;
-    }[]>;
-    /**
-     * Retrieves all chats
-     * @returns array of [Chat]
-     */
-    getAllChats(withNewMessageOnly?: boolean): Promise<Chat[]>;
-    /**
-     * retrieves all Chat Ids
-     * @returns array of [ChatId]
-     */
-    getAllChatIds(): Promise<ChatId[]>;
-    /**
-     * retrieves an array of IDs of accounts blocked by the host account.
-     * @returns `Promise<ChatId[]>`
-     */
-    getBlockedIds(): Promise<ChatId[]>;
-    /**
-     * @deprecated
-     *
-     * Retrieves all chats with messages
-     *
-     * Please use `getAllUnreadMessages` instead of this to see all messages indicated by the green dots in the chat.
-     *
-     * @returns array of [Chat]
-     */
-    getAllChatsWithMessages(withNewMessageOnly?: boolean): Promise<Chat[]>;
-    /**
-     * Returns a properly formatted array of messages from to send to the openai api
-     *
-     * @param last The amount of previous messages to retrieve. Defaults to 10
-     * @returns
-     */
-    getGptArray(chatId: ChatId, last?: number): Promise<{
-        role: "user" | "assistant";
-        content: string;
-    }[]>;
-    /**
-     * Retrieve all groups
-     * @returns array of groups
-     */
-    getAllGroups(withNewMessagesOnly?: boolean): Promise<Chat[]>;
-    /**
-     * Retrieve all commmunity Ids
-     * @returns array of group ids
-     */
-    getAllCommunities(): Promise<GroupId[]>;
-    /**
-     * Retrieves group members as [Id] objects
-     * @param groupId group id
-     */
-    getGroupMembersId(groupId: GroupChatId): Promise<ContactId[]>;
-    /**
-     * Returns the title and description of a given group id.
-     * @param groupId group id
-     */
-    getGroupInfo(groupId: GroupChatId): Promise<any>;
-    /**
-     * Returns the community metadata. Like group metadata but with a `subGroups` property which is the group metadata of the community subgroups.
-     * @param communityId community id
-     */
-    getCommunityInfo(communityId: GroupChatId): Promise<GroupMetadata & {
-        subGroups: GroupMetadata[];
-    }>;
-    /**
-     *
-     * Accepts a request from a recipient to join a group. Takes the message ID of the request message.
-     *
-     * @param {string} messageId
-     */
-    acceptGroupJoinRequest(messageId: MessageId): Promise<boolean>;
-    /**
-     * Retrieves community members Ids
-     * @param communityId community id
-     */
-    getCommunityParticipantIds(communityId: GroupChatId): Promise<{
-        id: GroupChatId;
-        participants: ContactId[];
-        subgroup: boolean;
-    }[]>;
-    /**
-     * Retrieves community admin Ids
-     * @param communityId community id
-     */
-    getCommunityAdminIds(communityId: GroupChatId): Promise<{
-        id: GroupChatId;
-        admins: ContactId[];
-        subgroup: boolean;
-    }[]>;
-    /**
-     * Retrieves community members as Contact objects
-     * @param communityId community id
-     */
-    getCommunityParticipants(communityId: GroupChatId): Promise<{
-        id: GroupChatId;
-        participants: Contact[];
-        subgroup: boolean;
-    }[]>;
-    /**
-     * Retrieves community admins as Contact objects
-     * @param communityId community id
-     */
-    getCommunityAdmins(communityId: GroupChatId): Promise<{
-        id: GroupChatId;
-        admins: Contact[];
-        subgroup: boolean;
-    }[]>;
-    /** Joins a group via the invite link, code, or message
-     * @param link This param is the string which includes the invite link or code. The following work:
-     * - Follow this link to join my WA group: https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ
-     * - https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ
-     * - DHTGJUfFJAV9MxOpZO1fBZ
-     *
-     *  If you have been removed from the group previously, it will return `401`
-     *
-     * @param returnChatObj boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata.
-     *
-     *
-     * @returns `Promise<string | boolean | number>` Either false if it didn't work, or the group id.
-     */
-    joinGroupViaLink(link: string, returnChatObj?: boolean): Promise<string | boolean | number | Chat>;
-    /**
-     * Block contact
-     * @param {string} id '000000000000@c.us'
-     */
-    contactBlock(id: ContactId): Promise<boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Report a contact for spam, block them and attempt to clear chat.
-     *
-     * @param {string} id '000000000000@c.us'
-     */
-    reportSpam(id: ContactId | ChatId): Promise<boolean>;
-    /**
-     * Unblock contact
-     * @param {string} id '000000000000@c.us'
-     */
-    contactUnblock(id: ContactId): Promise<boolean>;
-    /**
-     * Removes the host device from the group
-     * @param groupId group id
-     */
-    leaveGroup(groupId: GroupChatId): Promise<boolean>;
-    /**
-     * Extracts vcards from a message.This works on messages of typ `vcard` or `multi_vcard`
-     * @param msgId string id of the message to extract the vcards from
-     * @returns [vcard]
-     * ```
-     * [
-     * {
-     * displayName:"Contact name",
-     * vcard: "loong vcard string"
-     * }
-     * ]
-     * ```
-     * or false if no valid vcards found.
-     *
-     * Please use [vcf](https://www.npmjs.com/package/vcf) to convert a vcard string into a json object
-     */
-    getVCards(msgId: MessageId): Promise<string[]>;
-    /**
-     * Returns group members [Contact] objects
-     * @param groupId
-     */
-    getGroupMembers(groupId: GroupChatId): Promise<Contact[]>;
-    /**
-     * Retrieves contact detail object of given contact id
-     * @param contactId
-     * @returns contact detial as promise
-     */
-    getContact(contactId: ContactId): Promise<Contact>;
-    /**
-     * Retrieves chat object of given contact id
-     * @param contactId
-     * @returns contact detial as promise
-     */
-    getChatById(contactId: ContactId): Promise<Chat>;
-    /**
-     * Retrieves message object of given message id
-     * @param messageId
-     * @returns message object
-     */
-    getMessageById(messageId: MessageId): Promise<Message>;
-    /**
-     * {@license:insiders@}
-     *
-     * Get the detailed message info for a group message sent out by the host account.
-     * @param messageId The message Id
-     */
-    getMessageInfo(messageId: MessageId): Promise<MessageInfo>;
-    /**
-     * {@license:insiders@}
-     *
-     * Retrieves an order object
-     * @param messageId or OrderId
-     * @returns order object
-     */
-    getOrder(id: MessageId | string): Promise<Order>;
-    /**
-     * {@license:insiders@}
-     *
-     * Add a product to your catalog
-     *
-     * @param {string} name The name of the product
-     * @param {number} price The price of the product
-     * @param {string} currency The 3-letter currenct code for the product
-     * @param {string[]} images An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.
-     * @param {string} description optional, the description of the product
-     * @param {string} url The url of the product for more information
-     * @param {string} internalId The internal/backoffice id of the product
-     * @param {boolean} isHidden Whether or not the product is shown publicly in your catalog
-     * @returns product object
-     */
-    createNewProduct(name: string, price: number, currency: string, images: string[], description: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
-    /**
-     * {@license:insiders@}
-     *
-     * Edit a product in your catalog
-     *
-     * @param {string} productId The catalog ID of the product
-     * @param {string} name The name of the product
-     * @param {number} price The price of the product
-     * @param {string} currency The 3-letter currenct code for the product
-     * @param {string[]} images An array of dataurl or base64 strings of product images, the first image will be used as the main image. At least one image is required.
-     * @param {string} description optional, the description of the product
-     * @param {string} url The url of the product for more information
-     * @param {string} internalId The internal/backoffice id of the product
-     * @param {boolean} isHidden Whether or not the product is shown publicly in your catalog
-     * @returns product object
-     */
-    editProduct(productId: string, name?: string, price?: number, currency?: string, images?: DataURL[], description?: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
-    /**
-     * {@license:insiders@}
-     *
-     * Send a product to a chat
-     *
-     * @param {string} chatId The chatId
-     * @param {string} productId The id of the product
-     * @returns MessageID
-     */
-    sendProduct(chatId: ChatId, productId: string): Promise<MessageId>;
-    /**
-     *
-     * Remove a product from the host account's catalog
-     *
-     * @param {string} productId The id of the product
-     * @returns boolean
-     */
-    removeProduct(productId: string): Promise<boolean>;
-    /**
-     * Retrieves the last message sent by the host account in any given chat or globally.
-     * @param chatId This is optional. If no chat Id is set then the last message sent by the host account will be returned.
-     * @returns message object or `undefined` if the host account's last message could not be found.
-     */
-    getMyLastMessage(chatId?: ChatId): Promise<Message | undefined>;
-    /**
-     * Retrieves the starred messages in a given chat
-     * @param chatId Chat ID to filter starred messages by
-     * @returns message object
-     */
-    getStarredMessages(chatId?: ChatId): Promise<Message[]>;
-    /**
-     * Star a message
-     * @param messageId Message ID of the message you want to star
-     * @returns `true`
-     */
-    starMessage(messageId: MessageId): Promise<boolean>;
-    /**
-     * Unstar a message
-     * @param messageId Message ID of the message you want to unstar
-     * @returns `true`
-     */
-    unstarMessage(messageId: MessageId): Promise<boolean>;
-    /**
-     * React to a message
-     * @param messageId Message ID of the message you want to react to
-     * @param emoji 1 single emoji to add to the message as a reacion
-     * @returns boolean
-     */
-    react(messageId: MessageId, emoji: string): Promise<boolean>;
-    /**
-     * @deprecated
-     *
-     * Retrieves a message object which results in a valid sticker instead of a blank one. This also works with animated stickers.
-     *
-     * If you run this without a valid insiders key, it will return false and cause an error upon decryption.
-     *
-     * @param messageId The message ID `message.id`
-     * @returns message object OR `false`
-     */
-    getStickerDecryptable(messageId: MessageId): Promise<Message | false>;
-    /**
-     *
-     * {@license:insiders@}
-     *
-     * If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message.
-     *
-     * if you run this without a valid insiders key, it will return false and cause an error upon decryption.
-     *
-     * @param messageId
-     * @returns [[Message]] OR `false`
-     */
-    forceStaleMediaUpdate(messageId: MessageId): Promise<Message | false>;
-    /**
-     * Retrieves chat object of given contact id
-     * @param contactId
-     * @returns contact detial as promise
-     */
-    getChat(contactId: ContactId): Promise<Chat>;
-    /**
-     * {@license:insiders@}
-     *
-     * Retrieves the groups that you have in common with a contact
-     * @param contactId
-     */
-    getCommonGroups(contactId: ContactId): Promise<{
-        id: string;
-        title: string;
-    }[]>;
-    /**
-     * Retrieves the epoch timestamp of the time the contact was last seen. This will not work if:
-     * 1. They have set it so you cannot see their last seen via privacy settings.
-     * 2. You do not have an existing chat with the contact.
-     * 3. The chatId is for a group
-     * In both of those instances this method will return undefined.
-     * @param chatId The id of the chat.
-     * @returns number timestamp when chat was last online or undefined.
-     */
-    getLastSeen(chatId: ChatId): Promise<number | boolean>;
-    /**
-     * Retrieves chat picture
-     * @param chatId
-     * @returns Url of the chat picture or undefined if there is no picture for the chat.
-     */
-    getProfilePicFromServer(chatId: ChatId): Promise<string>;
-    /**
-     * Sets a chat status to seen. Marks all messages as ack: 3
-     * @param chatId chat id: `xxxxx@c.us`
-     */
-    sendSeen(chatId: ChatId): Promise<boolean>;
-    /**
-     * Runs sendSeen on all chats
-     */
-    markAllRead(): Promise<boolean>;
-    /**
-     * Sets a chat status to unread. May be useful to get host's attention
-     * @param chatId chat id: `xxxxx@c.us`
-     */
-    markAsUnread(chatId: ChatId): Promise<boolean>;
-    /**
-     * Checks if a chat contact is online. Not entirely sure if this works with groups.
-     *
-     * It will return `true` if the chat is `online`, `false` if the chat is `offline`, `PRIVATE` if the privacy settings of the contact do not allow you to see their status and `NO_CHAT` if you do not currently have a chat with that contact.
-     *
-     * @param chatId chat id: `xxxxx@c.us`
-     */
-    isChatOnline(chatId: ChatId): Promise<boolean | string>;
-    /**
-      * Load more messages in chat object from server. Use this in a while loop. This should return up to 50 messages at a time
-     * @param contactId
-     * @returns Message []
-     */
-    loadEarlierMessages(contactId: ContactId): Promise<Message[]>;
-    /**
-     * Get the status of a contact
-     * @param contactId to '000000000000@c.us'
-     */
-    getStatus(contactId: ContactId): Promise<{
-        id: string;
-        status: string;
-    }>;
-    /**
-     *
-     * {@license:insiders@}
-     *
-     * :::danger
-     *
-     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
-     *
-     * :::
-     *
-     * Use a raw payload within your open-wa session
-     *
-     * @example
-     * If there is a code block, then both TypeDoc and VSCode will treat
-     * text outside of the code block as regular text.
-     *
-     * ```ts
-     * await B('44123456789@c.us', {
-     *  test: 1
-     * })
-     * ```
-     * {@link loadAllEarlierMessages}
-     * @param chatId
-     * @param payload
-     * returns: MessageId
-     */
-    B(chatId: ChatId, payload: {
-        [k: string]: any;
-    }): Promise<MessageId>;
-    /**
-      * Load all messages in chat object from server.
-     * @param contactId
-     * @returns Message[]
-     */
-    loadAllEarlierMessages(contactId: ContactId): Promise<Message[]>;
-    /**
-      * Load all messages until a given timestamp in chat object from server.
-     * @param contactId
-     * @param timestamp in seconds
-     * @returns Message[]
-     */
-    loadEarlierMessagesTillDate(contactId: ContactId, timestamp: number): Promise<Message[]>;
-    /**
-      * Delete the conversation from your WA
-     * @param chatId
-     * @returns boolean
-     */
-    deleteChat(chatId: ChatId): Promise<boolean>;
-    /**
-      * Delete all messages from the chat.
-     * @param chatId
-     * @returns boolean
-     */
-    clearChat(chatId: ChatId): Promise<boolean>;
-    /**
-      * Retrieves an invite link for a group chat. returns false if chat is not a group.
-     * @param chatId
-     * @returns `Promise<string>`
-     */
-    getGroupInviteLink(chatId: ChatId): Promise<string>;
-    /**
-      * Get the details of a group through the invite link
-     * @param link This can be an invite link or invite code
-     * @returns
-     */
-    inviteInfo(link: string): Promise<any>;
-    /**
-     * Set/Unset a sticker as a fav.
-     * @param msgId The message Id related to the sticker you want to fav
-     * @param fav set this to true to fav a sticker, set it to false to remove the sticker from favorites. default true
-     * @returns favId The ID (filehash) of the fav sticker
-     */
-    favSticker(msgId: MessageId, fav?: boolean): Promise<string>;
-    /**
-     * Set/Unset a sticker as a fav.
-     * @param chatId The chat in which you want to send the sticker
-     * @param favId set this to true to favourite a sticker, set it to false to remove the sticker from favorites
-     * @returns MessageId of the sent sticker message
-     */
-    sendFavSticker(chatId: ChatId, favId: string): Promise<MessageId>;
-    /**
-     * Get an array of fav'ed stickers
-     */
-    getFavStickers(): Promise<Partial<Message>>;
-    /**
-      * Revokes the current invite link for a group chat. Any previous links will stop working
-     * @param chatId
-     * @returns `Promise<boolean>`
-     */
-    revokeGroupInviteLink(chatId: ChatId): Promise<boolean | string>;
-    /**
-     * Gets the contact IDs of members requesting approval to join the group
-     * @param groupChatId
-     * @returns `Promise<ContactId[]>`
-     */
-    getGroupApprovalRequests(groupChatId: GroupChatId): Promise<ContactId[]>;
-    /**
-      * Approves a group join request
-     * @param groupChatId The group chat id
-     * @param contactId The contact id of the person who is requesting to join the group
-     * @returns `Promise<boolean>`
-     */
-    approveGroupJoinRequest(groupChatId: GroupChatId, contactId: ContactId): Promise<boolean | string>;
-    /**
-    * Rejects a group join request
-     * @param groupChatId The group chat id
-     * @param contactId The contact id of the person who is requesting to join the group
-     * @returns `Promise<boolean>`
-     */
-    rejectGroupJoinRequest(groupChatId: GroupChatId, contactId: ContactId): Promise<boolean | string>;
-    /**
-     * Deletes message of given message id
-     * @param chatId The chat id from which to delete the message.
-     * @param messageId The specific message id of the message to be deleted
-     * @param onlyLocal If it should only delete locally (message remains on the other recipienct's phone). Defaults to false.
-     * @returns nothing
-     */
-    deleteMessage(chatId: ChatId, messageId: MessageId[] | MessageId, onlyLocal?: boolean): Promise<void>;
-    /**
-     * Checks if a number is a valid WA number
-     * @param contactId, you need to include the @c.us at the end.
-     */
-    checkNumberStatus(contactId: ContactId): Promise<NumberCheck>;
-    /**
-     * Retrieves all unread Messages
-     * @param includeMe
-     * @param includeNotifications
-     * @param use_unread_count
-     * @returns any
-     */
-    getUnreadMessages(includeMe: boolean, includeNotifications: boolean, use_unread_count: boolean): Promise<Chat & {
-        messages: Message[];
-    }[]>;
-    /**
-     * Retrieves all new Messages. where isNewMsg==true
-     * @returns list of messages
-     */
-    getAllNewMessages(): Promise<Message[]>;
-    /**
-     * Retrieves all unread Messages. where ack==-1
-     * @returns list of messages
-     */
-    getAllUnreadMessages(): Promise<Message[]>;
-    /**
-     * Retrieves all unread Messages as indicated by the red dots in WA web. This returns an array of objects and are structured like so:
-     * ```javascript
-     * [{
-     * "id": "000000000000@g.us", //the id of the chat
-     * "indicatedNewMessages": [] //array of messages, not including any messages by the host phone
-     * }]
-     * ```
-     * @returns list of messages
-     */
-    getIndicatedNewMessages(): Promise<Message[]>;
-    /**
-     * Fires all unread messages to the onMessage listener.
-     * Make sure to call this AFTER setting your listeners.
-     * @returns array of message IDs
-     */
-    emitUnreadMessages(): Promise<MessageId[]>;
-    /**
-     * Retrieves all Messages in a chat that have been loaded within the WA web instance.
-     *
-     * This does not load every single message in the chat history.
-     *
-     * @param chatId, the chat to get the messages from
-     * @param includeMe, include my own messages? boolean
-     * @param includeNotifications
-     * @returns Message[]
-     */
-    getAllMessagesInChat(chatId: ChatId, includeMe: boolean, includeNotifications: boolean): Promise<Message[]>;
-    /**
-     * loads and Retrieves all Messages in a chat
-     * @param chatId, the chat to get the messages from
-     * @param includeMe, include my own messages? boolean
-     * @param includeNotifications
-     * @returns any
-     */
-    loadAndGetAllMessagesInChat(chatId: ChatId, includeMe: boolean, includeNotifications: boolean): Promise<Message[]>;
-    /**
-     * Create a group and add contacts to it
-     *
-     * @param groupName group name: 'New group'
-     * @param contacts: A single contact id or an array of contact ids.
-     */
-    createGroup(groupName: string, contacts: ContactId | ContactId[]): Promise<GroupChatCreationResponse>;
-    /**
-     * {@license:insiders@}
-     *
-     * Create a new community
-     *
-     * @param communityName The community name
-     * @param communitySubject: The community subject line
-     * @param icon DataURL of a 1:1 ratio jpeg for the community icon
-     * @param existingGroups An array of existing group IDs, that are not already part of a community, to add to this new community.
-     * @param newGroups An array of new group objects that
-     */
-    createCommunity(communityName: string, communitySubject: string, icon: DataURL, existingGroups?: GroupChatId[], newGroups?: NewCommunityGroup[]): Promise<GroupId>;
-    /**
-     * Remove participant of Group
-     *
-     * If not a group chat, returns `NOT_A_GROUP_CHAT`.
-     *
-     * If the chat does not exist, returns `GROUP_DOES_NOT_EXIST`
-     *
-     * If the participantId does not exist in the group chat, returns `NOT_A_PARTICIPANT`
-     *
-     * If the host account is not an administrator, returns `INSUFFICIENT_PERMISSIONS`
-     *
-     * @param {*} groupId `0000000000-00000000@g.us`
-     * @param {*} participantId `000000000000@c.us`
-     */
-    removeParticipant(groupId: GroupChatId, participantId: ContactId): Promise<boolean>;
-    /** Change the icon for the group chat
-     * @param groupId 123123123123_1312313123@g.us The id of the group
-     * @param imgData 'data:image/jpeg;base64,...` The base 64 data url. Make sure this is a small img (128x128), otherwise it will fail.
-     * @returns boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.
-     */
-    setGroupIcon(groupId: GroupChatId, image: DataURL): Promise<boolean>;
-    /** Change the icon for the group chat
-     * @param groupId 123123123123_1312313123@g.us The id of the group
-     * @param url'https://upload.wikimedia.org/wikipedia/commons/3/38/JPEG_example_JPG_RIP_001.jpg' The url of the image. Make sure this is a small img (128x128), otherwise it will fail.
-     * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     * @returns boolean true if it was set, false if it didn't work. It usually doesn't work if the image file is too big.
-     */
-    setGroupIconByUrl(groupId: GroupChatId, url: string, requestConfig?: AxiosRequestConfig): Promise<boolean>;
-    /**
-    * Add participant to Group
-    *
-    * If not a group chat, returns `NOT_A_GROUP_CHAT`.
-    *
-    * If the chat does not exist, returns `GROUP_DOES_NOT_EXIST`
-    *
-    * If the participantId does not exist in the contacts, returns `NOT_A_CONTACT`
-    *
-    * If the host account is not an administrator, returns `INSUFFICIENT_PERMISSIONS`
-    *
-    * @param {*} groupId '0000000000-00000000@g.us'
-    * @param {*} participantId '000000000000@c.us'
-    *
-    */
-    addParticipant(groupId: GroupChatId, participantId: ContactId | ContactId[]): Promise<boolean>;
-    /**
-    * Promote Participant to Admin in Group
-    *
-    *
-    * If not a group chat, returns `NOT_A_GROUP_CHAT`.
-    *
-    * If the chat does not exist, returns `GROUP_DOES_NOT_EXIST`
-    *
-    * If the participantId does not exist in the group chat, returns `NOT_A_PARTICIPANT`
-    *
-    * If the host account is not an administrator, returns `INSUFFICIENT_PERMISSIONS`
-    *
-    * @param {*} groupId '0000000000-00000000@g.us'
-    * @param {*} participantId '000000000000@c.us'
-    */
-    promoteParticipant(groupId: GroupChatId, participantId: ContactId | ContactId[]): Promise<boolean>;
-    /**
-    * Demote Admin of Group
-    *
-    * If not a group chat, returns `NOT_A_GROUP_CHAT`.
-    *
-    * If the chat does not exist, returns `GROUP_DOES_NOT_EXIST`
-    *
-    * If the participantId does not exist in the group chat, returns `NOT_A_PARTICIPANT`
-    *
-    * If the host account is not an administrator, returns `INSUFFICIENT_PERMISSIONS`
-    *
-    * @param {*} groupId '0000000000-00000000@g.us'
-    * @param {*} participantId '000000000000@c.us'
-    */
-    demoteParticipant(groupId: GroupChatId, participantId: ContactId | ContactId[]): Promise<boolean>;
-    /**
-    *
-    * Change who can and cannot speak in a group
-    * @param groupId '0000000000-00000000@g.us' the group id.
-    * @param onlyAdmins boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group
-    * @returns boolean true if action completed successfully.
-    */
-    setGroupToAdminsOnly(groupId: GroupChatId, onlyAdmins: boolean): Promise<boolean>;
-    /**
-     *
-    * Change who can and cannot edit a groups details
-    * @param groupId '0000000000-00000000@g.us' the group id.
-    * @param onlyAdmins boolean set to true if you want only admins to be able to speak in this group. false if you want to allow everyone to speak in the group
-    * @returns boolean true if action completed successfully.
-    */
-    setGroupEditToAdminsOnly(groupId: GroupChatId, onlyAdmins: boolean): Promise<boolean>;
-    /**
-     *
-    * Turn on or off the approval requirement for new members to join a group
-    * @param groupId '0000000000-00000000@g.us' the group id.
-    * @param requireApproval set to true to turn on the approval requirement, false to turn off
-    * @returns boolean true if action completed successfully.
-    */
-    setGroupApprovalMode(groupId: GroupChatId, requireApproval: boolean): Promise<boolean>;
-    /**
-    * Change the group chant description
-    * @param groupId '0000000000-00000000@g.us' the group id.
-    * @param description string The new group description
-    * @returns boolean true if action completed successfully.
-    */
-    setGroupDescription(groupId: GroupChatId, description: string): Promise<boolean>;
-    /**
-     * {@license:insiders@}
-     *
-    * Change the group chat title
-    * @param groupId '0000000000-00000000@g.us' the group id.
-    * @param title string The new group title
-    * @returns boolean true if action completed successfully.
-    */
-    setGroupTitle(groupId: GroupChatId, title: string): Promise<boolean>;
-    /**
-    * Get Admins of a Group
-    * @param {*} groupId '0000000000-00000000@g.us'
-    */
-    getGroupAdmins(groupId: GroupChatId): Promise<ContactId[]>;
-    /**
-     * {@license:insiders@}
-     *
-     * Set the wallpaper background colour
-     * @param {string} hex '#FFF123'
-    */
-    setChatBackgroundColourHex(hex: string): Promise<boolean>;
-    /**
-     * Join or leave the wa web beta program. Will return true of operation was successful.
-     *
-     * @param {boolean} join true to join the beta, false to leave
-    */
-    joinWebBeta(join: boolean): Promise<boolean>;
-    /**
-     *
-     * Start dark mode [NOW GENERALLY AVAILABLE]
-     * @param {boolean} activate true to activate dark mode, false to deactivate
-    */
-    darkMode(activate: boolean): Promise<boolean>;
-    /**
-     *
-     * Automatically reject calls on the host account device. Please note that the device that is calling you will continue to ring.
-     *
-     * Update: Due to the nature of MD, the host account will continue ringing.
-     *
-     * @param message optional message to send to the calling account when their call is detected and rejected
-     */
-    autoReject(message?: string): Promise<boolean>;
-    /**
-     * Returns an array of contacts that have read the message. If the message does not exist, it will return an empty array. If the host account has disabled read receipts this may not work!
-     * Each of these contact objects have a property `t` which represents the time at which that contact read the message.
-     * @param messageId The message id
-     */
-    getMessageReaders(messageId: MessageId): Promise<Contact[]>;
-    /**
-     * Returns poll data including results and votes.
-     *
-     * @param messageId The message id of the Poll
-     */
-    getPollData(messageId: MessageId): Promise<PollData>;
-    /**
-     * Sends a sticker (including GIF) from a given URL
-     * @param to: The recipient id.
-     * @param url: The url of the image
-     * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     *
-     * @returns `Promise<MessageId | boolean>`
-     */
-    sendStickerfromUrl(to: ChatId, url: string, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<string | MessageId | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Sends a sticker from a given URL
-     * @param to The recipient id.
-     * @param url The url of the image
-     * @param messageId The id of the message to reply to
-     * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     *
-     * @returns `Promise<MessageId | boolean>`
-     */
-    sendStickerfromUrlAsReply(to: ChatId, url: string, messageId: MessageId, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<MessageId | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * This function takes an image and sends it as a sticker to the recipient as a reply to another message.
-     *
-     *
-     * @param to  The recipient id.
-     * @param image: [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the image
-     * @param messageId  The id of the message to reply to
-     * @param stickerMetadata  Sticker metadata
-     */
-    sendImageAsStickerAsReply(to: ChatId, image: DataURL | Buffer | Base64 | string, messageId: MessageId, stickerMetadata?: StickerMetadata): Promise<MessageId | boolean | string>;
-    /**
-     * This allows you to get a single property of a single object from the session. This limints the amouunt of data you need to sift through, reduces congestion between your process and the session and the flexibility to build your own specific getters.
-     *
-     * Example - get message read state (ack):
-     *
-     * ```javascript
-     * const ack  = await client.getSingleProperty('Msg',"true_12345678912@c.us_9C4D0965EA5C09D591334AB6BDB07FEB",'ack')
-     * ```
-     * @param namespace
-     * @param id id of the object to get from the specific namespace
-     * @param property the single property key to get from the object.
-     * @returns any If the property or the id cannot be found, it will return a 404
-     */
-    getSingleProperty(namespace: namespace, id: string, property: string): Promise<any>;
-    private stickerServerRequest;
-    private prepareWebp;
-    /**
-     * This function takes an image (including animated GIF) and sends it as a sticker to the recipient. This is helpful for sending semi-ephemeral things like QR codes.
-     * The advantage is that it will not show up in the recipients gallery. This function automatiicaly converts images to the required webp format.
-     * @param to: The recipient id.
-     * @param image: [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the image
-     */
-    sendImageAsSticker(to: ChatId, image: DataURL | Buffer | Base64 | string, stickerMetadata?: StickerMetadata): Promise<MessageId | string | boolean>;
-    /**
-     * Use this to send an mp4 file as a sticker. This can also be used to convert GIFs from the chat because GIFs in WA are actually tiny mp4 files.
-     *
-     * @param to ChatId The chat id you want to send the webp sticker to
-     * @param file [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file
-     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
-     */
-    sendMp4AsSticker(to: ChatId, file: DataURL | Buffer | Base64 | string, processOptions?: Mp4StickerConversionProcessOptions, stickerMetadata?: StickerMetadata, messageId?: MessageId): Promise<MessageId | string | boolean>;
-    /**
-     * Send a discord emoji to a chat as a sticker
-     *
-     * @param to ChatId The chat id you want to send the webp sticker to
-     * @param emojiId The discord emoji id without indentifying chars. In discord you would write `:who:`, here use `who`
-     * @param messageId message id of the message you want this sticker to reply to. @license:insiders@
-     */
-    sendEmoji(to: ChatId, emojiId: string, messageId?: MessageId): Promise<MessageId | boolean | string>;
-    /**
-     * You can use this to send a raw webp file.
-     * @param to ChatId The chat id you want to send the webp sticker to
-     * @param webpBase64 Base64 The base64 string of the webp file. Not DataURl
-     * @param animated Boolean Set to true if the webp is animated. Default `false`
-     */
-    sendRawWebpAsSticker(to: ChatId, webpBase64: Base64, animated?: boolean): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * You can use this to send a raw webp file.
-     * @param to ChatId The chat id you want to send the webp sticker to
-     * @param messageId MessageId Message ID of the message to reply to
-     * @param webpBase64 Base64 The base64 string of the webp file. Not DataURl
-     * @param animated Boolean Set to true if the webp is animated. Default `false`
-     */
-    sendRawWebpAsStickerAsReply(to: ChatId, messageId: MessageId, webpBase64: Base64, animated?: boolean): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:insiders@}
-     *
-     * Turn the ephemeral setting in a chat to on or off
-     * @param chatId The ID of the chat
-     * @param ephemeral `true` to turn on the ephemeral setting to 1 day, `false` to turn off the ephemeral setting. Other options: `604800 | 7776000`
-     * @returns `Promise<boolean>` true if the setting was set, `false` if the chat does not exist
-     */
-    setChatEphemeral(chatId: ChatId, ephemeral: EphemeralDuration | boolean): Promise<boolean>;
-    /**
-     * Send a giphy GIF as an animated sticker.
-     * @param to ChatId
-     * @param giphyMediaUrl URL | string This is the giphy media url and has to be in the format `https://media.giphy.com/media/RJKHjCAdsAfQPn03qQ/source.gif` or it can be just the id `RJKHjCAdsAfQPn03qQ`
-     */
-    sendGiphyAsSticker(to: ChatId, giphyMediaUrl: URL | string): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Sends a formatted text story.
-     * @param text The text to be displayed in the story
-     * @param textRgba The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"
-     * @param backgroundRgba  The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"
-     * @param font The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:
-     * 0: Sans Serif
-     * 1: Serif
-     * 2: [Norican Regular](https://fonts.google.com/specimen/Norican)
-     * 3: [Bryndan Write](https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm)
-     * 4: [Bebasneue Regular](https://www.dafont.com/bebas-neue.font)
-     * 5: [Oswald Heavy](https://www.fontsquirrel.com/fonts/oswald)
-     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
-     */
-    postTextStatus(text: Content, textRgba: string, backgroundRgba: string, font: number): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Sends a formatted text story with a thumbnail.
-     * @param url The URL to share in the story
-     * @param text The text to be displayed in the story
-     * @param textRgba The colour of the text in the story in hex format, make sure to add the alpha value also. E.g "#FF00F4F2"
-     * @param backgroundRgba  The colour of the background in the story in hex format, make sure to add the alpha value also. E.g "#4FF31FF2"
-     * @param font The font of the text to be used in the story. This has to be a number. Each number refers to a specific predetermined font. Here are the fonts you can choose from:
-     * @param thumbnail base64 thumbnail override, if not provided the link server will try to figure it out.
-     * 0: Sans Serif
-     * 1: Serif
-     * 2: [Norican Regular](https://fonts.google.com/specimen/Norican)
-     * 3: [Bryndan Write](https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm)
-     * @returns `Promise<MessageId>` returns status id if it worked, false if it didn't
-     */
-    postThumbnailStatus(url: string, text: Content, textRgba: string, backgroundRgba: string, font: number, thumbnail?: Base64): Promise<MessageId>;
-    /**
-     * {@license:restricted@}
-     *
-     * Posts an image story.
-     * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
-     * @param caption The caption for the story
-     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
-     */
-    postImageStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Posts a video story.
-     * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
-     * @param caption The caption for the story
-     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
-     */
-    postVideoStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Consumes a list of id strings of stories to delete.
-     *
-     * @param statusesToDelete string [] | string an array of ids of stories to delete.
-     * @returns boolean. True if it worked.
-     */
-    deleteStory(statusesToDelete: string | string[]): Promise<boolean>;
-    /**
-     * Alias for deleteStory
-     */
-    deleteStatus(statusesToDelete: string | string[]): Promise<boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Deletes all your existing stories.
-     * @returns boolean. True if it worked.
-     */
-    deleteAllStories(): Promise<boolean>;
-    /**
-     * Alias for deleteStory
-     */
-    deleteAllStatus(): Promise<boolean>;
-    /**
-     * {@license:restricted@}
-     *
-     * Retrieves all existing stories.
-     *
-     * Only works with a Story License Key
-     */
-    getMyStoryArray(): Promise<Message[]>;
-    /**
-     * Alias for deleteStory
-     */
-    getMyStatusArray(): Promise<Message[]>;
-    /**
-     * {@license:restricted@}
-     *
-     * Retrieves an array of user ids that have 'read' your story.
-     *
-     * @param id string The id of the story
-     *
-     */
-    getStoryViewers(id?: string): Promise<ContactId[] | {
-        [k: MessageId]: ContactId[];
-    }>;
-    /**
-     * Clears all chats of all messages. This does not delete chats. Please be careful with this as it will remove all messages from whatsapp web and the host device. This feature is great for privacy focussed bots.
-     *
-     * @param ts number A chat that has had a message after ts (epoch timestamp) will not be cleared.
-     *
-     */
-    clearAllChats(ts?: number): Promise<boolean>;
-    /**
-     * This simple function halves the amount of messages in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.
-     * Calling this method will cut the message cache to 2000 messages, therefore reducing the memory usage of your process.
-     * You should use this in conjunction with `getAmountOfLoadedMessages` to intelligently control the session message cache.
-     */
-    cutMsgCache(): Promise<number>;
-    /**
-     * This simple function halves the amount of chats in your session message cache. This does not delete messages off your phone. If over a day you've processed 4000 messages this will possibly result in 4000 messages being present in your session.
-     * Calling this method will cut the message cache as much as possible, reducing the memory usage of your process.
-     * You should use this in conjunction with `getAmountOfLoadedMessages` to intelligently control the session message cache.
-     */
-    cutChatCache(): Promise<{
-        before: {
-            msgs: number;
-            chats: number;
-        };
-        after: {
-            msgs: number;
-            chats: number;
-        };
-    }>;
-    /**
-     * Deletes chats from a certain index (default 1000). E.g if this startingFrom param is `100` then all chats from index `100` onwards will be deleted.
-     *
-     * @param startingFrom the chat index to start from. Please do not set this to anything less than 10 @default: `1000`
-     */
-    deleteStaleChats(startingFrom?: number): Promise<boolean>;
-    /**
-     * Download profile pics from the message object.
-     * ```javascript
-     *  const filename = `profilepic_${message.from}.jpeg`;
-     *  const data = await client.downloadProfilePicFromMessage(message);
-     *  const dataUri = `data:image/jpeg;base64,${data}`;
-     *  fs.writeFile(filename, mData, 'base64', function(err) {
-     *    if (err) {
-     *      return console.log(err);
-     *    }
-     *    console.log('The file was saved!');
-     *  });
-     * ```
-     */
-    downloadProfilePicFromMessage(message: Message): Promise<Base64>;
-    /**
-     * Download via the browsers authenticated session via URL.
-     * @returns base64 string (non-data url)
-     */
-    downloadFileWithCredentials(url: string): Promise<Base64>;
-    /**
-     *
-     * Sets the profile pic of the host number.
-     * @param data string data url image string.
-     * @returns `Promise<boolean>` success if true
-     */
-    setProfilePic(data: DataURL): Promise<boolean>;
-    /**
-     * This exposes a simple express middlware that will allow users to quickly boot up an api based off this client. Checkout demo/index.ts for an example
-     * How to use the middleware:
-     *
-     * ```javascript
-     *
-     * import { create } from '@open-wa/wa-automate';
-     * const express = require('express')
-     * const app = express()
-     * app.use(express.json())
-     * const PORT = 8082;
-     *
-     * function start(client){
-     *   app.use(client.middleware()); //or client.middleware(true) if you require the session id to be part of the path (so localhost:8082/sendText beccomes localhost:8082/sessionId/sendText)
-     *   app.listen(PORT, function () {
-     *     console.log(`\n• Listening on port ${PORT}!`);
-     *   });
-     *   ...
-     * }
-     *
-     *
-     * create({
-     *   sessionId:'session1'
-     * }).then(start)
-     *
-     * ```
-     *
-     * All requests need to be `POST` requests. You use the API the same way you would with `client`. The method can be the path or the method param in the post body. The arguments for the method should be properly ordered in the args array in the JSON post body.
-     *
-     * Example:
-     *
-     * ```javascript
-     *   await client.sendText('4477777777777@c.us','test')
-     *   //returns "true_4477777777777@c.us_3EB0645E623D91006252"
-     * ```
-     * as a request with a path:
-     *
-     * ```javascript
-     * const axios = require('axios').default;
-     * axios.post('localhost:8082/sendText', {
-     *     args: [
-     *        "4477777777777@c.us",
-     *        "test"
-     *         ]
-     *   })
-     * ```
-     *
-     * or as a request without a path:
-     *
-     * ```javascript
-     * const axios = require('axios').default;
-     * axios.post('localhost:8082', {
-     *     method:'sendText',
-     *     args: [
-     *        "4477777777777@c.us",
-     *        "test"
-     *         ]
-     * })
-     * ```
-     *
-     * As of 1.9.69, you can also send the argyments as an object with the keys mirroring the paramater names of the relative client functions
-     *
-     * Example:
-     *
-     * ```javascript
-     * const axios = require('axios').default;
-     * axios.post('localhost:8082', {
-     *     method:'sendText',
-     *     args: {
-     *        "to":"4477777777777@c.us",
-     *        "content":"test"
-     *         }
-     * })
-     * ```
-     * @param useSessionIdInPath boolean Set this to true if you want to keep each session in it's own path.
-     *
-     * For example, if you have a session with id  `host` if you set useSessionIdInPath to true, then all requests will need to be prefixed with the path `host`. E.g `localhost:8082/sendText` becomes `localhost:8082/host/sendText`
-     */
-    middleware: (useSessionIdInPath?: boolean, PORT?: number) => (req: Request, res: Response, next: NextFunction) => Promise<any>;
-    /**
-     * Retreives an array of webhook objects
-     */
-    listWebhooks(): Promise<Webhook[]>;
-    /**
-     * Removes a webhook.
-     *
-     * Returns `true` if the webhook was found and removed. `false` if the webhook was not found and therefore could not be removed. This does not unregister any listeners off of other webhooks.
-     *
-     *
-     * @param webhookId The ID of the webhook
-     * @retruns boolean
-     */
-    removeWebhook(webhookId: string): Promise<boolean>;
-    /**
-     * Update registered events for a specific webhook. This will override all existing events. If you'd like to remove all listeners from a webhook, consider using [[removeWebhook]].
-     *
-     * In order to update authentication details for a webhook, remove it completely and then reregister it with the correct credentials.
-     */
-    updateWebhook(webhookId: string, events: SimpleListener[] | 'all'): Promise<Webhook | false>;
-    /**
-     * The client can now automatically handle webhooks. Use this method to register webhooks.
-     *
-     * @param event use [[SimpleListener]] enum
-     * @param url The webhook url
-     * @param requestConfig {} By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     * @param concurrency the amount of concurrent requests to be handled by the built in queue. Default is 5.
-     */
-    private _setupWebhooksOnListeners;
-    /**
-     * The client can now automatically handle webhooks. Use this method to register webhooks.
-     *
-     * @param url The webhook url
-     * @param events An array of [[SimpleListener]] enums or `all` (to register all possible listeners)
-     * @param requestConfig {} By default the request is a post request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
-     * @param concurrency the amount of concurrent requests to be handled by the built in queue. Default is 5.
-     * @returns A webhook object. This will include a webhook ID and an array of all successfully registered Listeners.
-     */
-    registerWebhook(url: string, events: SimpleListener[] | 'all', requestConfig?: AxiosRequestConfig, concurrency?: number): Promise<Webhook | false>;
-    prepEventData(data: JsonObject, event: SimpleListener, extras?: JsonObject): EventPayload;
-    getEventSignature(simpleListener?: SimpleListener): string;
-    private registerEv;
-    /**
-     * Every time this is called, it returns one less number. This is used to sort out queue priority.
-     */
-    private tickPriority;
-    /**
-     * Get the INSTANCE_ID of the current session
-     */
-    getInstanceId(): string;
-    /**
-     * Returns a new message collector for the chat which is related to the first parameter c
-     * @param c The Mesasge/Chat or Chat Id to base this message colletor on
-     * @param filter A function that consumes a [Message] and returns a boolean which determines whether or not the message shall be collected.
-     * @param options The options for the collector. For example, how long the collector shall run for, how many messages it should collect, how long between messages before timing out, etc.
-     */
-    createMessageCollector(c: Message | ChatId | Chat, filter: CollectorFilter<[Message]>, options: CollectorOptions): MessageCollector;
-    /**
-     * [FROM DISCORDJS]
-     * Similar to createMessageCollector but in promise form.
-     * Resolves with a collection of messages that pass the specified filter.
-     * @param c The Mesasge/Chat or Chat Id to base this message colletor on
-     * @param {CollectorFilter} filter The filter function to use
-     * @param {AwaitMessagesOptions} [options={}] Optional options to pass to the internal collector
-     * @returns {Promise<Collection<string, Message>>}
-     * @example
-     * ```javascript
-     * // Await !vote messages
-     * const filter = m => m.body.startsWith('!vote');
-     * // Errors: ['time'] treats ending because of the time limit as an error
-     * channel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })
-     *   .then(collected => console.log(collected.size))
-     *   .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));
-     * ```
-     */
-    awaitMessages(c: Message | ChatId | Chat, filter: CollectorFilter<[Message]>, options?: AwaitMessagesOptions): Promise<Collection<string, Message>>;
-}
-export { useragent } from '../config/puppeteer.config';