talkyzap-wapp-api 1.0.0

package/dist/chat/functions/getReactions.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey } from '../../whatsapp';
+/**
+ * Get all reactions in a message
+ * @example
+ * ```javascript
+ * WPP.chat.getReactions('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function getReactions(msgId: string): Promise<{
+    reactionByMe: {
+        id: MsgKey;
+        orphan: number;
+        msgId: MsgKey;
+        reactionText: string;
+        read: boolean;
+        senderUserJid: string;
+        timestamp: number;
+    };
+    reactions: {
+        aggregateEmoji: string;
+        hasReactionByMe: boolean;
+        senders: {
+            id: MsgKey;
+            orphan: number;
+            msgId: MsgKey;
+            reactionText: string;
+            read: boolean;
+            senderUserJid: string;
+            timestamp: number;
+        }[];
+    }[];
+}>;

package/dist/chat/functions/getVotes.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, Wid } from '../../whatsapp';
+/**
+ * Get votes of a poll
+ * @example
+ * ```javascript
+ * WPP.chat.getVotes('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function getVotes(id: string | MsgKey): Promise<{
+    msgId: MsgKey;
+    chatId: Wid;
+    votes: {
+        selectedOptions: number[];
+        timestamp: number;
+        sender: Wid;
+    }[];
+}>;

package/dist/chat/functions/index.d.ts

@@ -0,0 +1,69 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { archive, unarchive } from './archive';
+export { canMarkPlayed } from './canMarkPlayed';
+export { canMute } from './canMute';
+export { canReply } from './canReply';
+export { clear } from './clear';
+export { delete } from './delete';
+export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
+export { downloadMedia } from './downloadMedia';
+export { editMessage } from './editMessage';
+export { find } from './find';
+export { forwardMessage, ForwardMessagesOptions } from './forwardMessage';
+export { generateMessageID } from './generateMessageID';
+export { get } from './get';
+export { getActiveChat } from './getActiveChat';
+export { getLastSeen } from './getLastSeen';
+export { getMessageACK } from './getMessageACK';
+export { getMessageById } from './getMessageById';
+export { getMessages, GetMessagesOptions } from './getMessages';
+export { getPlatformFromMessage } from './getPlatformFromMessage';
+export { getQuotedMsg } from './getQuotedMsg';
+export { getQuotedMsgKey } from './getQuotedMsgKey';
+export { getReactions } from './getReactions';
+export { getVotes } from './getVotes';
+export { keepMessage } from './keepMessage';
+export { ChatListOptions, list } from './list';
+export { markIsComposing } from './markIsComposing';
+export { markIsPaused } from './markIsPaused';
+export { markIsRead } from './markIsRead';
+export { markIsRecording } from './markIsRecording';
+export { markIsUnread } from './markIsUnread';
+export { markPlayed } from './markPlayed';
+export { mute } from './mute';
+export { openChatAt } from './openChatAt';
+export { openChatBottom } from './openChatBottom';
+export { openChatFromUnread } from './openChatFromUnread';
+export { pin, unpin } from './pin';
+export { pinMsg, unpinMsg } from './pinMsg';
+export { LinkPreviewOptions, prepareLinkPreview } from './prepareLinkPreview';
+export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
+export { prepareRawMessage } from './prepareRawMessage';
+export { requestPhoneNumber } from './requestPhoneNumber';
+export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
+export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
+export { GroupInviteMessage, sendGroupInviteMessage, } from './sendGroupInviteMessage';
+export { ListMessageOptions, sendListMessage } from './sendListMessage';
+export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
+export { OrderItems, OrderMessageOptions, sendOrderMessage, } from './sendOrderMessage';
+export { sendRawMessage } from './sendRawMessage';
+export { sendReactionToMessage } from './sendReactionToMessage';
+export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';
+export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
+export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
+export { starMessage, StarMessageReturn } from './starMessage';
+export { unmute } from './unmute';

package/dist/chat/functions/keepMessage.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Keep or unkeep a message in a group chat with expiration
+ *
+ * @example
+ * ```javascript
+ * // To keep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', true);
+ *
+ * // To unkeep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
+ * ```
+ * @category Chat
+ */
+export declare function keepMessage(msgId: string | MsgKey, value?: boolean): Promise<MsgModel>;

