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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (266) hide show
  1. package/CHANGELOG.md +1 -9
  2. package/dist/blocklist/functions/all.d.ts +3 -2
  3. package/dist/blocklist/functions/blockContact.d.ts +12 -3
  4. package/dist/blocklist/functions/index.d.ts +4 -4
  5. package/dist/blocklist/functions/isBlocked.d.ts +9 -3
  6. package/dist/blocklist/functions/unblockContact.d.ts +12 -3
  7. package/dist/call/functions/accept.d.ts +13 -6
  8. package/dist/call/functions/enableCallInterface.d.ts +3 -2
  9. package/dist/call/functions/end.d.ts +11 -4
  10. package/dist/call/functions/index.d.ts +6 -6
  11. package/dist/call/functions/offer.d.ts +13 -8
  12. package/dist/call/functions/parseRelayResponse.d.ts +9 -2
  13. package/dist/call/functions/prepareDestination.d.ts +10 -2
  14. package/dist/call/functions/reject.d.ts +11 -4
  15. package/dist/cart/functions/add.d.ts +29 -5
  16. package/dist/cart/functions/clear.d.ts +19 -2
  17. package/dist/cart/functions/get.d.ts +12 -5
  18. package/dist/cart/functions/getThumbFromCart.d.ts +19 -2
  19. package/dist/cart/functions/index.d.ts +7 -7
  20. package/dist/cart/functions/remove.d.ts +23 -2
  21. package/dist/cart/functions/submit.d.ts +40 -3
  22. package/dist/cart/functions/update.d.ts +25 -4
  23. package/dist/catalog/functions/addProductImage.d.ts +15 -6
  24. package/dist/catalog/functions/changeProductImage.d.ts +15 -6
  25. package/dist/catalog/functions/createCollection.d.ts +16 -5
  26. package/dist/catalog/functions/createProduct.d.ts +25 -25
  27. package/dist/catalog/functions/deleteCollection.d.ts +12 -5
  28. package/dist/catalog/functions/deleteProduct.d.ts +17 -9
  29. package/dist/catalog/functions/editCollection.d.ts +19 -10
  30. package/dist/catalog/functions/editProduct.d.ts +23 -15
  31. package/dist/catalog/functions/getCollections.d.ts +12 -3
  32. package/dist/catalog/functions/getMyCatalog.d.ts +4 -2
  33. package/dist/catalog/functions/getProductById.d.ts +24 -14
  34. package/dist/catalog/functions/getProducts.d.ts +16 -6
  35. package/dist/catalog/functions/index.d.ts +16 -16
  36. package/dist/catalog/functions/removeProductImage.d.ts +16 -7
  37. package/dist/catalog/functions/setProductVisibility.d.ts +18 -9
  38. package/dist/catalog/functions/updateCartEnabled.d.ts +16 -9
  39. package/dist/chat/functions/archive.d.ts +15 -20
  40. package/dist/chat/functions/canMarkPlayed.d.ts +9 -4
  41. package/dist/chat/functions/canMute.d.ts +9 -3
  42. package/dist/chat/functions/canReply.d.ts +9 -4
  43. package/dist/chat/functions/clear.d.ts +13 -5
  44. package/dist/chat/functions/closeChat.d.ts +3 -2
  45. package/dist/chat/functions/delete.d.ts +10 -4
  46. package/dist/chat/functions/{deleteMessage.d.ts → deleteMessages.d.ts} +15 -6
  47. package/dist/chat/functions/downloadMedia.d.ts +10 -3
  48. package/dist/chat/functions/editMessage.d.ts +33 -6
  49. package/dist/chat/functions/find.d.ts +9 -2
  50. package/dist/chat/functions/forwardMessage.d.ts +14 -7
  51. package/dist/chat/functions/forwardMessages.d.ts +15 -8
  52. package/dist/chat/functions/generateMessageID.d.ts +9 -2
  53. package/dist/chat/functions/get.d.ts +9 -2
  54. package/dist/chat/functions/getActiveChat.d.ts +4 -2
  55. package/dist/chat/functions/getLastSeen.d.ts +8 -2
  56. package/dist/chat/functions/getMessageACK.d.ts +18 -11
  57. package/dist/chat/functions/getMessageById.d.ts +12 -10
  58. package/dist/chat/functions/getMessages.d.ts +33 -53
  59. package/dist/chat/functions/getNotes.d.ts +9 -2
  60. package/dist/chat/functions/getPlatformFromMessage.d.ts +8 -3
  61. package/dist/chat/functions/getQuotedMsg.d.ts +9 -2
  62. package/dist/chat/functions/getQuotedMsgKey.d.ts +9 -2
  63. package/dist/chat/functions/getReactions.d.ts +17 -10
  64. package/dist/chat/functions/getUnreadChats.d.ts +8 -1
  65. package/dist/chat/functions/getVotes.d.ts +17 -10
  66. package/dist/chat/functions/index.d.ts +66 -65
  67. package/dist/chat/functions/keepMessage.d.ts +12 -4
  68. package/dist/chat/functions/list.d.ts +33 -33
  69. package/dist/chat/functions/markIsComposing.d.ts +9 -2
  70. package/dist/chat/functions/markIsPaused.d.ts +8 -2
  71. package/dist/chat/functions/markIsRead.d.ts +10 -5
  72. package/dist/chat/functions/markIsRecording.d.ts +9 -2
  73. package/dist/chat/functions/markIsUnread.d.ts +8 -4
  74. package/dist/chat/functions/markPlayed.d.ts +9 -4
  75. package/dist/chat/functions/mute.d.ts +13 -9
  76. package/dist/chat/functions/openChatAt.d.ts +11 -3
  77. package/dist/chat/functions/openChatBottom.d.ts +9 -2
  78. package/dist/chat/functions/openChatFromUnread.d.ts +9 -2
  79. package/dist/chat/functions/pin.d.ts +18 -20
  80. package/dist/chat/functions/pinMsg.d.ts +16 -11
  81. package/dist/chat/functions/prepareAudioWaveform.d.ts +30 -5
  82. package/dist/chat/functions/prepareLinkPreview.d.ts +31 -31
  83. package/dist/chat/functions/prepareMessageButtons.d.ts +41 -1
  84. package/dist/chat/functions/prepareRawMessage.d.ts +22 -3
  85. package/dist/chat/functions/replyToButtonMessage.d.ts +12 -1
  86. package/dist/chat/functions/requestPhoneNumber.d.ts +10 -3
  87. package/dist/chat/functions/sendCatalogMessage.d.ts +34 -12
  88. package/dist/chat/functions/sendChargeMessage.d.ts +65 -25
  89. package/dist/chat/functions/sendCreatePollMessage.d.ts +35 -18
  90. package/dist/chat/functions/sendEventMessage.d.ts +62 -22
  91. package/dist/chat/functions/sendFileMessage.d.ts +10 -2
  92. package/dist/chat/functions/sendGroupInviteMessage.d.ts +39 -16
  93. package/dist/chat/functions/sendListMessage.d.ts +50 -17
  94. package/dist/chat/functions/sendLocationMessage.d.ts +52 -48
  95. package/dist/chat/functions/sendPixKeyMessage.d.ts +26 -10
  96. package/dist/chat/functions/sendRawMessage.d.ts +22 -2
  97. package/dist/chat/functions/sendReactionToMessage.d.ts +13 -7
  98. package/dist/chat/functions/sendScheduledCallMessage.d.ts +17 -6
  99. package/dist/chat/functions/sendTextMessage.d.ts +11 -28
  100. package/dist/chat/functions/sendVCardContactMessage.d.ts +44 -19
  101. package/dist/chat/functions/setChatList.d.ts +10 -2
  102. package/dist/chat/functions/setInputText.d.ts +10 -3
  103. package/dist/chat/functions/setNotes.d.ts +10 -2
  104. package/dist/chat/functions/starMessage.d.ts +13 -16
  105. package/dist/chat/functions/unmute.d.ts +8 -2
  106. package/dist/chat/types.d.ts +13 -101
  107. package/dist/community/functions/addSubgroups.d.ts +21 -11
  108. package/dist/community/functions/create.d.ts +16 -4
  109. package/dist/community/functions/deactivate.d.ts +10 -4
  110. package/dist/community/functions/demoteParticipants.d.ts +14 -4
  111. package/dist/community/functions/getAnnouncementGroup.d.ts +11 -3
  112. package/dist/community/functions/getParticipants.d.ts +9 -3
  113. package/dist/community/functions/getSubgroups.d.ts +11 -3
  114. package/dist/community/functions/index.d.ts +9 -9
  115. package/dist/community/functions/promoteParticipants.d.ts +14 -4
  116. package/dist/community/functions/removeSubgroups.d.ts +20 -10
  117. package/dist/conn/functions/changeEnviromentDevice.d.ts +3 -2
  118. package/dist/conn/functions/genLinkDeviceCodeForPhoneNumber.d.ts +12 -4
  119. package/dist/conn/functions/getABProps.d.ts +15 -6
  120. package/dist/conn/functions/getAuthCode.d.ts +3 -2
  121. package/dist/conn/functions/getAutoDownloadSettings.d.ts +7 -6
  122. package/dist/conn/functions/getBuildConstants.d.ts +21 -8
  123. package/dist/conn/functions/getHistorySyncProgress.d.ts +4 -4
  124. package/dist/conn/functions/getMigrationState.d.ts +4 -4
  125. package/dist/conn/functions/getMyDeviceId.d.ts +3 -2
  126. package/dist/conn/functions/getMyUserId.d.ts +3 -2
  127. package/dist/conn/functions/getMyUserLid.d.ts +3 -2
  128. package/dist/conn/functions/getMyUserWid.d.ts +3 -2
  129. package/dist/conn/functions/getPlatform.d.ts +3 -2
  130. package/dist/conn/functions/getStreamData.d.ts +3 -3
  131. package/dist/conn/functions/getTheme.d.ts +2 -1
  132. package/dist/conn/functions/index.d.ts +33 -33
  133. package/dist/conn/functions/isAuthenticated.d.ts +3 -2
  134. package/dist/conn/functions/isIdle.d.ts +3 -2
  135. package/dist/conn/functions/isMainInit.d.ts +3 -2
  136. package/dist/conn/functions/isMainLoaded.d.ts +3 -2
  137. package/dist/conn/functions/isMainReady.d.ts +3 -2
  138. package/dist/conn/functions/isMultiDevice.d.ts +3 -2
  139. package/dist/conn/functions/isOnline.d.ts +3 -2
  140. package/dist/conn/functions/isRegistered.d.ts +3 -2
  141. package/dist/conn/functions/joinWebBeta.d.ts +11 -4
  142. package/dist/conn/functions/logout.d.ts +3 -2
  143. package/dist/conn/functions/markAvailable.d.ts +12 -4
  144. package/dist/conn/functions/needsUpdate.d.ts +3 -2
  145. package/dist/conn/functions/refreshQR.d.ts +3 -2
  146. package/dist/conn/functions/setAutoDownloadSettings.d.ts +11 -19
  147. package/dist/conn/functions/setKeepAlive.d.ts +11 -4
  148. package/dist/conn/functions/setLimit.d.ts +28 -38
  149. package/dist/conn/functions/setMultiDevice.d.ts +11 -4
  150. package/dist/conn/functions/setTheme.d.ts +14 -7
  151. package/dist/contact/functions/get.d.ts +12 -7
  152. package/dist/contact/functions/getBusinessProfile.d.ts +12 -5
  153. package/dist/contact/functions/getCommonGroups.d.ts +10 -3
  154. package/dist/contact/functions/getPnLidEntry.d.ts +10 -5
  155. package/dist/contact/functions/getProfilePictureUrl.d.ts +12 -5
  156. package/dist/contact/functions/getStatus.d.ts +10 -4
  157. package/dist/contact/functions/index.d.ts +14 -14
  158. package/dist/contact/functions/list.d.ts +15 -11
  159. package/dist/contact/functions/queryExists.d.ts +10 -3
  160. package/dist/contact/functions/remove.d.ts +11 -4
  161. package/dist/contact/functions/reportContact.d.ts +16 -14
  162. package/dist/contact/functions/save.d.ts +18 -11
  163. package/dist/contact/functions/subscribePresence.d.ts +11 -4
  164. package/dist/contact/functions/unsubscribePresence.d.ts +11 -3
  165. package/dist/group/functions/addParticipants.d.ts +19 -12
  166. package/dist/group/functions/approve.d.ts +14 -6
  167. package/dist/group/functions/canAdd.d.ts +10 -4
  168. package/dist/group/functions/canDemote.d.ts +11 -4
  169. package/dist/group/functions/canPromote.d.ts +11 -4
  170. package/dist/group/functions/canRemove.d.ts +11 -4
  171. package/dist/group/functions/create.d.ts +23 -14
  172. package/dist/group/functions/demoteParticipants.d.ts +12 -5
  173. package/dist/group/functions/ensureGroup.d.ts +11 -3
  174. package/dist/group/functions/ensureGroupAndParticipants.d.ts +14 -5
  175. package/dist/group/functions/getAllGroups.d.ts +4 -2
  176. package/dist/group/functions/getGroupInfoFromInviteCode.d.ts +10 -35
  177. package/dist/group/functions/getGroupSizeLimit.d.ts +3 -2
  178. package/dist/group/functions/getInviteCode.d.ts +10 -4
  179. package/dist/group/functions/getMembershipRequests.d.ts +16 -9
  180. package/dist/group/functions/getParticipants.d.ts +11 -4
  181. package/dist/group/functions/getPastParticipants.d.ts +11 -4
  182. package/dist/group/functions/iAmAdmin.d.ts +9 -3
  183. package/dist/group/functions/iAmMember.d.ts +9 -3
  184. package/dist/group/functions/iAmRestrictedMember.d.ts +9 -3
  185. package/dist/group/functions/iAmSuperAdmin.d.ts +9 -3
  186. package/dist/group/functions/index.d.ts +32 -32
  187. package/dist/group/functions/join.d.ts +12 -5
  188. package/dist/group/functions/leave.d.ts +10 -4
  189. package/dist/group/functions/promoteParticipants.d.ts +12 -5
  190. package/dist/group/functions/reject.d.ts +14 -6
  191. package/dist/group/functions/removeIcon.d.ts +10 -4
  192. package/dist/group/functions/removeParticipants.d.ts +12 -5
  193. package/dist/group/functions/revokeInviteCode.d.ts +10 -4
  194. package/dist/group/functions/setDescription.d.ts +11 -4
  195. package/dist/group/functions/setIcon.d.ts +17 -10
  196. package/dist/group/functions/setProperty.d.ts +19 -11
  197. package/dist/group/functions/setSubject.d.ts +11 -4
  198. package/dist/indexdb/functions/getMessagesFromRowId.d.ts +9 -13
  199. package/dist/indexdb/functions/index.d.ts +1 -1
  200. package/dist/labels/functions/addNewLabel.d.ts +14 -13
  201. package/dist/labels/functions/addOrRemoveLabels.d.ts +20 -11
  202. package/dist/labels/functions/colorIsInLabelPalette.d.ts +11 -5
  203. package/dist/labels/functions/deleteAllLabels.d.ts +14 -2
  204. package/dist/labels/functions/deleteLabel.d.ts +9 -3
  205. package/dist/labels/functions/editLabel.d.ts +15 -13
  206. package/dist/labels/functions/getAllLabels.d.ts +14 -2
  207. package/dist/labels/functions/getLabelById.d.ts +9 -2
  208. package/dist/labels/functions/getLabelColorPalette.d.ts +11 -2
  209. package/dist/labels/functions/getNewLabelColor.d.ts +12 -3
  210. package/dist/labels/functions/index.d.ts +11 -11
  211. package/dist/newsletter/functions/create.d.ts +16 -11
  212. package/dist/newsletter/functions/destroy.d.ts +10 -3
  213. package/dist/newsletter/functions/edit.d.ts +25 -16
  214. package/dist/newsletter/functions/ensureNewsletter.d.ts +8 -3
  215. package/dist/newsletter/functions/follow.d.ts +9 -2
  216. package/dist/newsletter/functions/getSubscribers.d.ts +10 -3
  217. package/dist/newsletter/functions/index.d.ts +9 -9
  218. package/dist/newsletter/functions/mute.d.ts +12 -4
  219. package/dist/newsletter/functions/search.d.ts +18 -12
  220. package/dist/newsletter/functions/unfollow.d.ts +9 -2
  221. package/dist/order/functions/accept.d.ts +9 -10
  222. package/dist/order/functions/decline.d.ts +10 -12
  223. package/dist/order/functions/get.d.ts +12 -5
  224. package/dist/order/functions/index.d.ts +5 -5
  225. package/dist/order/functions/update.d.ts +16 -3
  226. package/dist/privacy/functions/get.d.ts +14 -3
  227. package/dist/privacy/functions/getDisallowedList.d.ts +20 -13
  228. package/dist/privacy/functions/index.d.ts +9 -9
  229. package/dist/privacy/functions/prepareDisallowedList.d.ts +18 -6
  230. package/dist/privacy/functions/setAbout.d.ts +39 -6
  231. package/dist/privacy/functions/setAddGroup.d.ts +37 -6
  232. package/dist/privacy/functions/setLastSeen.d.ts +39 -6
  233. package/dist/privacy/functions/setOnline.d.ts +22 -3
  234. package/dist/privacy/functions/setProfilePic.d.ts +39 -6
  235. package/dist/privacy/functions/setReadReceipts.d.ts +22 -3
  236. package/dist/privacy/functions/setStatus.d.ts +31 -4
  237. package/dist/profile/functions/editBusinessProfile.d.ts +21 -4
  238. package/dist/profile/functions/getMyProfileName.d.ts +3 -2
  239. package/dist/profile/functions/getMyProfilePicture.d.ts +3 -2
  240. package/dist/profile/functions/getMyStatus.d.ts +3 -2
  241. package/dist/profile/functions/index.d.ts +9 -9
  242. package/dist/profile/functions/isBusiness.d.ts +4 -3
  243. package/dist/profile/functions/removeMyProfilePicture.d.ts +3 -2
  244. package/dist/profile/functions/setMyProfileName.d.ts +10 -3
  245. package/dist/profile/functions/setMyProfilePicture.d.ts +16 -9
  246. package/dist/profile/functions/setMyStatus.d.ts +10 -3
  247. package/dist/status/functions/get.d.ts +18 -3
  248. package/dist/status/functions/getMyStatus.d.ts +3 -2
  249. package/dist/status/functions/index.d.ts +10 -10
  250. package/dist/status/functions/postSendStatus.d.ts +9 -2
  251. package/dist/status/functions/remove.d.ts +17 -3
  252. package/dist/status/functions/sendImageStatus.d.ts +14 -5
  253. package/dist/status/functions/sendRawStatus.d.ts +12 -8
  254. package/dist/status/functions/sendReadStatus.d.ts +11 -4
  255. package/dist/status/functions/sendTextStatus.d.ts +16 -8
  256. package/dist/status/functions/sendVideoStatus.d.ts +14 -5
  257. package/dist/status/functions/updateParticipants.d.ts +11 -9
  258. package/dist/status/index.d.ts +0 -1
  259. package/dist/types.d.ts +20 -0
  260. package/dist/whatsapp/functions/deleteContactAction.d.ts +3 -23
  261. package/dist/whatsapp/functions/setArchive.d.ts +0 -9
  262. package/dist/wppconnect-wa.js +1 -1
  263. package/dist/wppconnect-wa.js.LICENSE.txt +1 -1
  264. package/package.json +20 -17
  265. package/dist/blocklist/types.d.ts +0 -20
  266. package/dist/status/defaultSendStatusOptions.d.ts +0 -19
