@wppconnect/wa-js 3.23.2 → 4.0.2-alpha.0

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

@@ -13,81 +13,61 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Wid } from '../../whatsapp';
+import { z } from 'zod';
 import { RawMessage } from '..';
-export interface GetMessagesOptions {
-    count?: number;
-    direction?: 'after' | 'before';
-    id?: string;
-    onlyUnread?: boolean;
-    media?: 'url' | 'document' | 'all' | 'image';
-    includeCallMessages?: boolean;
-}
+declare const chatGetMessagesSchema: z.ZodObject<{
+    chatId: z.ZodString;
+    options: z.ZodOptional<z.ZodObject<{
+        count: z.ZodDefault<z.ZodNumber>;
+        direction: z.ZodDefault<z.ZodEnum<{
+            after: "after";
+            before: "before";
+        }>>;
+        id: z.ZodOptional<z.ZodString>;
+        onlyUnread: z.ZodOptional<z.ZodBoolean>;
+        media: z.ZodOptional<z.ZodEnum<{
+            url: "url";
+            all: "all";
+            image: "image";
+            document: "document";
+        }>>;
+        includeCallMessages: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ChatGetMessagesInput = z.infer<typeof chatGetMessagesSchema>;
+export type ChatGetMessagesOutput = RawMessage[];
 /**
  * Fetch messages from a chat
  *
  * @example
  * ```javascript
  * // Some messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20 } });
  *
  * // All messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: -1,
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: -1 } });
  *
  * // Last 20 unread messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   onlyUnread: true,
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20, onlyUnread: true } });
  *
  * // All unread messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: -1,
- *   onlyUnread: true,
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: -1, onlyUnread: true } });
  *
  * // 20 messages before specific message
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   direction: 'before',
- *   id: '<full message id>'
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20, direction: 'before', id: '<full message id>' } });
  *
  * // Only media messages (url, document and links)
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   media: 'all',
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20, media: 'all' } });
  *
  * // Only image messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   media: 'image',
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20, media: 'image' } });
  *
  * // Only document messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   media: 'document',
- * });
- *
- * // Only link (url) messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   media: 'url',
- * });
- *
- * // Include call messages along with chat messages
- * WPP.chat.getMessages('[number]@c.us', {
- *   count: 20,
- *   includeCallMessages: true,
- * });
+ * WPP.chat.getMessages({ chatId: '[number]@c.us', options: { count: 20, media: 'document' } });
  * ```
+ *
  * @category Message
  * @return  {RawMessage[]} List of raw messages
  */
-export declare function getMessages(chatId: string | Wid, options?: GetMessagesOptions): Promise<RawMessage[]>;
+export declare function getMessages(input: ChatGetMessagesInput): Promise<ChatGetMessagesOutput>;
+export {};

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

@@ -13,7 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { NoteModel, Wid } from '../../whatsapp';
+import { z } from 'zod';
+import { NoteModel } from '../../whatsapp';
+declare const chatGetNotesSchema: z.ZodObject<{
+    chatId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetNotesInput = z.infer<typeof chatGetNotesSchema>;
+export type ChatGetNotesOutput = NoteModel | null;
 /**
  * Get notes from a contact
  * Only when are connected with business device
@@ -23,4 +29,5 @@ import { NoteModel, Wid } from '../../whatsapp';
  * ```
  * @category Chat
  */
-export declare function getNotes(chatId: string | Wid): Promise<NoteModel | null>;
+export declare function getNotes(params: ChatGetNotesInput): Promise<ChatGetNotesOutput>;
+export {};

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

@@ -13,8 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Stringable } from '../../types';
-import { MsgKey, MsgModel } from '../../whatsapp';
+import { z } from 'zod';
+declare const chatGetPlatformFromMessageSchema: z.ZodObject<{
+    messageId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetPlatformFromMessageInput = z.infer<typeof chatGetPlatformFromMessageSchema>;
+export type ChatGetPlatformFromMessageOutput = 'android' | 'iphone' | 'web' | 'unknown';
 /**
  * Get the platform message from message ID
  *
@@ -31,4 +35,5 @@ import { MsgKey, MsgModel } from '../../whatsapp';
  * ```
  * @category Message
  */
-export declare function getPlatformFromMessage(messageId: string | MsgKey | MsgModel | Stringable): 'android' | 'iphone' | 'web' | 'unknown';
+export declare function getPlatformFromMessage(params: ChatGetPlatformFromMessageInput): ChatGetPlatformFromMessageOutput;
+export {};

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

@@ -13,10 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { MsgKey, MsgModel } from '../../whatsapp';
+import { z } from 'zod';
+import { MsgModel } from '../../whatsapp';
+declare const chatGetQuotedMsgSchema: z.ZodObject<{
+    msgId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetQuotedMsgInput = z.infer<typeof chatGetQuotedMsgSchema>;
+export type ChatGetQuotedMsgOutput = MsgModel;
 /**
  * Get a quoted message
  *
  * @category Chat
  */
-export declare function getQuotedMsg(id: string | MsgKey): Promise<MsgModel>;
+export declare function getQuotedMsg(params: ChatGetQuotedMsgInput): Promise<ChatGetQuotedMsgOutput>;
+export {};

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

@@ -13,10 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { MsgKey, MsgModel } from '../../whatsapp';
+import { z } from 'zod';
+import { MsgKey } from '../../whatsapp';
+declare const chatGetQuotedMsgKeySchema: z.ZodObject<{
+    msgId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetQuotedMsgKeyInput = z.infer<typeof chatGetQuotedMsgKeySchema>;
+export type ChatGetQuotedMsgKeyOutput = MsgKey;
 /**
  * Get a quoted message
  *
  * @category Chat
  */
-export declare function getQuotedMsgKey(msg: MsgModel): MsgKey;
+export declare function getQuotedMsgKey(params: ChatGetQuotedMsgKeyInput): Promise<ChatGetQuotedMsgKeyOutput>;
+export {};

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

@@ -13,16 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 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<{
+declare const chatGetReactionsSchema: z.ZodObject<{
+    msgId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetReactionsInput = z.infer<typeof chatGetReactionsSchema>;
+export type ChatGetReactionsOutput = {
     reactionByMe: {
         id: MsgKey;
         orphan: number;
@@ -45,4 +42,14 @@ export declare function getReactions(msgId: string): Promise<{
             timestamp: number;
         }[];
     }[];
-}>;
+};
+/**
+ * Get all reactions in a message
+ * @example
+ * ```javascript
+ * WPP.chat.getReactions('true_[number]@c.us_ABCDEF');
+ * ```
+ * @category Chat
+ */
+export declare function getReactions(params: ChatGetReactionsInput): Promise<ChatGetReactionsOutput>;
+export {};

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

@@ -13,11 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 import { ChatModel } from '../../whatsapp';
+declare const chatGetUnreadChatsSchema: z.ZodObject<{
+    onlyNewUnreads: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ChatGetUnreadChatsInput = z.infer<typeof chatGetUnreadChatsSchema>;
+export type ChatGetUnreadChatsOutput = Array<ChatModel>;
 /**
  * Get all chats that have unread messages
  *
  * @category Chat
  *
  */
-export declare function getUnreadChats(onlyNewUnreads: boolean): Promise<Array<ChatModel>>;
+export declare function getUnreadChats(params?: ChatGetUnreadChatsInput): Promise<ChatGetUnreadChatsOutput>;
+export {};

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

@@ -13,16 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { z } from 'zod';
 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<{
+declare const chatGetVotesSchema: z.ZodObject<{
+    msgId: z.ZodString;
+}, z.core.$strip>;
+export type ChatGetVotesInput = z.infer<typeof chatGetVotesSchema>;
+export type ChatGetVotesOutput = {
     msgId: MsgKey;
     chatId: Wid;
     votes: {
@@ -30,4 +27,14 @@ export declare function getVotes(id: string | MsgKey): Promise<{
         timestamp: number;
         sender: Wid;
     }[];
-}>;
+};
+/**
+ * Get votes of a poll
+ * @example
+ * ```javascript
+ * WPP.chat.getVotes({ msgId: 'true_[number]@c.us_ABCDEF' });
+ * ```
+ * @category Chat
+ */
+export declare function getVotes(params: ChatGetVotesInput): Promise<ChatGetVotesOutput>;
+export {};

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

@@ -13,68 +13,69 @@
  * 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 { closeChat } from './closeChat';
-export { delete } from './delete';
-export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
-export { downloadMedia } from './downloadMedia';
-export { editMessage } from './editMessage';
-export { find } from './find';
-export { forwardMessage, ForwardMessageOptions } from './forwardMessage';
-export { forwardMessages, ForwardMessagesOptions } from './forwardMessages';
-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 { getNotes } from './getNotes';
-export { getPlatformFromMessage } from './getPlatformFromMessage';
-export { getQuotedMsg } from './getQuotedMsg';
-export { getQuotedMsgKey } from './getQuotedMsgKey';
-export { getReactions } from './getReactions';
-export { getUnreadChats } from './getUnreadChats';
-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 { ButtonReplyOptions, replyToButtonMessage, } from './replyToButtonMessage';
-export { requestPhoneNumber } from './requestPhoneNumber';
-export { sendCatalogMessage } from './sendCatalogMessage';
-export { OrderItems, OrderMessageOptions, sendChargeMessage, } from './sendChargeMessage';
-export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
-export { sendEventMessage } from './sendEventMessage';
-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 { sendPixKeyMessage } from './sendPixKeyMessage';
-export { sendRawMessage } from './sendRawMessage';
-export { sendReactionToMessage } from './sendReactionToMessage';
-export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';
-export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
-export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
-export { setChatList } from './setChatList';
-export { setInputText } from './setInputText';
-export { setNotes } from './setNotes';
-export { starMessage, StarMessageReturn } from './starMessage';
-export { unmute } from './unmute';
+export { archive, ChatArchiveInput, ChatArchiveOutput, unarchive, } from './archive';
+export { canMarkPlayed, ChatCanMarkPlayedInput, ChatCanMarkPlayedOutput, } from './canMarkPlayed';
+export { canMute, ChatCanMuteInput, ChatCanMuteOutput } from './canMute';
+export { canReply, ChatCanReplyInput, ChatCanReplyOutput } from './canReply';
+export { ChatClearInput, ChatClearOutput, clear } from './clear';
+export { ChatCloseChatOutput, closeChat } from './closeChat';
+export { ChatDeleteInput, ChatDeleteOutput, delete } from './delete';
+export { ChatDeleteMessageInput, ChatDeleteMessageOutput, DeleteMessageReturn, deleteMessages, } from './deleteMessages';
+export { ChatDownloadMediaInput, ChatDownloadMediaOutput, downloadMedia, } from './downloadMedia';
+export { ChatEditMessageInput, ChatEditMessageOutput, editMessage, } from './editMessage';
+export { ChatFindInput, ChatFindOutput, find } from './find';
+export { ChatForwardMessageInput, ChatForwardMessageOutput, forwardMessage, } from './forwardMessage';
+export { ChatForwardMessagesInput, ChatForwardMessagesOutput, forwardMessages, } from './forwardMessages';
+export { ChatGenerateMessageIDInput, ChatGenerateMessageIDOutput, generateMessageID, } from './generateMessageID';
+export { ChatGetInput, ChatGetOutput, get } from './get';
+export { ChatGetActiveChatOutput, getActiveChat } from './getActiveChat';
+export { ChatGetLastSeenInput, ChatGetLastSeenOutput, getLastSeen, } from './getLastSeen';
+export { ChatGetMessageACKInput, ChatGetMessageACKOutput, getMessageACK, } from './getMessageACK';
+export { ChatGetMessageByIdInput, ChatGetMessageByIdOutput, getMessageById, } from './getMessageById';
+export { ChatGetMessagesInput, ChatGetMessagesOutput, getMessages, } from './getMessages';
+export { ChatGetNotesInput, ChatGetNotesOutput, getNotes } from './getNotes';
+export { ChatGetPlatformFromMessageInput, ChatGetPlatformFromMessageOutput, getPlatformFromMessage, } from './getPlatformFromMessage';
+export { ChatGetQuotedMsgInput, ChatGetQuotedMsgOutput, getQuotedMsg, } from './getQuotedMsg';
+export { ChatGetQuotedMsgKeyInput, ChatGetQuotedMsgKeyOutput, getQuotedMsgKey, } from './getQuotedMsgKey';
+export { ChatGetReactionsInput, ChatGetReactionsOutput, getReactions, } from './getReactions';
+export { ChatGetUnreadChatsInput, ChatGetUnreadChatsOutput, getUnreadChats, } from './getUnreadChats';
+export { ChatGetVotesInput, ChatGetVotesOutput, getVotes } from './getVotes';
+export { ChatKeepMessageInput, ChatKeepMessageOutput, keepMessage, } from './keepMessage';
+export { ChatListInput, ChatListOutput, list } from './list';
+export { ChatMarkIsComposingInput, ChatMarkIsComposingOutput, markIsComposing, } from './markIsComposing';
+export { ChatMarkIsPausedInput, ChatMarkIsPausedOutput, markIsPaused, } from './markIsPaused';
+export { ChatMarkIsReadInput, ChatMarkIsReadOutput, markIsRead, } from './markIsRead';
+export { ChatMarkIsRecordingInput, ChatMarkIsRecordingOutput, markIsRecording, } from './markIsRecording';
+export { ChatMarkIsUnreadInput, ChatMarkIsUnreadOutput, markIsUnread, } from './markIsUnread';
+export { ChatMarkPlayedInput, ChatMarkPlayedOutput, markPlayed, } from './markPlayed';
+export { ChatMuteInput, ChatMuteOutput, mute } from './mute';
+export { ChatOpenChatAtInput, ChatOpenChatAtOutput, openChatAt, } from './openChatAt';
+export { ChatOpenChatBottomInput, ChatOpenChatBottomOutput, openChatBottom, } from './openChatBottom';
+export { ChatOpenChatFromUnreadInput, ChatOpenChatFromUnreadOutput, openChatFromUnread, } from './openChatFromUnread';
+export { ChatPinInput, ChatPinOutput, pin, unpin } from './pin';
+export { ChatPinMsgInput, ChatPinMsgOutput, pinMsg, unpinMsg } from './pinMsg';
+export { ChatPrepareAudioWaveformInput, ChatPrepareAudioWaveformOutput, prepareAudioWaveform, } from './prepareAudioWaveform';
+export { ChatPrepareLinkPreviewInput, LinkPreviewOptions, prepareLinkPreview, } from './prepareLinkPreview';
+export { ChatPrepareMessageButtonsInput, MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
+export { ChatPrepareRawMessageInput, ChatPrepareRawMessageOutput, prepareRawMessage, } from './prepareRawMessage';
+export { ButtonReplyOptions, ChatReplyToButtonMessageInput, ChatReplyToButtonMessageOutput, replyToButtonMessage, } from './replyToButtonMessage';
+export { ChatRequestPhoneNumberInput, ChatRequestPhoneNumberOutput, requestPhoneNumber, } from './requestPhoneNumber';
+export { ChatSendCatalogMessageInput, ChatSendCatalogMessageOutput, sendCatalogMessage, } from './sendCatalogMessage';
+export { ChatSendChargeMessageInput, ChatSendChargeMessageOutput, OrderItems, OrderMessageOptions, sendChargeMessage, } from './sendChargeMessage';
+export { ChatSendCreatePollMessageInput, ChatSendCreatePollMessageOutput, PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
+export { ChatSendEventMessageInput, ChatSendEventMessageOutput, sendEventMessage, } from './sendEventMessage';
+export { AudioMessageOptions, AutoDetectMessageOptions, ChatSendFileMessageInput, ChatSendFileMessageOutput, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
+export { ChatSendGroupInviteMessageInput, ChatSendGroupInviteMessageOutput, sendGroupInviteMessage, } from './sendGroupInviteMessage';
+export { ChatSendListMessageInput, ChatSendListMessageOutput, ListMessageOptions, sendListMessage, } from './sendListMessage';
+export { ChatSendLocationMessageInput, ChatSendLocationMessageOutput, LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
+export { ChatSendPixKeyMessageInput, ChatSendPixKeyMessageOutput, sendPixKeyMessage, } from './sendPixKeyMessage';
+export { ChatSendRawMessageInput, ChatSendRawMessageOutput, sendRawMessage, } from './sendRawMessage';
+export { ChatSendReactionToMessageInput, ChatSendReactionToMessageOutput, sendReactionToMessage, } from './sendReactionToMessage';
+export { ChatSendScheduledCallMessageInput, ChatSendScheduledCallMessageOutput, ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';
+export { ChatSendTextMessageInput, ChatSendTextMessageOutput, sendTextMessage, TextMessageOptions, } from './sendTextMessage';
+export { ChatSendVCardContactMessageInput, ChatSendVCardContactMessageOutput, sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
+export { ChatSetChatListInput, ChatSetChatListOutput, FilterChatListTypes, setChatList, } from './setChatList';
+export { ChatSetInputTextInput, ChatSetInputTextOutput, setInputText, } from './setInputText';
+export { ChatSetNotesInput, ChatSetNotesOutput, setNotes } from './setNotes';
+export { ChatStarMessageInput, ChatStarMessageOutput, starMessage, StarMessageReturn, } from './starMessage';
+export { ChatUnmuteInput, ChatUnmuteOutput, unmute } from './unmute';

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

@@ -13,18 +13,26 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { MsgKey, MsgModel } from '../../whatsapp';
+import { z } from 'zod';
+import { MsgModel } from '../../whatsapp';
+declare const chatKeepMessageSchema: z.ZodObject<{
+    msgId: z.ZodString;
+    value: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+export type ChatKeepMessageInput = z.infer<typeof chatKeepMessageSchema>;
+export type ChatKeepMessageOutput = MsgModel;
 /**
  * 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);
+ * WPP.chat.keepMessage({ msgId: 'true_[number]@c.us_ABCDEF', value: true });
  *
  * // To unkeep a message in chat
- * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
+ * WPP.chat.keepMessage({ msgId: 'true_[number]@c.us_ABCDEF', value: false });
  * ```
  * @category Chat
  */
-export declare function keepMessage(msgId: string | MsgKey, value?: boolean): Promise<MsgModel>;
+export declare function keepMessage(params: ChatKeepMessageInput): Promise<ChatKeepMessageOutput>;
+export {};

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

@@ -13,20 +13,28 @@
  * 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;
-    onlyNewsletter?: boolean;
-    onlyUsers?: boolean;
-    onlyWithUnreadMessage?: boolean;
-    onlyArchived?: boolean;
-    withLabels?: string[];
-    ignoreGroupMetadata?: boolean;
-}
+import { z } from 'zod';
+import { ChatModel } from '../../whatsapp';
+declare const chatListSchema: z.ZodObject<{
+    options: z.ZodOptional<z.ZodObject<{
+        id: z.ZodOptional<z.ZodString>;
+        count: z.ZodOptional<z.ZodNumber>;
+        direction: z.ZodOptional<z.ZodEnum<{
+            after: "after";
+            before: "before";
+        }>>;
+        onlyCommunities: z.ZodOptional<z.ZodBoolean>;
+        onlyGroups: z.ZodOptional<z.ZodBoolean>;
+        onlyNewsletter: z.ZodOptional<z.ZodBoolean>;
+        onlyUsers: z.ZodOptional<z.ZodBoolean>;
+        onlyWithUnreadMessage: z.ZodOptional<z.ZodBoolean>;
+        onlyArchived: z.ZodOptional<z.ZodBoolean>;
+        withLabels: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        ignoreGroupMetadata: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type ChatListInput = z.infer<typeof chatListSchema>;
+export type ChatListOutput = ChatModel[];
 /**
  * Return a list of chats
  *
@@ -36,39 +44,31 @@ export interface ChatListOptions {
  * const chats = await WPP.chat.list();
  *
  * // Some chats
- * const chats = WPP.chat.list({count: 20});
+ * const chats = await WPP.chat.list({ options: { count: 20 } });
  *
  * // 20 chats before specific chat
- * const chats = WPP.chat.list({count: 20, direction: 'before', id: '[number]@c.us'});
+ * const chats = await WPP.chat.list({ options: { count: 20, direction: 'before', id: '[number]@c.us' } });
  *
  * // Only users chats
- * const chats = await WPP.chat.list({onlyUsers: true});
+ * const chats = await WPP.chat.list({ options: { onlyUsers: true } });
  *
  * // Only groups chats
- * const chats = await WPP.chat.list({onlyGroups: true});
+ * const chats = await WPP.chat.list({ options: { onlyGroups: true } });
  *
  * // Only communities chats
- * const chats = await WPP.chat.list({onlyCommunities: true});
+ * const chats = await WPP.chat.list({ options: { onlyCommunities: true } });
  *
  * // Only Newsletter
- * const chats = await WPP.chat.list({onlyNewsletter: true});
+ * const chats = await WPP.chat.list({ options: { onlyNewsletter: 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']});
+ * // Only with label text
+ * const chats = await WPP.chat.list({ options: { withLabels: ['Test'] } });
  *
  * // Only archived chats
- * const chats = await WPP.chat.list({onlyArchived: true});
- *
- * // Ignore group metadata search
- * const chats = await WPP.chat.list({ignoreGroupMetadata: true})
+ * const chats = await WPP.chat.list({ options: { onlyArchived: true } });
  * ```
  *
  * @category Chat
  */
-export declare function list(options?: ChatListOptions): Promise<ChatModel[]>;
+export declare function list(params?: ChatListInput): Promise<ChatListOutput>;
+export {};

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

@@ -13,7 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Wid } from '../../whatsapp';
+import { z } from 'zod';
+declare const chatMarkIsComposingSchema: z.ZodObject<{
+    chatId: z.ZodString;
+    duration: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type ChatMarkIsComposingInput = z.infer<typeof chatMarkIsComposingSchema>;
+export type ChatMarkIsComposingOutput = void;
 /**
  * Mark a chat to composing state
  * and keep sending "is writting a message"
@@ -28,4 +34,5 @@ import { Wid } from '../../whatsapp';
  * ```
  * @category Chat
  */
-export declare function markIsComposing(chatId: string | Wid, duration?: number): Promise<void>;
+export declare function markIsComposing(params: ChatMarkIsComposingInput): Promise<ChatMarkIsComposingOutput>;
+export {};

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

@@ -13,7 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Wid } from '../../whatsapp';
+import { z } from 'zod';
+declare const chatMarkIsPausedSchema: z.ZodObject<{
+    chatId: z.ZodString;
+}, z.core.$strip>;
+export type ChatMarkIsPausedInput = z.infer<typeof chatMarkIsPausedSchema>;
+export type ChatMarkIsPausedOutput = void;
 /**
  * Mark a chat is paused state
  *
@@ -24,4 +29,5 @@ import { Wid } from '../../whatsapp';
  * ```
  * @category Chat
  */
-export declare function markIsPaused(chatId: string | Wid): Promise<void>;
+export declare function markIsPaused(params: ChatMarkIsPausedInput): Promise<ChatMarkIsPausedOutput>;
+export {};

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

@@ -13,7 +13,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Wid } from '../../whatsapp';
+import { z } from 'zod';
+declare const chatMarkIsReadSchema: z.ZodObject<{
+    chatId: z.ZodString;
+}, z.core.$strip>;
+export type ChatMarkIsReadInput = z.infer<typeof chatMarkIsReadSchema>;
+export type ChatMarkIsReadOutput = {
+    unreadCount: number;
+};
 /**
  * Mark a chat as read and send SEEN event
  *
@@ -24,7 +31,5 @@ import { Wid } from '../../whatsapp';
  * ```
  * @category Chat
  */
-export declare function markIsRead(chatId: string | Wid): Promise<{
-    wid: Wid;
-    unreadCount: number;
-}>;
+export declare function markIsRead(params: ChatMarkIsReadInput): Promise<ChatMarkIsReadOutput>;
+export {};