package/dist/chat/functions/list.d.ts

@@ -0,0 +1,62 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChatModel, Wid } from '../../whatsapp';
+export interface ChatListOptions {
+    id?: Wid;
+    count?: number;
+    direction?: 'after' | 'before';
+    onlyCommunities?: boolean;
+    onlyGroups?: boolean;
+    onlyUsers?: boolean;
+    onlyWithUnreadMessage?: boolean;
+    withLabels?: string[];
+}
+/**
+ * Return a list of chats
+ *
+ * @example
+ * ```javascript
+ * // All chats
+ * const chats = await WPP.chat.list();
+ *
+ * // Some chats
+ * const chats = WPP.chat.list({count: 20});
+ *
+ * // 20 chats before specific chat
+ * const chats = WPP.chat.list({count: 20, direction: 'before', id: '[number]@c.us'});
+ *
+ * // Only users chats
+ * const chats = await WPP.chat.list({onlyUsers: true});
+ *
+ * // Only groups chats
+ * const chats = await WPP.chat.list({onlyGroups: true});
+ *
+ * // Only communities chats
+ * const chats = await WPP.chat.list({onlyCommunities: true});
+ *
+ * // Only with label Text
+ * const chats = await WPP.chat.list({withLabels: ['Test']});
+ *
+ * // Only with label id
+ * const chats = await WPP.chat.list({withLabels: ['1']});
+ *
+ * // Only with label with one of text or id
+ * const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
+ * ```
+ *
+ * @category Chat
+ */
+export declare function list(options?: ChatListOptions): Promise<ChatModel[]>;

package/dist/chat/functions/markIsComposing.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark a chat to composing state
+ * and keep sending "is writting a message"
+ *
+ * @example
+ * ```javascript
+ * // Mark is composing
+ * WPP.chat.markIsComposing('[number]@c.us');
+ *
+ * // Mark is composing for 5 seconds
+ * WPP.chat.markIsComposing('[number]@c.us', 5000);
+ * ```
+ * @category Chat
+ */
+export declare function markIsComposing(chatId: string | Wid, duration?: number): Promise<void>;

package/dist/chat/functions/markIsPaused.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark a chat is paused state
+ *
+ * @example
+ * ```javascript
+ * // Mark as recording
+ * WPP.chat.markIsPaused('[number]@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsPaused(chatId: string | Wid): Promise<void>;

package/dist/chat/functions/markIsRead.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark a chat as read and send SEEN event
+ *
+ * @example
+ * ```javascript
+ * // Some messages
+ * WPP.chat.markIsRead('[number]@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsRead(chatId: string | Wid): Promise<{
+    wid: Wid;
+    unreadCount: number;
+}>;

package/dist/chat/functions/markIsRecording.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark a chat to recording state
+ * and keep sending "is recording"
+ *
+ * @example
+ * ```javascript
+ * // Mark is recording
+ * WPP.chat.markIsRecording('[number]@c.us');
+ *
+ * // Mark is recording for 5 seconds
+ * WPP.chat.markIsRecording('[number]@c.us', 5000);
+ * ```
+ * @category Chat
+ */
+export declare function markIsRecording(chatId: string | Wid, duration?: number): Promise<void>;

package/dist/chat/functions/markIsUnread.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mark a chat as unread
+ *
+ * @example
+ * ```javascript
+ * // Some messages
+ * WPP.chat.markIsUnread('[number]@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsUnread(chatId: string | Wid): Promise<{
+    wid: Wid;
+}>;

package/dist/chat/functions/markPlayed.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2022 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Stringable } from '../../types';
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Mark message as played
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.markPlayed('[message_id]');
+ * ```
+ * @category Message
+ */
+export declare function markPlayed(messageId: string | MsgKey | MsgModel | Stringable): Promise<any>;

package/dist/chat/functions/mute.d.ts