@@ -13,6 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  import { SendMessageOptions, SendMessageReturn } from '..';
17
18
  export interface OrderItems {
18
19
  type: 'product' | 'custom';
@@ -28,26 +29,41 @@ export interface OrderMessageOptions extends SendMessageOptions {
28
29
  shipping?: number;
29
30
  offset?: number;
30
31
  }
32
+ declare const chatSendPixKeyMessageSchema: z.ZodObject<{
33
+ chatId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
34
+ params: z.ZodObject<{
35
+ keyType: z.ZodEnum<{
36
+ CNPJ: "CNPJ";
37
+ CPF: "CPF";
38
+ PHONE: "PHONE";
39
+ EMAIL: "EMAIL";
40
+ EVP: "EVP";
41
+ }>;
42
+ name: z.ZodString;
43
+ key: z.ZodString;
44
+ instructions: z.ZodOptional<z.ZodString>;
45
+ }, z.core.$strip>;
46
+ options: z.ZodOptional<z.ZodAny>;
47
+ }, z.core.$strip>;
48
+ export type ChatSendPixKeyMessageInput = z.infer<typeof chatSendPixKeyMessageSchema>;
49
+ export type ChatSendPixKeyMessageOutput = SendMessageReturn;
31
50
  /**
32
- * Send a invoice message
51
+ * Send a PIX key invoice message (Brazil Pix Key)
33
52
  * To send (prices, tax, shipping or discount), for example: USD 12.90, send them without dots or commas, like: 12900
34
53
  *
35
54
  * @example
36
55
  * ```javascript
37
- * // Send PIX Key Message (Brazil Pix Key)
38
- * WPP.chat.sendPixKeyMessage('[number]@c.us', {
56
+ * WPP.chat.sendPixKeyMessage({
57
+ * chatId: '[number]@c.us',
58
+ * params: {
39
59
  * keyType: 'CNPJ',
40
60
  * name: 'WPPCONNECT-TEAM',
41
61
  * key: '33460516000178',
42
62
  * instructions: 'Pay text for instructions here',
63
+ * }
43
64
  * });
44
- *
45
65
  * ```
46
66
  * @category Message
47
67
  */
48
- export declare function sendPixKeyMessage(chatId: any, params: {
49
- keyType: 'CNPJ' | 'CPF' | 'PHONE' | 'EMAIL' | 'EVP';
50
- name: string;
51
- key: string;
52
- instructions?: string;
53
- }, options?: SendMessageOptions): Promise<SendMessageReturn>;
68
+ export declare function sendPixKeyMessage(input: ChatSendPixKeyMessageInput): Promise<ChatSendPixKeyMessageOutput>;
69
+ export {};
@@ -13,10 +13,30 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { RawMessage, SendMessageOptions, SendMessageReturn } from '..';
16
+ import { z } from 'zod';
17
+ import { MsgModel } from '../../whatsapp';
18
+ import { RawMessage, SendMessageReturn } from '..';
19
+ declare const chatSendRawMessageSchema: z.ZodObject<{
20
+ chatId: z.ZodString;
21
+ rawMessage: z.ZodCustom<RawMessage, RawMessage>;
22
+ options: z.ZodOptional<z.ZodObject<{
23
+ createChat: z.ZodOptional<z.ZodBoolean>;
24
+ detectMentioned: z.ZodOptional<z.ZodBoolean>;
25
+ markIsRead: z.ZodOptional<z.ZodBoolean>;
26
+ messageId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>]>>;
27
+ mentionedList: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").Wid, import("../../whatsapp").Wid>]>>>;
28
+ quotedMsg: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>, z.ZodCustom<MsgModel, MsgModel>]>>;
29
+ quotedMsgPayload: z.ZodOptional<z.ZodString>;
30
+ waitForAck: z.ZodOptional<z.ZodBoolean>;
31
+ delay: z.ZodOptional<z.ZodNumber>;
32
+ }, z.core.$strip>>;
33
+ }, z.core.$strip>;
34
+ export type ChatSendRawMessageInput = z.infer<typeof chatSendRawMessageSchema>;
35
+ export type ChatSendRawMessageOutput = SendMessageReturn;
17
36
  /**
18
37
  * Send a raw message
19
38
  *
20
39
  * @category Message
21
40
  */
