### Basic Client Initialization and Event Handling

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/README.md

Initialize the client, generate a QR code for authentication, and handle 'ready' and 'message' events. This is a fundamental example for starting with the library.

```javascript
const { Client } = require('whatsapp-web.js');
const qrcode = require('qrcode-terminal');

const client = new Client();

client.on('qr', (qr) => {
    qrcode.generate(qr, { small: true });
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', (msg) => {
    if (msg.body == '!ping') {
        msg.reply('pong');
    }
});

client.initialize();
```

--------------------------------

### Install whatsapp-web.js

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Install the library using npm, yarn, or pnpm. Node.js v18.0.0 or higher is required.

```bash
npm install whatsapp-web.js
```

```bash
yarn add whatsapp-web.js
```

```bash
pnpm add whatsapp-web.js
```

--------------------------------

### Install whatsapp-web.js

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/README.md

Install the library using npm, yarn, or pnpm. Node.js v18.0.0 or higher is required.

```sh
npm install whatsapp-web.js
yarn add whatsapp-web.js
pnpm add whatsapp-web.js
```

--------------------------------

### initialize

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.html

Initializes the client, setting up event listeners and starting the authentication process.

```APIDOC
## initialize()

### Description
Sets up events and requirements, kicks off authentication request

### Method
async
```

--------------------------------

### Client#getLabels()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all labels.

```APIDOC
## Client#getLabels()

### Description
Gets all labels.

### Method
`getLabels`

### Returns
`Promise<Array<Label>>` - A promise that resolves to an array of label objects.
```

--------------------------------

### Client#getState()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets the current state of the client.

```APIDOC
## Client#getState()

### Description
Gets the current state of the client.

### Method
`getState`

### Returns
`Promise<string>` - A promise that resolves to the current state (e.g., 'CONNECTED', 'DISCONNECTED', 'PAIRING').
```

--------------------------------

### ready

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.html

Emitted when the client has finished its initialization process and is ready to start receiving and sending messages.

```APIDOC
## Event: ready

### Description
Emitted when the client has initialized and is ready to receive messages.
```

--------------------------------

### Get Contact Country Code

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_Contact.js.html

Extracts and returns the country code from the contact's ID. For example, '1541859685@c.us' would return '1'.

```javascript
async getCountryCode() {
            return await this.client.getCountryCode(this.id._serialized);
        }
```

--------------------------------

### createCallLink

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.js.html

Generates a WhatsApp call link for either a video or voice call, specifying the desired start time.

```APIDOC
## createCallLink

### Description
Generates a WhatsApp call link for either a video or voice call, specifying the desired start time.

### Method
```javascript
async createCallLink(startTime, callType)
```

### Parameters
#### Arguments
* **startTime** (Date) - Required - The start time of the call.
* **callType** (string) - Required - The type of WhatsApp call link to generate. Valid values are: `video` | `voice`.

### Returns
* **Promise&lt;string&gt;** - The WhatsApp call link (e.g., `https://call.whatsapp.com/video/XxXxXxXxXxXxXx`) or an empty string if generation failed.

### Throws
* **Error** - If an invalid `callType` is provided.
```

--------------------------------

### Client#initialize()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Initializes the client and connects to WhatsApp.

```APIDOC
## Client#initialize()

### Description
Initializes the client and connects to WhatsApp.

### Method
`initialize`

### Returns
`Promise<void>` - A promise that resolves when the client has successfully initialized.
```

--------------------------------

### Get Message by ID

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_Message.js.html

Retrieves a message by its ID. It first tries to get the message directly, and if not found, it attempts to fetch it from a list of messages.

```javascript
window.require('WAWebCollections').Msg.get(msgId) ||
                        (await window.require('WAWebCollections').Msg.getMessagesById([msgId]))?.messages?.[0];
```

--------------------------------

### Get Labels for a Chat - whatsapp-web.js

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Utils.js.html

Retrieves all labels associated with a specific chat. It first gets the chat object and then maps its label IDs to label objects.

```javascript
window.WWebJS.getChatLabels = async (chatId) => {
            const chat = await window.WWebJS.getChat(chatId);
            return (chat.labels || []).map((id) => window.WWebJS.getLabel(id));
        };
```

--------------------------------

### Basic Client Initialization and Event Handling

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Initialize the client, handle QR code generation, and respond to messages. The client requires initialization to connect to WhatsApp Web.

```javascript
const { Client } = require('whatsapp-web.js');
const qrcode = require('qrcode-terminal');

const client = new Client();

client.on('qr', (qr) => {
    qrcode.generate(qr, { small: true });
});

client.on('ready', () => {
    console.log('Client is ready!');
});

client.on('message', (msg) => {
    if (msg.body == '!ping') {
        msg.reply('pong');
    }
});

client.initialize();

```

--------------------------------

### MessageMedia Constructor

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/MessageMedia.html

Initializes a new MessageMedia instance with media details.

```APIDOC
## new MessageMedia(mimetype, data, filename, filesize)

### Description
Initializes a new MessageMedia instance with the provided media details.

### Parameters

- **mimetype** (string) - Required - MIME type of the attachment.
- **data** (string) - Required - Base64-encoded data of the file.
- **filename** (nullable string) - Optional - Document file name. Can be null.
- **filesize** (nullable number) - Optional - Document file size in bytes. Can be null.
```

--------------------------------

### getCustomerNote

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/GroupChat.html

Get a customer note.

```APIDOC
## getCustomerNote()