@@ -0,0 +1,45 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Mute a chat, you can use duration or expiration
+ * For expiration, use unix timestamp (seconds only)
+ * For duration, use seconds
+ *
+ * @example
+ * ```javascript
+ * // Mute for 60 seconds
+ * WPP.chat.mute('[number]@c.us', {duration: 60});
+ *
+ * // Mute util 2021-01-01
+ * WPP.chat.mute('[number]@c.us', {expiration: 1641006000});
+ *
+ * // or using date
+ * const expiration = new Date('2022-01-01 00:00:00');
+ * WPP.chat.mute('[number]@c.us', {expiration: expiration});
+ * ```
+ *
+ * @category Chat
+ */
+export declare function mute(chatId: string | Wid, time: {
+    expiration: number | Date;
+} | {
+    duration: number;
+}): Promise<{
+    wid: Wid;
+    expiration: number;
+    isMuted: boolean;
+}>;

package/dist/chat/functions/openChatAt.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Open the chat in the WhatsApp interface in a specific message
+ *
+ * @example
+ * ```javascript
+ * await WPP.chat.openChatAt('[number]@c.us', <message_id>);
+ * ```
+ *
+ * @category Chat
+ */
+export declare function openChatAt(chatId: string | Wid, messageId: string): Promise<boolean>;

package/dist/chat/functions/openChatBottom.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Open the chat in the WhatsApp interface in bottom position
+ *
+ * @example
+ * ```javascript
+ * await WPP.chat.openChatBottom('[number]@c.us');
+ * ```
+ *
+ * @category Chat
+ */
+export declare function openChatBottom(chatId: string | Wid): Promise<boolean>;

package/dist/chat/functions/openChatFromUnread.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Open the chat in the WhatsApp interface from first unread message
+ *
+ * @example
+ * ```javascript
+ * await WPP.chat.openChatFromUnread('[number]@c.us');
+ * ```
+ *
+ * @category Chat
+ */
+export declare function openChatFromUnread(chatId: string | Wid): Promise<boolean>;

package/dist/chat/functions/pin.d.ts

@@ -0,0 +1,54 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Pin a chat
+ *
+ * @example
+ * ```javascript
+ * // Pin a chat
+ * WPP.chat.pin('[number]@c.us');
+ *
+ * // Unpin a chat
+ * WPP.chat.pin('[number]@c.us', false);
+ * // or
+ * WPP.chat.unpin('[number]@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function pin(chatId: string | Wid, pin?: boolean): Promise<{
+    wid: Wid;
+    pin: boolean;
+}>;
+/**
+ * Unpin a chat
+ *
+ * @alias pin
+ *
+ * @example
+ * ```javascript
+ * // Unpin a chat
+ * WPP.chat.unpin('[number]@c.us');
+ *
+ * // Alias for
+ * WPP.chat.pin('[number]@c.us', false);
+ * ```
+ * @category Chat
+ */
+export declare function unpin(chatId: string | Wid): Promise<{
+    wid: Wid;
+    pin: boolean;
+}>;

package/dist/chat/functions/pinMsg.d.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright 2024 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, MsgModel } from '../../whatsapp';
+import { SendMsgResult } from '../../whatsapp/enums';
+/**
+ * Pin a message in chat
+ *
+ * @example
+ * ```javascript
+ * // Pin a message in chat
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF');
+ *
+ * // Pin a message in chat for 30 days
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', 2592000);
+ *
+ * // Unpin a message
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
+ * // or
+ * WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function pinMsg(msgId: string | MsgKey, pin?: boolean, seconds?: number): Promise<{
+    message: MsgModel;
+    pinned: boolean;
+    result: SendMsgResult;
+}>;
+/**
+ * Unpin a message in chat
+ *
+ * @alias pin
+ *
+ * @example
+ * ```javascript
+ * // Unpin a message
+ * WPP.chat.unpinMsg('true_[number]@c.us_ABCDEF');
+ *
+ * // Alias for
+ * WPP.chat.pinMsg('true_[number]@c.us_ABCDEF', false);
+ * ```
+ * @category Chat
+ */
+export declare function unpinMsg(msgId: string | MsgKey): Promise<{
+    message: MsgModel;
+    pinned: boolean;
+    result: SendMsgResult;
+}>;