22
- export declare function sendRawMessage(chatId: any, rawMessage: RawMessage, options?: SendMessageOptions): Promise<SendMessageReturn>;
41
+ export declare function sendRawMessage(params: ChatSendRawMessageInput): Promise<ChatSendRawMessageOutput>;
42
+ export {};
@@ -13,8 +13,15 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { Stringable } from '../../types';
17
- import { MsgKey, MsgModel } from '../../whatsapp';
16
+ import { z } from 'zod';
17
+ declare const chatSendReactionToMessageSchema: z.ZodObject<{
18
+ messageId: z.ZodString;
19
+ reaction: z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<false>, z.ZodNull]>;
20
+ }, z.core.$strip>;
21
+ export type ChatSendReactionToMessageInput = z.infer<typeof chatSendReactionToMessageSchema>;
22
+ export type ChatSendReactionToMessageOutput = {
23
+ sendMsgResult: any;
24
+ };
18
25
  /**
19
26
  * Send a reaction to a message
20
27
  *
@@ -23,14 +30,13 @@ import { MsgKey, MsgModel } from '../../whatsapp';
23
30
  * @example
24
31
  * ```javascript
25
32
  * // to react a message
26
- * WPP.chat.sendReactionToMessage('[message_id]', '🤯');
33
+ * WPP.chat.sendReactionToMessage({ messageId: '[message_id]', reaction: '🤯' });
27
34
  *
28
35
  * // to remove
29
- * WPP.chat.sendReactionToMessage('[message_id]', false);
36
+ * WPP.chat.sendReactionToMessage({ messageId: '[message_id]', reaction: false });
30
37
  *
31
38
  * ```
32
39
  * @category Message
33
40
  */