### Description
Get a customer note.

### Inherited from
[Chat#getCustomerNote](Chat.html#getCustomerNote)

### See also
[https://faq.whatsapp.com/1433099287594476](https://faq.whatsapp.com/1433099287594476)
```

--------------------------------

### Initialize Browser and Page

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.js.html

Sets up the Puppeteer browser and page instances, configures proxy authentication, user agent, and bypasses CSP if enabled. It then navigates to the WhatsApp URL and injects necessary scripts.

```javascript
            if (this.options.proxyAuthentication !== undefined) {
                await page.authenticate(this.options.proxyAuthentication);
            }
            if (this.options.userAgent !== false) {
                await page.setUserAgent(this.options.userAgent);
            }
            if (this.options.bypassCSP) await page.setBypassCSP(true);
    
            this.pupBrowser = browser;
            this.pupPage = page;
    
            await this.authStrategy.afterBrowserInitialized();
            await this.initWebVersionCache();
    
            if (this.options.evalOnNewDoc !== undefined) {
                await page.evaluateOnNewDocument(this.options.evalOnNewDoc);
            }
    
            await page.goto(WhatsWebURL, {
                waitUntil: 'load',
                timeout: 0,
                referer: 'https://whatsapp.com/',
            });
    
            await this.inject();
```

--------------------------------

### Client#getContacts()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all contacts the client has.

```APIDOC
## Client#getContacts()

### Description
Gets all contacts the client has.

### Method
`getContacts`

### Returns
`Promise<Array<Contact>>` - A promise that resolves to an array of contact objects.
```

--------------------------------

### Initialize Settings Module

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the Settings module by merging general user preferences and notification settings, and setting the push name.

```javascript
window.Store.Settings = {
            ...window.require('WAWebUserPrefsGeneral'),
            ...window.require('WAWebUserPrefsNotifications'),
            setPushname: window.require('WAWebSetPushnameConnAction').setPushname
        };
```

--------------------------------

### Initialize LocalWebCache

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/webCache_LocalWebCache.js.html

Instantiate LocalWebCache with custom path and strict mode options. The default cache path is './.wwebjs_cache/'.

```javascript
const { LocalWebCache } = require('./webCache/LocalWebCache');

const cache = new LocalWebCache({
    path: './my_cache/',
    strict: true
});
```

--------------------------------

### Client#getChats()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all chats the client has.

```APIDOC
## Client#getChats()

### Description
Gets all chats the client has.

### Method
`getChats`

### Returns
`Promise<Array<Chat>>` - A promise that resolves to an array of chat objects.
```

--------------------------------

### Initialize Sticker Tools Module

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the StickerTools module with image utilities and WebP metadata handling for sticker creation.

```javascript
window.Store.StickerTools = {
            ...window.require('WAWebImageUtils'),
            ...window.require('WAWebAddWebpMetadata')
        };
```

--------------------------------

### Client#getBroadcasts()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all broadcast lists.

```APIDOC
## Client#getBroadcasts()

### Description
Gets all broadcast lists.

### Method
`getBroadcasts`

### Returns
`Promise<Array<Broadcast>>` - A promise that resolves to an array of broadcast lists.
```

--------------------------------

### getState

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.js.html

Gets the current connection state for the client.

```APIDOC
## getState

### Description
Gets the current connection state for the client.

### Method
GET

### Endpoint
/client/state

### Parameters
None

### Response
#### Success Response (200)
- **state** (WAState) - The current state of the WebSocket connection.

### Response Example
```json
{
  "state": "CONNECTED"
}
```
```

--------------------------------

### Client Initialization

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Client.js.html

Initializes a new Client instance. The constructor accepts an options object to configure various aspects of the client, such as authentication strategy, web version, and Puppeteer settings.

```APIDOC
## Client Constructor

### Description
Initializes a new Client instance. The constructor accepts an options object to configure various aspects of the client, such as authentication strategy, web version, and Puppeteer settings.

### Parameters
#### Options Object
- **authStrategy** (AuthStrategy) - Determines how to save and restore sessions. If not set, NoAuth will be used.
- **webVersion** (string) - The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved.
- **webVersionCache** (object) - Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found.
- **authTimeoutMs** (number) - Timeout for authentication selector in puppeteer
- **evalOnNewDoc** (function) - function to eval on new doc
- **puppeteer** (object) - Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/
- **qrMaxRetries** (number) - How many times should the qrcode be refreshed before giving up
- **takeoverOnConflict** (number) - If another whatsapp web session is detected (another browser), take over the session in the current browser
- **takeoverTimeoutMs** (number) - How much time to wait before taking over the session
- **userAgent** (string) - User agent to use in puppeteer
- **ffmpegPath** (string) - Ffmpeg path to use when formatting videos to webp while sending stickers
- **bypassCSP** (boolean) - Sets bypassing of page's Content-Security-Policy.
- **deviceName** (string) - Sets the device name of a current linked device., i.e.: 'TEST'.
- **browserName** (string) - Sets the browser name of a current linked device, i.e.: 'Firefox'.
- **proxyAuthentication** (object) - Proxy Authentication object.

### Events
- Client#qr
- Client#authenticated
- Client#auth_failure
- Client#ready
- Client#message
- Client#message_ack
- Client#message_create
- Client#message_revoke_me
- Client#message_revoke_everyone
- Client#message_ciphertext
- Client#message_edit
- Client#media_uploaded
- Client#group_join
- Client#group_leave
- Client#group_update
- Client#disconnected
- Client#change_state
- Client#contact_changed
- Client#group_admin_changed
- Client#group_membership_request
- Client#vote_update
```

--------------------------------

### Client#event:ready

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Emitted when the client is ready and has successfully connected to WhatsApp.

```APIDOC
## Client#event:ready

### Description
Emitted when the client is ready and has successfully connected to WhatsApp.

### Event
`ready`
```

--------------------------------

### Client#getMessageById(messageId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a message by its ID.

```APIDOC
## Client#getMessageById(messageId)

### Description
Gets a message by its ID.

### Method
`getMessageById`

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the message.

### Returns
`Promise<Message>` - A promise that resolves to the message object.
```

--------------------------------

### Configure Chat and Backend Utilities

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected.js.html

Sets up chat finding logic, backend detection, and feature flags for the WhatsApp Web environment.

```javascript
if (!window.Store.Chat._find) {
            window.Store.Chat._find = e => {
                const target = window.Store.Chat.get(e);
                return target ? Promise.resolve(target) : Promise.resolve({
                    id: e
                });
            };
        }
        
        // eslint-disable-next-line no-undef
        if ((m = window.mR.findModule('ChatCollection')[0]) && m.ChatCollection && typeof m.ChatCollection.findImpl === 'undefined' && typeof m.ChatCollection._find !== 'undefined') m.ChatCollection.findImpl = m.ChatCollection._find;
    
        // TODO remove these once everybody has been updated to WWebJS with legacy sessions removed
        const _linkPreview = window.mR.findModule('queryLinkPreview');
        if (_linkPreview && _linkPreview[0] && _linkPreview[0].default) {
            window.Store.Wap = _linkPreview[0].default;
        }
    
        const _isMDBackend = window.mR.findModule('isMDBackend');
        if(_isMDBackend && _isMDBackend[0] && _isMDBackend[0].isMDBackend) {
            window.Store.MDBackend = _isMDBackend[0].isMDBackend();
        } else {
            window.Store.MDBackend = true;
        }
    
        const _features = window.mR.findModule('FEATURE_CHANGE_EVENT')[0];
        if(_features) {
            window.Store.Features = _features.LegacyPhoneFeatures;
        }
```

--------------------------------

### Client#getLabelById(labelId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a label by its ID.

```APIDOC
## Client#getLabelById(labelId)

### Description
Gets a label by its ID.

### Method
`getLabelById`

### Parameters
#### Path Parameters
- **labelId** (string) - Required - The ID of the label.

### Returns
`Promise<Label>` - A promise that resolves to the label object.
```

--------------------------------

### Client#getContactById(contactId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a contact by their ID.

```APIDOC
## Client#getContactById(contactId)

### Description
Gets a contact by their ID.

### Method
`getContactById`

### Parameters
#### Path Parameters
- **contactId** (string) - Required - The ID of the contact.

### Returns
`Promise<Contact>` - A promise that resolves to the contact object.
```

--------------------------------

### Expose Store and Version Comparison Utility

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the global 'Store' object with various WhatsApp Web modules and defines a 'compareWwebVersions' helper on the window object.

```javascript
'use strict';

exports.ExposeStore = () => {
    /**
     * Helper function that compares between two WWeb versions. Its purpose is to help the developer to choose the correct code implementation depending on the comparison value and the WWeb version.
     * @param {string} lOperand The left operand for the WWeb version string to compare with
     * @param {string} operator The comparison operator
     * @param {string} rOperand The right operand for the WWeb version string to compare with
     * @returns {boolean} Boolean value that indicates the result of the comparison
     */
    window.compareWwebVersions = (lOperand, operator, rOperand) => {
        if (!['>', '>=', '&lt;', '&lt;=', '='].includes(operator)) {
            throw new class _ extends Error {
                constructor(m) { super(m); this.name = 'CompareWwebVersionsError'; }
            }('Invalid comparison operator is provided');

        }
        if (typeof lOperand !== 'string' || typeof rOperand !== 'string') {
            throw new class _ extends Error {
                constructor(m) { super(m); this.name = 'CompareWwebVersionsError'; }
            }('A non-string WWeb version type is provided');
        }

        lOperand = lOperand.replace(/-beta$/, '');
        rOperand = rOperand.replace(/-beta$/, '');

        while (lOperand.length !== rOperand.length) {
            lOperand.length > rOperand.length
                ? rOperand = rOperand.concat('0')
                : lOperand = lOperand.concat('0');
        }

        lOperand = Number(lOperand.replace(/\./g, ''));
        rOperand = Number(rOperand.replace(/\./g, ''));

        return (
            operator === '>' ? lOperand > rOperand :
                operator === '>=' ? lOperand >= rOperand :
                    operator === '&lt;' ? lOperand &lt; rOperand :
                        operator === '&lt;=' ? lOperand &lt;= rOperand :
                            operator === '=' ? lOperand === rOperand :
                                false
        );
    };

    window.Store = Object.assign({}, window.require('WAWebCollections'));
    window.Store.AppState = window.require('WAWebSocketModel').Socket;
    window.Store.BlockContact = window.require('WAWebBlockContactAction');
    window.Store.Conn = window.require('WAWebConnModel').Conn;
    window.Store.Cmd = window.require('WAWebCmd').Cmd;
    window.Store.DownloadManager = window.require('WAWebDownloadManager').downloadManager;
    window.Store.GroupQueryAndUpdate = window.require('WAWebGroupQueryJob').queryAndUpdateGroupMetadataById;
    window.Store.MediaPrep = window.require('WAWebPrepRawMedia');
    window.Store.MediaObject = window.require('WAWebMediaStorage');
    window.Store.MediaTypes = window.require('WAWebMmsMediaTypes');
    window.Store.MediaUpload = {
        ...window.require('WAWebMediaMmsV4Upload'),
        ...window.require('WAWebStartMediaUploadQpl')
    };
    window.Store.MediaUpdate = window.require('WAWebMediaUpdateMsg');
    window.Store.MsgKey = window.require('WAWebMsgKey');
    window.Store.OpaqueData = window.require('WAWebMediaOpaqueData');
    window.Store.QueryProduct = window.require('WAWebBizProductCatalogBridge');
    window.Store.QueryOrder = window.require('WAWebBizOrderBridge');
    window.Store.SendClear = window.require('WAWebChatClearBridge');
    window.Store.SendDelete = window.require('WAWebDeleteChatAction');
    window.Store.SendMessage = window.require('WAWebSendMsgChatAction');
    window.Store.EditMessage = window.require('WAWebSendMessageEditAction');
    window.Store.MediaDataUtils = window.require('WAWebMediaDataUtils');
    window.Store.BlobCache = window.require('WAWebMediaInMemoryBlobCache');
    window.Store.SendSeen = window.require('WAWebUpdateUnreadChatAction');
    window.Store.User = window.require('WAWebUserPrefsMeUser');
    window.Store.ContactMethods = {
        ...window.require('WAWebContactGetters'),
        ...window.require('WAWebFrontendContactGetters')
    };
    window.Store.UserConstructor = window.require('WAWebWid');
    window.Store.Validators = window.require('WALinkify');
    window.Store.WidFactory = window.require('WAWebWidFactory');
    window.Store.ProfilePic = window.require('WAWebContactProfilePicThumbBridge');
    window.Store.PresenceUtils = window.require('WAWebPresenceChatAction');
    window.Store.ChatState = window.require('WAWebChatStateBridge');
};
```

--------------------------------

### Initialize WhatsApp Web Store Modules

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected.js.html

Maps internal WhatsApp Web modules to the global window.Store object for easier access to utilities like DrawerManager, GroupUtils, and messaging tools.

```javascript
window.Store.DrawerManager = window.mR.findModule('DrawerManager')[0].DrawerManager;
        window.Store.LidUtils = window.mR.findModule('getCurrentLid')[0];
        window.Store.WidToJid = window.mR.findModule('widToUserJid')[0];
        window.Store.JidToWid = window.mR.findModule('userJidToUserWid')[0];
        
        /* eslint-disable no-undef, no-cond-assign */
        window.Store.QueryExist = ((m = window.mR.findModule('queryExists')[0]) ? m.queryExists : window.mR.findModule('queryExist')[0].queryWidExists);
        window.Store.ReplyUtils = (m = window.mR.findModule('canReplyMsg')).length > 0 && m[0];
        /* eslint-enable no-undef, no-cond-assign */
    
        window.Store.StickerTools = {
            ...window.mR.findModule('toWebpSticker')[0],
            ...window.mR.findModule('addWebpMetadata')[0]
        };
        window.Store.GroupUtils = {
            ...window.mR.findModule('createGroup')[0],
            ...window.mR.findModule('setGroupDescription')[0],
            ...window.mR.findModule('sendExitGroup')[0],
            ...window.mR.findModule('sendSetPicture')[0]
        };
        window.Store.GroupParticipants = {
            ...window.mR.findModule('promoteParticipants')[0],
            ...window.mR.findModule('sendAddParticipantsRPC')[0]
        };
        window.Store.GroupInvite = {
            ...window.mR.findModule('resetGroupInviteCode')[0],
            ...window.mR.findModule('queryGroupInvite')[0]
        };
        window.Store.GroupInviteV4 = {
            ...window.mR.findModule('queryGroupInviteV4')[0],
            ...window.mR.findModule('sendGroupInviteMessage')[0]
        };
        window.Store.MembershipRequestUtils = {
            ...window.mR.findModule('getMembershipApprovalRequests')[0],
            ...window.mR.findModule('sendMembershipRequestsActionRPC')[0]
        };
```

--------------------------------

### Client#getChatById(chatId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a chat by its ID.

```APIDOC
## Client#getChatById(chatId)

### Description
Gets a chat by its ID.

### Method
`getChatById`

### Parameters
#### Path Parameters
- **chatId** (string) - Required - The ID of the chat.

### Returns
`Promise<Chat>` - A promise that resolves to the chat object.
```

--------------------------------

### Execute Test Suite

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/tests/README.md

Run the project tests using the npm test command.

```bash
npm test
```

--------------------------------

### Client#getChannels()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all channels the client is a part of.

```APIDOC
## Client#getChannels()

### Description
Gets all channels the client is a part of.

### Method
`getChannels`

### Returns
`Promise<Array<Channel>>` - A promise that resolves to an array of channel objects.
```

--------------------------------

### Client#getBlockedContacts()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a list of blocked contacts.

```APIDOC
## Client#getBlockedContacts()

### Description
Gets a list of blocked contacts.

### Method
`getBlockedContacts`

### Returns
`Promise<Array<Contact>>` - A promise that resolves to an array of blocked contacts.
```

--------------------------------

### Initialize ClientInfo

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_ClientInfo.js.html

Initializes the ClientInfo class with client and data. The _patch method is called if data is provided.

```javascript
constructor(client, data) {
            super(client);

            if (data) this._patch(data);
        }
```

--------------------------------

### getFormattedNumber()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_Contact.js.html

Gets the formatted phone number for the contact.

```APIDOC
## getFormattedNumber()

### Description
Returns the contact's formatted phone number, e.g., (+1 (234) 5678-901).

### Method
`getFormattedNumber()`

### Returns
- Promise<string> - The formatted phone number.
```

--------------------------------

### Initialize Store Module Utilities

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_LegacyStore.js.html

Initializes various utility functions within the window.Store object by finding and assigning them from the mR module. This includes message info, pinning, query existence, reply utilities, settings, sticker tools, group utilities, participant management, and invite handling.

```javascript
window.Store.getMsgInfo = (window.mR.findModule('sendQueryMsgInfo')[0] || {}).sendQueryMsgInfo || window.mR.findModule('queryMsgInfo')[0].queryMsgInfo;
        window.Store.pinUnpinMsg = window.mR.findModule('sendPinInChatMsg')[0].sendPinInChatMsg;
        
        /* eslint-disable no-undef, no-cond-assign */
        window.Store.QueryExist = ((m = window.mR.findModule('queryExists')[0]) ? m.queryExists : window.mR.findModule('queryExist')[0].queryWidExists);
        window.Store.ReplyUtils = (m = window.mR.findModule('canReplyMsg')).length > 0 &amp;&amp; m[0];
        /* eslint-enable no-undef, no-cond-assign */
    
        window.Store.Settings = {
            ...window.mR.findModule('ChatlistPanelState')[0],
            setPushname: window.mR.findModule((m) => m.setPushname &amp;&amp; !m.ChatlistPanelState)[0].setPushname
        };
        window.Store.StickerTools = {
            ...window.mR.findModule('toWebpSticker')[0],
            ...window.mR.findModule('addWebpMetadata')[0]
        };
        window.Store.GroupUtils = {
            ...window.mR.findModule('createGroup')[0],
            ...window.mR.findModule('setGroupDescription')[0],
            ...window.mR.findModule('sendExitGroup')[0],
            ...window.mR.findModule('sendSetPicture')[0]
        };
        window.Store.GroupParticipants = {
            ...window.mR.findModule('promoteParticipants')[0],
            ...window.mR.findModule('sendAddParticipantsRPC')[0]
        };
        window.Store.GroupInvite = {
            ...window.mR.findModule('resetGroupInviteCode')[0],
            ...window.mR.findModule('queryGroupInvite')[0]
        };
        window.Store.GroupInviteV4 = {
            ...window.mR.findModule('queryGroupInviteV4')[0],
            ...window.mR.findModule('sendGroupInviteMessage')[0]
        };
        window.Store.MembershipRequestUtils = {
            ...window.mR.findModule('getMembershipApprovalRequests')[0],
            ...window.mR.findModule('sendMembershipRequestsActionRPC')[0]
        };
```

--------------------------------

### getSubscribers

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_Channel.js.html

Gets the subscribers of the channel (only those who are in your contact list).

```APIDOC
/**
 * Gets the subscribers of the channel (only those who are in your contact list)
 * @param {?number} limit Optional parameter to specify the limit of subscribers to retrieve
 * @returns {Promise&lt;Array&lt;{contact: Contact, role: string}>>} Returns an array of objects that handle the subscribed contacts and their roles in the channel
 */
async getSubscribers(limit) {
    return await this.client.pupPage.evaluate(
        async (channelId, limit) => {
            const channel = await window.WWebJS.getChat(channelId, {
                getAsModel: false,
            });
            if (!channel) return [];
            !limit &&
                (limit = window
                    .require('WAWebNewsletterGatingUtils')
                    .getMaxSubscriberNumber());
            const response = await window
                .require('WAWebMexFetchNewsletterSubscribersJob')
                .mexFetchNewsletterSubscribers(channelId, limit);
            const contacts = window
                .require('WAWebNewsletterSubscriberListAction')
                .getSubscribersInContacts(response.subscribers);
            return Promise.all(
                contacts.map((obj) => ({
                    ...obj,
                    contact: window.WWebJS.getContactModel(obj.contact),
                })),
            );
        },
        this.id._serialized,
        limit,
    );
}
```

--------------------------------

### window.WWebJS Static Methods

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Utility methods available on the window.WWebJS object.

```APIDOC
## window.WWebJS Static Methods

### Description
Utility methods available on the window.WWebJS object.

### Methods

- **compareWwebVersions(lOperand, operator, rOperand)**: Compares two wweb.js versions.
- **injectToFunction(target, callback)**: Injects a callback function into a target function.
```

--------------------------------

### Initialize Store Module Utilities

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes various utility functions and modules within the window.Store object. These are typically used for internal WhatsApp Web operations.

```javascript
window.Store.findCommonGroups = window.require('WAWebFindCommonGroupsContactAction').findCommonGroups;
        window.Store.ConversationMsgs = window.require('WAWebChatLoadMessages');
        window.Store.sendReactionToMsg = window.require('WAWebSendReactionMsgAction').sendReactionToMsg;
        window.Store.createOrUpdateReactionsModule = window.require('WAWebDBCreateOrUpdateReactions');
        window.Store.EphemeralFields = window.require('WAWebGetEphemeralFieldsMsgActionsUtils');
        window.Store.MsgActionChecks = window.require('WAWebMsgActionCapability');
        window.Store.QuotedMsg = window.require('WAWebQuotedMsgModelUtils');
        window.Store.LinkPreview = window.require('WAWebLinkPreviewChatAction');
        window.Store.Socket = window.require('WADeprecatedSendIq');
        window.Store.SocketWap = window.require('WAWap');
        window.Store.SearchContext = window.require('WAWebChatMessageSearch');
        window.Store.DrawerManager = window.require('WAWebDrawerManager').DrawerManager;
        window.Store.LidUtils = window.require('WAWebApiContact');
        window.Store.WidToJid = window.require('WAWebWidToJid');
        window.Store.JidToWid = window.require('WAWebJidToWid');
        window.Store.getMsgInfo = window.require('WAWebApiMessageInfoStore').queryMsgInfo;
        window.Store.QueryExist = window.require('WAWebQueryExistsJob').queryWidExists;
        window.Store.ReplyUtils = window.require('WAWebMsgReply');
        window.Store.BotSecret = window.require('WAWebBotMessageSecret');
        window.Store.BotProfiles = window.require('WAWebBotProfileCollection');
        window.Store.ContactCollection = window.require('WAWebContactCollection').ContactCollection;
        window.Store.DeviceList = window.require('WAWebApiDeviceList');
        window.Store.HistorySync = window.require('WAWebSendNonMessageDataRequest');
        window.Store.AddonReactionTable = window.require('WAWebAddonReactionTableMode').reactionTableMode;
        window.Store.AddonPollVoteTable = window.require('WAWebAddonPollVoteTableMode').pollVoteTableMode;
        window.Store.ChatGetters = window.require('WAWebChatGetters');
        window.Store.UploadUtils = window.require('WAWebUploadManager');
        window.Store.WAWebStreamModel = window.require('WAWebStreamModel');
        window.Store.FindOrCreateChat = window.require('WAWebFindChatAction');
        window.Store.CustomerNoteUtils = window.require('WAWebNoteAction');
        window.Store.BusinessGatingUtils = window.require('WAWebBizGatingUtils');
        window.Store.PollsVotesSchema = window.require('WAWebPollsVotesSchema');
        window.Store.PollsSendVote = window.require('WAWebPollsSendVoteMsgAction');
```

--------------------------------

### Client#getWWebVersion()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets the current version of WhatsApp Web.

```APIDOC
## Client#getWWebVersion()

### Description
Gets the current version of WhatsApp Web.

### Method
`getWWebVersion`

### Returns
`Promise<string>` - A promise that resolves to the WhatsApp Web version string.
```

--------------------------------

### Client#getPinnedMessages(chatId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all pinned messages in a chat.

```APIDOC
## Client#getPinnedMessages(chatId)

### Description
Gets all pinned messages in a chat.

### Method
`getPinnedMessages`

### Parameters
#### Path Parameters
- **chatId** (string) - Required - The ID of the chat.

### Returns
`Promise<Array<Message>>` - A promise that resolves to an array of pinned messages.
```

--------------------------------

### MessageMedia.fromFilePath

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/MessageMedia.html

Creates a MessageMedia instance from a local file path.

```APIDOC
## MessageMedia.fromFilePath(filePath)

### Description
Creates a MessageMedia instance by reading data from a local file path.

### Method
`static`

### Parameters

- **filePath** (string) - Required - The path to the local file.

### Returns

- `MessageMedia` - A new MessageMedia instance.
```

--------------------------------

### LocalWebCache Constructor

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/LocalWebCache.html

Initializes a new instance of LocalWebCache. You can configure the cache path and error handling behavior through the options object.

```APIDOC
## new LocalWebCache(options)

### Description
Initializes a new instance of the LocalWebCache class.

### Parameters

#### options
- **path** (string, Optional) - Path to the directory where cached versions are saved. Defaults to "./.wwebjs_cache/".
- **strict** (boolean, Optional) - If true, will throw an error if the requested version can't be fetched. If false, will resolve to the latest version.
```

--------------------------------

### Client#getInviteInfo(inviteCode)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets information about a group invite.

```APIDOC
## Client#getInviteInfo(inviteCode)

### Description
Gets information about a group invite.

### Method
`getInviteInfo`

### Parameters
#### Path Parameters
- **inviteCode** (string) - Required - The invite code.

### Returns
`Promise<InviteInfo>` - A promise that resolves to the invite information.
```

--------------------------------

### Initialize Forward Utils Module

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the ForwardUtils module for handling chat message forwarding.

```javascript
window.Store.ForwardUtils = {
            ...window.require('WAWebChatForwardMessage')
        };
```

--------------------------------

### Client#getFormattedNumber(number)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets the formatted phone number.

```APIDOC
## Client#getFormattedNumber(number)

### Description
Gets the formatted phone number.

### Method
`getFormattedNumber`

### Parameters
#### Path Parameters
- **number** (string) - Required - The phone number.

### Returns
`Promise<string>` - A promise that resolves to the formatted phone number.
```

--------------------------------

### RemoteWebCache Constructor

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/RemoteWebCache.html

Initializes a new instance of RemoteWebCache. This class fetches a WhatsApp Web version index from a remote server.

```APIDOC
## new RemoteWebCache(options)

### Description
Initializes a new instance of RemoteWebCache to fetch a WhatsApp Web version index from a remote server.

### Parameters
#### Options
- **remotePath** (string) - Required - The endpoint to fetch the version index from. Use `{version}` as a placeholder for the version number.
- **strict** (boolean) - Optional - If true, throws an error if the requested version cannot be fetched. If false, resolves to the latest version. Defaults to false.
```

--------------------------------

### GET /getContact

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected.js.html

Retrieves a specific contact model by its ID.

```APIDOC
## GET /getContact

### Description
Fetches a serialized contact object for a given contact ID.

### Method
GET

### Parameters
#### Query Parameters
- **contactId** (string) - Required - The unique identifier of the contact.

### Response
#### Success Response (200)
- **res** (object) - Serialized contact model including business profile and status flags.
```

--------------------------------

### RemoteWebCache Constructor

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/webCache_RemoteWebCache.js.html

Initializes RemoteWebCache with a remote path for fetching version indexes. The remotePath must include a {version} placeholder. Strict mode can be enabled to throw errors if a version cannot be fetched.

```javascript
class RemoteWebCache extends WebCache {
    constructor(options = {}) {
        super();

        if (!options.remotePath)
            throw new Error(
                'webVersionCache.remotePath is required when using the remote cache',
            );
        this.remotePath = options.remotePath;
        this.strict = options.strict || false;
    }

    async resolve(version) {
        const remotePath = this.remotePath.replace('{version}', version);

        try {
            const cachedRes = await fetch(remotePath);
            if (cachedRes.ok) {
                return cachedRes.text();
            }
        } catch (err) {
            console.error(`Error fetching version ${version} from remote`, err);
        }

        if (this.strict)
            throw new VersionResolveError(
                `Couldn't load version ${version} from the archive`,
            );
        return null;
    }

    async persist() {
        // Nothing to do here
    }
}
```

--------------------------------

### GET /getChats

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected.js.html

Retrieves an array of all available chat models.

```APIDOC
## GET /getChats

### Description
Returns a list of all chats currently loaded in the client.

### Method
GET

### Response
#### Success Response (200)
- **chats** (array) - List of serialized chat objects.
```

--------------------------------

### Client#getBroadcastById(contactId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets a broadcast list by its ID.

```APIDOC
## Client#getBroadcastById(contactId)

### Description
Gets a broadcast list by its ID.

### Method
`getBroadcastById`

### Parameters
#### Path Parameters
- **contactId** (string) - Required - The ID of the broadcast list.

### Returns
`Promise<Broadcast>` - A promise that resolves to the broadcast list object.
```

--------------------------------

### Initialize Number Info Module

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the NumberInfo module with phone utilities and country code finding functionalities.

```javascript
window.Store.NumberInfo = {
            ...window.require('WAPhoneUtils'),
            ...window.require('WAPhoneFindCC')
        };
```

--------------------------------

### GET /getChat

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected.js.html

Retrieves a specific chat model by its ID.

```APIDOC
## GET /getChat

### Description
Fetches a serialized chat object for a given chat ID.

### Method
GET

### Parameters
#### Query Parameters
- **chatId** (string) - Required - The unique identifier of the chat.

### Response
#### Success Response (200)
- **res** (object) - Serialized chat model including metadata and last message.
```

--------------------------------

### Initialize Membership Request Utils Module

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/util_Injected_Store.js.html

Initializes the MembershipRequestUtils module, likely for handling join requests for groups.

```javascript
window.Store.MembershipRequestUtils = {
```

--------------------------------

### getBroadcast()

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/Contact.html

Gets the Contact's current status broadcast.

```APIDOC
## getBroadcast()

### Description
Gets the Contact's current status broadcast.

### Method
`GET`

### Endpoint
`/broadcast`

### Returns
`Promise<Broadcast>` - The contact's broadcast information.
```

--------------------------------

### RemoteAuth Constructor Options

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/authStrategies_RemoteAuth.js.html

Defines the options available when initializing the RemoteAuth strategy. Requires a remote database store and specifies parameters for client ID, data path, backup intervals, and retry counts.

```javascript
/**
 * Remote-based authentication
 * @param {object} options - options
 * @param {object} options.store - Remote database store instance
 * @param {string} options.clientId - Client id to distinguish instances if you are using multiple, otherwise keep null if you are using only one instance
 * @param {string} options.dataPath - Change the default path for saving session files, default is: "./.wwebjs_auth/"
 * @param {number} options.backupSyncIntervalMs - Sets the time interval for periodic session backups. Accepts values starting from 60000ms {1 minute}
 * @param {number} options.rmMaxRetries - Sets the maximum number of retries for removing the session directory
 */
class RemoteAuth extends BaseAuthStrategy {
    constructor({
        clientId,
        dataPath,
        store,
        backupSyncIntervalMs,
        rmMaxRetries,
    } = {}) {
        // ... constructor logic ...
    }
    // ... other methods ...
}
```

--------------------------------

### Client#getPollVotes(messageId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets the votes for a given poll message.

```APIDOC
## Client#getPollVotes(messageId)

### Description
Gets the votes for a given poll message.

### Method
`getPollVotes`

### Parameters
#### Path Parameters
- **messageId** (string) - Required - The ID of the poll message.

### Returns
`Promise<PollVote[]>` - A promise that resolves to an array of poll votes.
```

--------------------------------

### ProductMetadata Class Definition

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_ProductMetadata.js.html

Defines the ProductMetadata class, extending Base. It initializes properties like id, retailer_id, name, and description from the provided data.

```javascript
const Base = require('./Base');

class ProductMetadata extends Base {
    constructor(client, data) {
        super(client);

        if (data) this._patch(data);
    }

    _patch(data) {
        /** Product ID */
        this.id = data.id;
        /** Retailer ID */
        this.retailer_id = data.retailer_id;
        /** Product Name  */
        this.name = data.name;
        /** Product Description */
        this.description = data.description;

        return super._patch(data);
    }
}

module.exports = ProductMetadata;
```

--------------------------------

### Client#getContactDeviceCount(userId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets the number of devices a contact is registered on.

```APIDOC
## Client#getContactDeviceCount(userId)

### Description
Gets the number of devices a contact is registered on.

### Method
`getContactDeviceCount`

### Parameters
#### Path Parameters
- **userId** (string) - Required - The ID of the user.

### Returns
`Promise<number>` - A promise that resolves to the number of devices.
```

--------------------------------

### Product Class Definition

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/structures_Product.js.html

Defines the Product class, extending Base. It initializes product properties from provided data and includes a method to asynchronously fetch product metadata.

```javascript
"use strict";
    
    const Base = require('./Base');
    const ProductMetadata = require('./ProductMetadata');
    
    /**
     * Represents a Product on WhatsAppBusiness
     * @extends {Base}
     */
    class Product extends Base {
        constructor(client, data) {
            super(client);
    
            if (data) this._patch(data);
        }
    
        _patch(data) {
            /**
             * Product ID
             * @type {string}
             */
            this.id = data.id;
            /**
             * Price
             * @type {string}
             */
            this.price = data.price ? data.price : '';
            /**
             * Product Thumbnail
             * @type {string}
             */
            this.thumbnailUrl = data.thumbnailUrl;
            /**
             * Currency
             * @type {string}
             */
            this.currency = data.currency;
            /**
             * Product Name
             * @type {string}
             */
            this.name = data.name;
            /**
             * Product Quantity
             * @type {number}
             */
            this.quantity = data.quantity;
            /** Product metadata */
            this.data = null;
            return super._patch(data);
        }
    
        async getData() {
            if (this.data === null) {
                let result = await this.client.pupPage.evaluate((productId) => {
                    return window.WWebJS.getProductMetadata(productId);
                }, this.id);
                if (!result) {
                    this.data = undefined;
                } else {
                    this.data = new ProductMetadata(this.client, result);
                }
            }
            return this.data;
        }
    }
    
    module.exports = Product;
    
```

--------------------------------

### MessageMedia.fromUrl

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/MessageMedia.html

Creates a MessageMedia instance from a URL.

```APIDOC
## MessageMedia.fromUrl(url, options)

### Description
Creates a MessageMedia instance by fetching data from a given URL.

### Method
`async static`

### Parameters

- **url** (string) - Required - The URL of the media.
- **options** (object) - Optional - Configuration options for fetching the media.
  - **unsafeMime** (boolean) - Optional - If true, allows unsafe MIME types. Defaults to `false`.
  - **filename** (string) - Optional - The desired filename for the media.
  - **client** (object) - Optional - The client instance to use for the request.
  - **reqOptions** (object) - Optional - Additional request options.
    - **size** (number) - Optional - The expected size of the file. Defaults to `0`.

### Returns

- `Promise<MessageMedia>` - A promise that resolves with a new MessageMedia instance.
```

--------------------------------

### Client#getChatsByLabelId(labelId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all chats that have a specific label applied.

```APIDOC
## Client#getChatsByLabelId(labelId)

### Description
Gets all chats that have a specific label applied.

### Method
`getChatsByLabelId`

### Parameters
#### Path Parameters
- **labelId** (string) - Required - The ID of the label.

### Returns
`Promise<Array<Chat>>` - A promise that resolves to an array of chat objects.
```

--------------------------------

### Client#getChatLabels(chatId)

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/index.html

Gets all labels applied to a specific chat.

```APIDOC
## Client#getChatLabels(chatId)

### Description
Gets all labels applied to a specific chat.

### Method
`getChatLabels`

### Parameters
#### Path Parameters
- **chatId** (string) - Required - The ID of the chat.

### Returns
`Promise<Array<Label>>` - A promise that resolves to an array of labels.
```

--------------------------------

### Class: LegacySessionAuth

Source: https://github.com/wwebjs/whatsapp-web.js/blob/main/docs/LegacySessionAuth.html

Initializes a new instance of LegacySessionAuth. This strategy is not compatible with multi-device accounts.

```APIDOC
## new LegacySessionAuth(options)

### Description
Initializes a new instance of LegacySessionAuth. This strategy is not compatible with multi-device accounts.

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters

Name | Type | Optional | Description
---|---|---|---
options | options |  | Values in `options` have the following properties:

Name | Type | Optional | Description
---|---|---|---
restartOnAuthFail | boolean | Yes | Restart client with a new session (i.e. use null 'session' var) if authentication fails
session | object | Yes | Whatsapp session to restore. If not set, will start a new session

`session` object properties:

Name | Type | Optional | Description
---|---|---|---
session.WABrowserId | string | Yes | 
session.WASecretBundle | string | Yes | 
session.WAToken1 | string | Yes | 
session.WAToken2 | string | Yes | 

### Request Example
```json
{
  "options": {
    "restartOnAuthFail": true,
    "session": {
      "WABrowserId": "some-browser-id",
      "WASecretBundle": "some-secret-bundle",
      "WAToken1": "some-token-1",
      "WAToken2": "some-token-2"
    }
  }
}
```

### Response
#### Success Response (200)
This constructor does not return a value directly. It initializes the authentication strategy.

#### Response Example
None
```