34
- export declare function sendReactionToMessage(messageId: string | MsgKey | MsgModel | Stringable, reaction: string | false | null): Promise<{
35
- sendMsgResult: string;
36
- }>;
41
+ export declare function sendReactionToMessage(params: ChatSendReactionToMessageInput): Promise<ChatSendReactionToMessageOutput>;
42
+ export {};
@@ -13,6 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  import { SendMessageOptions, SendMessageReturn } from '..';
17
18
  export interface ScheduledCallMessageOptions extends SendMessageOptions {
18
19
  scheduledTimestampMs: number | string;
@@ -20,18 +21,28 @@ export interface ScheduledCallMessageOptions extends SendMessageOptions {
20
21
  title: string;
21
22
  description?: string;
22
23
  }
24
+ declare const chatSendScheduledCallMessageSchema: z.ZodObject<{
25
+ chatId: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
26
+ options: z.ZodAny;
27
+ }, z.core.$strip>;
28
+ export type ChatSendScheduledCallMessageInput = z.infer<typeof chatSendScheduledCallMessageSchema>;
29
+ export type ChatSendScheduledCallMessageOutput = SendMessageReturn;
23
30
  /**
24
31
  * Send a scheduled call message
25
32
  *
26
33
  * @example
27
34
  * ```javascript
28
- * WPP.chat.sendScheduledCallMessage('[number]@c.us', {
29
- * title: "Title of event call"
30
- * description: 'Description for Call",
31
- * callType: 'voice'
32
- * scheduledTimestampMs: 1696084222000
35
+ * WPP.chat.sendScheduledCallMessage({
36
+ * chatId: '[number]@c.us',
37
+ * options: {
38
+ * title: 'Title of event call',
39
+ * description: 'Description for Call',
40
+ * callType: 'voice',
41
+ * scheduledTimestampMs: 1696084222000
42
+ * }
33
43
  * });
34
44
  * ```
35
45
  * @category Message
36
46
  */
37
- export declare function sendScheduledCallMessage(chatId: any, options: ScheduledCallMessageOptions): Promise<SendMessageReturn>;
47
+ export declare function sendScheduledCallMessage(params: ChatSendScheduledCallMessageInput): Promise<ChatSendScheduledCallMessageOutput>;
48
+ export {};
@@ -13,42 +13,25 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  import { LinkPreviewOptions, MessageButtonsOptions, SendMessageOptions, SendMessageReturn } from '..';
17
18
  export type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & LinkPreviewOptions;
19
+ declare const chatSendTextMessageSchema: z.ZodObject<{
20
+ chatId: z.ZodAny;
21
+ content: z.ZodAny;
22
+ options: z.ZodOptional<z.ZodAny>;
23
+ }, z.core.$strip>;
24
+ export type ChatSendTextMessageInput = z.infer<typeof chatSendTextMessageSchema>;
25
+ export type ChatSendTextMessageOutput = SendMessageReturn;
18
26
  /**
19
27
  * Send a text message
20
28
  *
21
29
  * @example
22
30
  * ```javascript
23
31
  * // Send a simple text message
24
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact');
25
- *
26
- * // With Buttons
27
- * // Attention: The buttons are an alternative solution we found to make it work. There is no guarantee that they will continue functioning, or when they might stop: The only certainty is: They will stop, so use them responsibly.
28
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
29
- * useInteractiveMessage: true, // False for legacy
30
- * buttons: [
31
- * {
32
- * url: 'https://wppconnect.io/',
33
- * text: 'WPPConnect Site'
34
- * },
35
- * {
36
- * phoneNumber: '+55 11 22334455',
37
- * text: 'Call me'
38
- * },
39
- * {
40
- * id: 'your custom id 1',
41
- * text: 'Some text'
42
- * },
43
- * {
44
- * code: '789890',
45
- * text: 'Another text'
46
- * }
47
- * ],
48
- * title: 'Title text', // Optional
49
- * footer: 'Footer text' // Optional
50
- * });
32
+ * WPP.chat.sendTextMessage({ chatId: '<chatId>', content: 'Hello new contact' });
51
33
  * ```
52
34
  * @category Message
53
35
  */
54
- export declare function sendTextMessage(chatId: any, content: any, options?: TextMessageOptions): Promise<SendMessageReturn>;
36
+ export declare function sendTextMessage(params: ChatSendTextMessageInput): Promise<ChatSendTextMessageOutput>;
37
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2021 WPPConnect Team
2
+ * Copyright 2026 WPPConnect Team
3
3
  *
4
4
  * Licensed under the Apache License, Version 2.0 (the "License");
5
5
  * you may not use this file except in compliance with the License.
@@ -13,35 +13,60 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  import { Wid } from '../../whatsapp';
17
- import { SendMessageOptions, SendMessageReturn } from '..';
18
+ import { SendMessageReturn } from '..';
18
19
  export interface VCardContact {
19
20
  id: string | Wid;
20
21
  name: string;
21
22
  }
23
+ declare const chatSendVCardContactMessageSchema: z.ZodObject<{
24
+ chatId: z.ZodString;
25
+ contacts: z.ZodArray<z.ZodObject<{
26
+ id: z.ZodString;
27
+ name: z.ZodString;
28
+ }, z.core.$strip>>;
29
+ options: z.ZodOptional<z.ZodObject<{
30
+ createChat: z.ZodOptional<z.ZodBoolean>;
31
+ detectMentioned: z.ZodOptional<z.ZodBoolean>;
32
+ markIsRead: z.ZodOptional<z.ZodBoolean>;
33
+ messageId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>]>>;
34
+ mentionedList: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<Wid, Wid>]>>>;
35
+ quotedMsg: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>, z.ZodCustom<import("../../whatsapp").MsgModel, import("../../whatsapp").MsgModel>]>>;
36
+ quotedMsgPayload: z.ZodOptional<z.ZodString>;
37
+ waitForAck: z.ZodOptional<z.ZodBoolean>;
38
+ delay: z.ZodOptional<z.ZodNumber>;
39
+ }, z.core.$strip>>;
40
+ }, z.core.$strip>;
41
+ export type ChatSendVCardContactMessageInput = z.infer<typeof chatSendVCardContactMessageSchema>;
42
+ export type ChatSendVCardContactMessageOutput = SendMessageReturn;
22
43
  /**
23
- * Send a VCard as message
44
+ * Send one or more contacts as a vCard message
45
+ *
24
46
  * @example
25
47
  * ```javascript
26
- * // single contact
27
- * WPP.chat.sendVCardContactMessage('[number]@c.us', {
28
- * id: '123456@c.us',
29
- * name: 'The Contact Name'
48
+ * // Send a single contact by ID (name resolved from contact store)
49
+ * WPP.chat.sendVCardContactMessage({
50
+ * chatId: '[number]@c.us',
51
+ * contacts: ['[contact]@c.us'],
30
52
  * });
31
53
  *
32
- * // multiple contacts
33
- * WPP.chat.sendVCardContactMessage('[number]@c.us', [
34
- * {
35
- * id: '123456@c.us',
36
- * name: 'The Contact Name'
37
- * },
38
- * {
39
- * id: '456789@c.us',
40
- * name: 'Another Contact'
41
- * },
42
- * ]);
54
+ * // Send a single contact with a custom display name
55
+ * WPP.chat.sendVCardContactMessage({
56
+ * chatId: '[number]@c.us',
57
+ * contacts: [{ id: '[contact]@c.us', name: 'John Doe' }],
58
+ * });
43
59
  *
60
+ * // Send multiple contacts at once
61
+ * WPP.chat.sendVCardContactMessage({
62
+ * chatId: '[number]@c.us',
63
+ * contacts: [
64
+ * { id: '[contact1]@c.us', name: 'Alice' },
65
+ * { id: '[contact2]@c.us', name: 'Bob' },
66
+ * ],
67
+ * });
44
68
  * ```
45
69
  * @category Message
46
70
  */
47
- export declare function sendVCardContactMessage(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;
71
+ export declare function sendVCardContactMessage(params: ChatSendVCardContactMessageInput): Promise<ChatSendVCardContactMessageOutput>;
72
+ export {};
@@ -13,6 +13,7 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  export declare enum FilterChatListTypes {
17
18
  ALL = "all",
18
19
  CUSTOM = "custom",
@@ -27,10 +28,16 @@ export declare enum FilterChatListTypes {
27
28
  LABELS = "labels",
28
29
  ASSIGNED_TO_YOU = "assigned_to_you"
29
30
  }
30
- export declare function setChatList(type: FilterChatListTypes, ids?: string | string[]): Promise<{
31
+ declare const chatSetChatListSchema: z.ZodObject<{
32
+ type: z.ZodEnum<typeof FilterChatListTypes>;
33
+ chatIds: z.ZodArray<z.ZodString>;
34
+ }, z.core.$strip>;
35
+ export type ChatSetChatListInput = z.infer<typeof chatSetChatListSchema>;
36
+ export type ChatSetChatListOutput = {
31
37
  type: FilterChatListTypes;
32
38
  list?: string[];
33
- }>;
39
+ };
40
+ export declare function setChatList(params: ChatSetChatListInput): Promise<ChatSetChatListOutput>;
34
41
  /**
35
42
  * Custom Wrap function with the callback
36
43
  *
@@ -40,3 +47,4 @@ export declare function setChatList(type: FilterChatListTypes, ids?: string | st
40
47
  * I'm committing it this way to provide a quick solution.
41
48
  */
42
49
  export declare function wrapShouldAppearFunction<TFunc extends (...args: any[]) => any>(func: TFunc, callback: (func: TFunc, ...args: Parameters<TFunc>) => ReturnType<TFunc>): TFunc;
50
+ export {};
@@ -13,8 +13,15 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { Wid } from '../../whatsapp';
17
- export declare function setInputText(text: string, chatId?: string | Wid): Promise<{
16
+ import { z } from 'zod';
17
+ declare const chatSetInputTextSchema: z.ZodObject<{
18
+ text: z.ZodString;
19
+ chatId: z.ZodOptional<z.ZodString>;
20
+ }, z.core.$strip>;
21
+ export type ChatSetInputTextInput = z.infer<typeof chatSetInputTextSchema>;
22
+ export type ChatSetInputTextOutput = {
18
23
  text: string;
19
24
  timestamp: number;
20
- }>;
25
+ };
26
+ export declare function setInputText(params: ChatSetInputTextInput): Promise<ChatSetInputTextOutput>;
27
+ export {};
@@ -13,7 +13,14 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { NoteModel, Wid } from '../../whatsapp';
16
+ import { z } from 'zod';
17
+ import { NoteModel } from '../../whatsapp';
18
+ declare const chatSetNotesSchema: z.ZodObject<{
19
+ chatId: z.ZodString;
20
+ content: z.ZodString;
21
+ }, z.core.$strip>;
22
+ export type ChatSetNotesInput = z.infer<typeof chatSetNotesSchema>;
23
+ export type ChatSetNotesOutput = NoteModel | null;
17
24
  /**
18
25
  * Set notes for a contact
19
26
  * Only when are connected with business device
@@ -23,4 +30,5 @@ import { NoteModel, Wid } from '../../whatsapp';
23
30
  * ```
24
31
  * @category Chat
25
32
  */
26
- export declare function setNotes(chatId: string | Wid, content: string): Promise<NoteModel | null>;
33
+ export declare function setNotes(params: ChatSetNotesInput): Promise<ChatSetNotesOutput>;
34
+ export {};
@@ -13,35 +13,32 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  export interface StarMessageReturn {
17
18
  id: string;
18
19
  star: boolean;
19
20
  }
21
+ declare const chatStarMessageSchema: z.ZodObject<{
22
+ ids: z.ZodArray<z.ZodString>;
23
+ star: z.ZodOptional<z.ZodBoolean>;
24
+ }, z.core.$strip>;
25
+ export type ChatStarMessageInput = z.infer<typeof chatStarMessageSchema>;
26
+ export type ChatStarMessageOutput = StarMessageReturn | StarMessageReturn[];
20
27
  /**
21
- * Star/Unstar a message
28
+ * Star/Unstar a message or messages
22
29
  *
23
30
  * @example
24
31
  * ```javascript
25
32
  * // star a message
26
- * WPP.chat.starMessage('<message id>');
33
+ * WPP.chat.starMessage({ ids: '<message id>' });
27
34
  *
28
35
  * // unstar a message
29
- * WPP.chat.starMessage('<message id>', false);
30
- * ```
31
- * @category Message
32
- */
33
- export declare function starMessage(id: string, star: boolean): Promise<StarMessageReturn>;
34
- /**
35
- * Star/Unstar messages
36
+ * WPP.chat.starMessage({ ids: '<message id>', star: false });
36
37
  *
37
- * @example
38
- * ```javascript
39
38
  * // star messages
40
- * WPP.chat.starMessage(['<message id>', '<message id>']);
41
- *
42
- * // unstar messages
43
- * WPP.chat.starMessage(['<message id>', '<message id>'], false);
39
+ * WPP.chat.starMessage({ ids: ['<message id>', '<message id>'] });
44
40
  * ```
45
41
  * @category Message
46
42
  */
47
- export declare function starMessage(ids: string[], star: boolean): Promise<StarMessageReturn[]>;
43
+ export declare function starMessage(params: ChatStarMessageInput): Promise<ChatStarMessageOutput>;
44
+ export {};
@@ -13,7 +13,12 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { Wid } from '../../whatsapp';
16
+ import { z } from 'zod';
17
+ declare const chatUnmuteSchema: z.ZodObject<{
18
+ chatId: z.ZodString;
19
+ }, z.core.$strip>;
20
+ export type ChatUnmuteInput = z.infer<typeof chatUnmuteSchema>;
21
+ export type ChatUnmuteOutput = any;
17
22
  /**
18
23
  * Unmute a chat
19
24
  *
@@ -24,4 +29,5 @@ import { Wid } from '../../whatsapp';
24
29
  *
25
30
  * @category Chat
26
31
  */
27
- export declare function unmute(chatId: string | Wid): Promise<void>;
32
+ export declare function unmute(params: ChatUnmuteInput): Promise<ChatUnmuteOutput>;
33
+ export {};
@@ -13,109 +13,21 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { z } from 'zod';
16
17
  import { ModelPropertiesContructor, MsgKey, MsgModel, SendMsgResultObject, Wid } from '../whatsapp';
17
18
  export type { SendMsgResultObject };
18
- export interface SendMessageOptions {
19
- /**
20
- * Create a new chat to a new contact
21
- *
22
- * @deprecated This option is no longer used. Chats are automatically created when sending messages.
23
- * @default false
24
- *
25
- * @example
26
- * ```javascript
27
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
28
- * createChat: true
29
- * });
30
- * ```
31
- */
32
- createChat?: boolean;
33
- /**
34
- * Automatic detect and add the mentioned contacts with @[number]
35
- *
36
- * @default true
37
- *
38
- * @example
39
- * ```javascript
40
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
41
- * detectMentioned: true
42
- * });
43
- * ```
44
- */
45
- detectMentioned?: boolean;
46
- /**
47
- * Automatically mark chat is read after send a message
48
- *
49
- * @default true
50
- *
51
- * @example
52
- * ```javascript
53
- * WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
54
- * markIsRead: true
55
- * });
56
- * ```
57
- */
58
- markIsRead?: boolean;
59
- /**
60
- *
61
- */
62
- messageId?: string | MsgKey;
63
- /**
64
- * Define a mentioned list for a message
65
- * This option work better with a message with mension
66
- *
67
- * @example
68
- * ```javascript
69
- * WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
70
- * mentionedList: ['123@c.us', '456@c.us']
71
- * })
72
- * ```
73
- */
74
- mentionedList?: (string | Wid)[];
75
- /**
76
- * Quote a message, like a reply message
77
- *
78
- * @example
79
- * ```javascript
80
- * WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
81
- * quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
82
- * })
83
- * ```
84
- */
85
- quotedMsg?: string | MsgKey | MsgModel;
86
- /**
87
- * Quote a message using a previously saved payload.
88
- * The payload must be the JSON string representation of a raw message.
89
- * Raw messages can be obtained when using {@link getMessageById} or {@link getMessages}
90
- * When provided it has priority over {@link quotedMsg}.
91
- */
92
- quotedMsgPayload?: string;
93
- /**
94
- * Wait for send while the ACK of message is SENT(1)
95
- *
96
- * @default true
97
- *
98
- * @example
99
- * ```javascript
100
- * WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
101
- * waitForAck: true
102
- * })
103
- * ```
104
- */
105
- waitForAck?: boolean;
106
- /**
107
- * Delay some time (in ms) before sending message
108
- * While delaying, Typing Status is used to look like a human interaction
109
- * @default 0
110
- * @example
111
- * ```javascript
112
- * WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
113
- * delay: 4000
114
- * })
115
- * ```
116
- */
117
- delay?: number;
118
- }
19
+ export declare const sendMessageOptionsSchema: z.ZodObject<{
20
+ createChat: z.ZodOptional<z.ZodBoolean>;
21
+ detectMentioned: z.ZodOptional<z.ZodBoolean>;
22
+ markIsRead: z.ZodOptional<z.ZodBoolean>;
23
+ messageId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<MsgKey, MsgKey>]>>;
24
+ mentionedList: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<Wid, Wid>]>>>;
25
+ quotedMsg: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<MsgKey, MsgKey>, z.ZodCustom<MsgModel, MsgModel>]>>;
26
+ quotedMsgPayload: z.ZodOptional<z.ZodString>;
27
+ waitForAck: z.ZodOptional<z.ZodBoolean>;
28
+ delay: z.ZodOptional<z.ZodNumber>;
29
+ }, z.core.$strip>;
30
+ export type SendMessageOptions = z.infer<typeof sendMessageOptionsSchema>;
119
31
  export interface SendMessageReturn {
120
32
  id: string;
121
33
  from?: string;
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2023 WPPConnect Team
2
+ * Copyright 2026 WPPConnect Team
3
3
  *
4
4
  * Licensed under the Apache License, Version 2.0 (the "License");
5
5
  * you may not use this file except in compliance with the License.
@@ -13,21 +13,31 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- import { Wid } from '../../whatsapp';
16
+ import { z } from 'zod';
17
+ declare const communityAddSubgroupsSchema: z.ZodObject<{
18
+ communityId: z.ZodString;
19
+ subgroupIds: z.ZodArray<z.ZodString>;
20
+ }, z.core.$strip>;
21
+ export type CommunityAddSubgroupsInput = z.infer<typeof communityAddSubgroupsSchema>;
22
+ export type CommunityAddSubgroupsOutput = {
23
+ failedGroups: {
24
+ error: string;
25
+ jid: string;
26
+ }[];
27
+ linkedGroupJids: string[];
28
+ };
17
29
  /**
18
- * Add groups do community
30
+ * Add groups to a community
19
31
  *
20
32
  * @example
21
33
  * ```javascript
22
- * await WPP.community.addSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
34
+ * await WPP.community.addSubgroups({
35
+ * communityId: '123456@g.us',
36
+ * subgroupIds: ['[groupId1]', '[groupId2]'],
37
+ * });
23
38
  * ```
24
39
  *
25
40
  * @category Community
26
41
  */
27
- export declare function addSubgroups(parentGroupId: string | Wid, subgroupIds: (string | Wid) | (string | Wid)[]): Promise<{
28
- failedGroups: {
29
- error: string;
30
- jid: string;
31
- }[];
32
- linkedGroupJids: string[];
33
- }>;
42
+ export declare function addSubgroups(params: CommunityAddSubgroupsInput): Promise<CommunityAddSubgroupsOutput>;
43
+ export {};