@wppconnect/wa-js 3.23.2 → 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 +19 -16
  265. package/dist/blocklist/types.d.ts +0 -20
  266. package/dist/status/defaultSendStatusOptions.d.ts +0 -19
@@ -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,16 +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';
17
+ declare const catalogAddProductImageSchema: z.ZodObject<{
18
+ productId: z.ZodString;
19
+ content: z.ZodString;
20
+ }, z.core.$strip>;
21
+ export type CatalogAddProductImageInput = z.infer<typeof catalogAddProductImageSchema>;
22
+ export type CatalogAddProductImageOutput = any;
16
23
  /**
17
- * Add image on product
18
- * This function include additional images on product
19
- * for change main image use @changeProductImage
24
+ * Add an additional image to a product
20
25
  *
21
26
  * @example
22
27
  * ```javascript
23
- * await WPP.catalog.addProductImage('686859858689', 'data:image/jpeg;base64,.....');
28
+ * await WPP.catalog.addProductImage({
29
+ * productId: '[productId]',
30
+ * content: 'data:image/png;base64,...',
31
+ * });
24
32
  * ```
25
33
  *
26
34
  * @category Catalog
27
35
  */
28
- export declare function addProductImage(productId: string, content: string): Promise<any>;
36
+ export declare function addProductImage(params: CatalogAddProductImageInput): Promise<CatalogAddProductImageOutput>;
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,16 +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';
17
+ declare const catalogChangeProductImageSchema: z.ZodObject<{
18
+ productId: z.ZodString;
19
+ content: z.ZodString;
20
+ }, z.core.$strip>;
21
+ export type CatalogChangeProductImageInput = z.infer<typeof catalogChangeProductImageSchema>;
22
+ export type CatalogChangeProductImageOutput = any;
16
23
  /**
17
- * Add image on product
18
- * This function change main image of product
19
- * for change additional images use @addProductImage
24
+ * Replace the main image of a product
20
25
  *
21
26
  * @example
22
27
  * ```javascript
23
- * await WPP.catalog.changeProductImage('686859858689', 'data:image/jpeg;base64,.....');
28
+ * await WPP.catalog.changeProductImage({
29
+ * productId: '[productId]',
30
+ * content: 'data:image/png;base64,...',
31
+ * });
24
32
  * ```
25
33
  *
26
34
  * @category Catalog
27
35
  */
28
- export declare function changeProductImage(productId: string, content: string): Promise<any>;
36
+ export declare function changeProductImage(params: CatalogChangeProductImageInput): Promise<CatalogChangeProductImageOutput>;
37
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,14 +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';
17
+ declare const catalogCreateCollectionSchema: z.ZodObject<{
18
+ collectionName: z.ZodString;
19
+ productsId: z.ZodArray<z.ZodString>;
20
+ }, z.core.$strip>;
21
+ export type CatalogCreateCollectionInput = z.infer<typeof catalogCreateCollectionSchema>;
22
+ export type CatalogCreateCollectionOutput = any;
16
23
  /**
17
- * Create new collection
24
+ * Create a new product collection in your catalog
18
25
  *
19
26
  * @example
20
27
  * ```javascript
21
- * const myCatalog = await WPP.catalog.createCollection('Collection Name', ['565656589898']);
28
+ * await WPP.catalog.createCollection({
29
+ * collectionName: 'Summer Sale',
30
+ * productsId: ['[productId1]', '[productId2]'],
31
+ * });
22
32
  * ```
23
33
  *
24
- * @return Return collection created
34
+ * @category Catalog
25
35
  */
26
- export declare function createCollection(collectionName: string, productsId: string[]): Promise<any>;
36
+ export declare function createCollection(params: CatalogCreateCollectionInput): Promise<CatalogCreateCollectionOutput>;
37
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,35 @@
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 { ProductModel } from '../../whatsapp';
18
+ declare const catalogCreateProductSchema: z.ZodObject<{
19
+ name: z.ZodString;
20
+ image: z.ZodString;
21
+ description: z.ZodOptional<z.ZodString>;
22
+ price: z.ZodOptional<z.ZodNumber>;
23
+ isHidden: z.ZodOptional<z.ZodBoolean>;
24
+ url: z.ZodOptional<z.ZodString>;
25
+ retailerId: z.ZodOptional<z.ZodString>;
26
+ currency: z.ZodOptional<z.ZodString>;
27
+ }, z.core.$strip>;
28
+ export type CatalogCreateProductInput = z.infer<typeof catalogCreateProductSchema>;
29
+ export type CatalogCreateProductOutput = ProductModel;
17
30
  /**
18
- * Create new product
31
+ * Create a new product in your catalog
19
32
  *
20
33
  * @example
21
34
  * ```javascript
22
- * const myCatalog = await WPP.catalog.addProduct(
23
- {
24
- name: 'Product name',
25
- image: 'base64 image string',
26
- description: 'product description',
27
- price: '89.90',
28
- isHidden: false,
29
- url: 'https://wppconnect.io',
30
- retailerId: 'AKA001',
31
- }
32
- );
35
+ * const product = await WPP.catalog.createProduct({
36
+ * name: 'My Product',
37
+ * image: 'data:image/png;base64,...',
38
+ * description: 'Product description',
39
+ * price: 1000,
40
+ * currency: 'BRL',
41
+ * });
33
42
  * ```
34
43
  *
35
- * @return Your created product
44
+ * @category Catalog
36
45
  */
37
- export interface createProductParams {
38
- name: string;
39
- image: string;
40
- description?: string;
41
- price?: number;
42
- isHidden?: boolean;
43
- url?: string;
44
- retailerId?: string;
45
- currency?: string;
46
- }
47
- export declare function createProduct(params: createProductParams): Promise<ProductModel>;
46
+ export declare function createProduct(params: CatalogCreateProductInput): Promise<CatalogCreateProductOutput>;
47
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,14 +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';
17
+ declare const catalogDeleteCollectionSchema: z.ZodObject<{
18
+ collectionId: z.ZodString;
19
+ }, z.core.$strip>;
20
+ export type CatalogDeleteCollectionInput = z.infer<typeof catalogDeleteCollectionSchema>;
21
+ export type CatalogDeleteCollectionOutput = string;
16
22
  /**
17
- * Delete a collection
23
+ * Delete a product collection from your catalog
18
24
  *
19
25
  * @example
20
26
  * ```javascript
21
- * const myCatalog = await WPP.catalog.deleteCollection("377095767832354");
27
+ * await WPP.catalog.deleteCollection({ collectionId: '[collectionId]' });
22
28
  * ```
23
29
  *
24
- * @return Return sucess or error
30
+ * @category Catalog
25
31
  */
26
- export declare function deleteCollection(collectionId: string): Promise<any>;
32
+ export declare function deleteCollection(params: CatalogDeleteCollectionInput): Promise<CatalogDeleteCollectionOutput>;
33
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,18 +13,26 @@
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';
17
+ declare const catalogDeleteProductsSchema: z.ZodObject<{
18
+ productsIds: z.ZodArray<z.ZodString>;
19
+ }, z.core.$strip>;
20
+ export type CatalogDeleteProductsInput = z.infer<typeof catalogDeleteProductsSchema>;
21
+ export type CatalogDeleteProductsOutput = {
22
+ productsIds: string[];
23
+ status: number;
24
+ };
16
25
  /**
17
- * Get your current catalog
26
+ * Delete one or more products from your catalog
18
27
  *
19
28
  * @example
20
29
  * ```javascript
21
- * // Delete product by id
22
- * const myCatalog = await WPP.catalog.delProducts('6104203702939361');
23
- *
24
- * // Delete various products
25
- * const myCatalog = await WPP.catalog.delProducts(['6104203702939361', '6104289702939361']);
30
+ * const result = await WPP.catalog.deleteProducts({
31
+ * productsIds: ['[productId1]', '[productId2]'],
32
+ * });
26
33
  * ```
27
34
  *
28
- * @return Return sucess or error of product deleted
35
+ * @category Catalog
29
36
  */
30
- export declare function delProducts(productsIds: string[]): Promise<any>;
37
+ export declare function deleteProducts(params: CatalogDeleteProductsInput): Promise<CatalogDeleteProductsOutput>;
38
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,20 +13,29 @@
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';
17
+ declare const catalogEditCollectionSchema: z.ZodObject<{
18
+ collectionId: z.ZodString;
19
+ name: z.ZodOptional<z.ZodString>;
20
+ productsToAdd: z.ZodOptional<z.ZodArray<z.ZodString>>;
21
+ productsToRemove: z.ZodOptional<z.ZodArray<z.ZodString>>;
22
+ }, z.core.$strip>;
23
+ export type CatalogEditCollectionInput = z.infer<typeof catalogEditCollectionSchema>;
24
+ export type CatalogEditCollectionOutput = any;
16
25
  /**
17
- * Create new collection
26
+ * Edit a product collection in your catalog
18
27
  *
19
28
  * @example
20
29
  * ```javascript
21
- * const myCatalog = await WPP.catalog.EditCollection('565656589898', { collectionName: 'New Name for collection', productsToAdd: ['5656523223'], productsToRemove: ['5656523232']});
30
+ * await WPP.catalog.editCollection({
31
+ * collectionId: '[collectionId]',
32
+ * name: 'New Collection Name',
33
+ * productsToAdd: ['[productId1]'],
34
+ * productsToRemove: ['[productId2]'],
35
+ * });
22
36
  * ```
23
37
  *
24
- * @return Return collection edited
38
+ * @category Catalog
25
39
  */
26
- interface paramsEditCollection {
27
- name?: string;
28
- productsToAdd?: string[];
29
- productsToRemove?: string[];
30
- }
31
- export declare function editCollection(collectionId: string, params: paramsEditCollection): Promise<any>;
40
+ export declare function editCollection(params: CatalogEditCollectionInput): Promise<CatalogEditCollectionOutput>;
32
41
  export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,25 +13,33 @@
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 { ProductModel } from '../../whatsapp';
18
+ declare const catalogEditProductSchema: z.ZodObject<{
19
+ productId: z.ZodString;
20
+ name: z.ZodOptional<z.ZodString>;
21
+ description: z.ZodOptional<z.ZodString>;
22
+ image: z.ZodOptional<z.ZodString>;
23
+ price: z.ZodOptional<z.ZodNumber>;
24
+ isHidden: z.ZodOptional<z.ZodBoolean>;
25
+ url: z.ZodOptional<z.ZodString>;
26
+ retailerId: z.ZodOptional<z.ZodString>;
27
+ }, z.core.$strip>;
28
+ export type CatalogEditProductInput = z.infer<typeof catalogEditProductSchema>;
29
+ export type CatalogEditProductOutput = ProductModel;
17
30
  /**
18
- * Get your current catalog
31
+ * Edit an existing product in your catalog
19
32
  *
20
33
  * @example
21
34
  * ```javascript
22
- * // Get your current catalog
23
- * const myCatalog = WPP.catalog.editProduct('5498255476885590', {name: 'Plano 01', price: '89990', description: 'Insert description for your product', isHidden: true, url: 'http://www.wppconnect.io', retailerId: 'AKA001'});
35
+ * const product = await WPP.catalog.editProduct({
36
+ * productId: '[productId]',
37
+ * name: 'Updated Name',
38
+ * price: 2000,
39
+ * });
24
40
  * ```
25
41
  *
26
- * @return Return model of product edited
42
+ * @category Catalog
27
43
  */
28
- export interface editProductParams {
29
- name?: string;
30
- description?: string;
31
- image?: string;
32
- price?: number;
33
- isHidden?: boolean;
34
- url?: string;
35
- retailerId?: string;
36
- }
37
- export declare function editProduct(productId: string, params: editProductParams): Promise<ProductModel>;
44
+ export declare function editProduct(params: CatalogEditProductInput): Promise<CatalogEditProductOutput>;
45
+ export {};
@@ -13,19 +13,28 @@
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 { ProductCollModel } from '../../whatsapp';
18
+ declare const catalogGetCollectionsSchema: z.ZodObject<{
19
+ chatId: z.ZodString;
20
+ limit: z.ZodOptional<z.ZodNumber>;
21
+ productsCount: z.ZodOptional<z.ZodNumber>;
22
+ }, z.core.$strip>;
23
+ export type CatalogGetCollectionsInput = z.infer<typeof catalogGetCollectionsSchema>;
24
+ export type CatalogGetCollectionsOutput = ProductCollModel[];
17
25
  /**
18
26
  * Get collections of catalog
19
27
  *
20
28
  * @example
21
29
  * ```javascript
22
30
  * // Retrieve 20 collections of chat
23
- * const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20');
31
+ * const myCatalog = await WPP.catalog.getCollections({ chatId: '[chatId]', limit: 20 });
24
32
  *
25
33
  * // Retrieve 20 collections of chat and products arrays limit with 10 products
26
- * const myCatalog = await WPP.catalog.getCollections('552198554578@c.us', '20', '10');
34
+ * const myCatalog = await WPP.catalog.getCollections({ chatId: '[chatId]', limit: 20, productsCount: 10 });
27
35
  * ```
28
36
  *
29
37
  * @return Your collections of products
30
38
  */
31
- export declare function getCollections(chatId: string, qnt?: number, productsCount?: number): Promise<ProductCollModel[]>;
39
+ export declare function getCollections(params: CatalogGetCollectionsInput): Promise<CatalogGetCollectionsOutput>;
40
+ 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,6 +13,8 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
+ import { CatalogStore } from '../../whatsapp';
17
+ export type CatalogGetMyCatalogOutput = ReturnType<typeof CatalogStore.get>;
16
18
  /**
17
19
  * Get your current catalog
18
20
  *
@@ -24,4 +26,4 @@
24
26
  *
25
27
  * @return Your current catalog
26
28
  */
27
- export declare function getMyCatalog(): Promise<import("../../whatsapp").CatalogModel | undefined>;
29
+ export declare function getMyCatalog(): Promise<CatalogGetMyCatalogOutput>;
@@ -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,18 +13,13 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- /**
17
- * Retrieves product by id
18
- *
19
- * @example
20
- * ```javascript
21
- * // Retrieve data of product
22
- * await WPP.catalog.getProductById('5521985565656@c.us', '68685985868923');
23
- * ```
24
- *
25
- * @category Catalog
26
- */
27
- export declare function getProductById(chatId: string, productId: number): Promise<{
16
+ import { z } from 'zod';
17
+ declare const catalogGetProductByIdSchema: z.ZodObject<{
18
+ chatId: z.ZodString;
19
+ productId: z.ZodNumber;
20
+ }, z.core.$strip>;
21
+ export type CatalogGetProductByIdInput = z.infer<typeof catalogGetProductByIdSchema>;
22
+ export type CatalogGetProductByIdOutput = {
28
23
  id: string;
29
24
  retailer_id: string;
30
25
  name: string;
@@ -47,4 +42,19 @@ export declare function getProductById(chatId: string, productId: number): Promi
47
42
  key: 'WHATSAPP';
48
43
  value: 'APPROVED';
49
44
  }[];
50
- }>;
45
+ };
46
+ /**
47
+ * Get a product by its ID from a business catalog
48
+ *
49
+ * @example
50
+ * ```javascript
51
+ * const product = await WPP.catalog.getProductById({
52
+ * chatId: '[chatId]',
53
+ * productId: 123456789,
54
+ * });
55
+ * ```
56
+ *
57
+ * @category Catalog
58
+ */
59
+ export declare function getProductById(params: CatalogGetProductByIdInput): Promise<CatalogGetProductByIdOutput>;
60
+ 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,15 +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';
17
+ declare const catalogGetProductsSchema: z.ZodObject<{
18
+ chatId: z.ZodString;
19
+ limit: z.ZodOptional<z.ZodNumber>;
20
+ }, z.core.$strip>;
21
+ export type CatalogGetProductsInput = z.infer<typeof catalogGetProductsSchema>;
22
+ export type CatalogGetProductsOutput = any[];
16
23
  /**
17
- * Retrieves product by contact id
24
+ * Get products from a business catalog
18
25
  *
19
26
  * @example
20
- * Get products of catalogs
21
27
  * ```javascript
22
- * await WPP.catalog.getProducts('5521985625689@c.us', 10);
28
+ * const products = await WPP.catalog.getProducts({ chatId: '[chatId]' });
29
+ *
30
+ * // Limit the number of products returned
31
+ * const products = await WPP.catalog.getProducts({ chatId: '[chatId]', limit: 20 });
23
32
  * ```
24
- * @return A array with products
33
+ *
25
34
  * @category Catalog
26
35
  */
27
- export declare function getProducts(chatId: string, qnt: number): Promise<any[]>;
36
+ export declare function getProducts(params: CatalogGetProductsInput): Promise<CatalogGetProductsOutput>;
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,18 +13,18 @@
13
13
  * See the License for the specific language governing permissions and
14
14
  * limitations under the License.
15
15
  */
16
- export { addProductImage } from './addProductImage';
17
- export { changeProductImage } from './changeProductImage';
18
- export { createCollection } from './createCollection';
19
- export { createProduct } from './createProduct';
20
- export { deleteCollection } from './deleteCollection';
21
- export { delProducts } from './deleteProduct';
22
- export { editCollection } from './editCollection';
23
- export { editProduct } from './editProduct';
24
- export { getCollections } from './getCollections';
25
- export { getMyCatalog } from './getMyCatalog';
26
- export { getProductById } from './getProductById';
27
- export { getProducts } from './getProducts';
28
- export { removeProductImage } from './removeProductImage';
29
- export { setProductVisibility } from './setProductVisibility';
30
- export { updateCartEnabled } from './updateCartEnabled';
16
+ export { addProductImage, CatalogAddProductImageInput, CatalogAddProductImageOutput, } from './addProductImage';
17
+ export { CatalogChangeProductImageInput, CatalogChangeProductImageOutput, changeProductImage, } from './changeProductImage';
18
+ export { CatalogCreateCollectionInput, CatalogCreateCollectionOutput, createCollection, } from './createCollection';
19
+ export { CatalogCreateProductInput, CatalogCreateProductOutput, createProduct, } from './createProduct';
20
+ export { CatalogDeleteCollectionInput, CatalogDeleteCollectionOutput, deleteCollection, } from './deleteCollection';
21
+ export { CatalogDeleteProductsInput, CatalogDeleteProductsOutput, deleteProducts, } from './deleteProduct';
22
+ export { CatalogEditCollectionInput, CatalogEditCollectionOutput, editCollection, } from './editCollection';
23
+ export { CatalogEditProductInput, CatalogEditProductOutput, editProduct, } from './editProduct';
24
+ export { CatalogGetCollectionsInput, CatalogGetCollectionsOutput, getCollections, } from './getCollections';
25
+ export { CatalogGetMyCatalogOutput, getMyCatalog } from './getMyCatalog';
26
+ export { CatalogGetProductByIdInput, CatalogGetProductByIdOutput, getProductById, } from './getProductById';
27
+ export { CatalogGetProductsInput, CatalogGetProductsOutput, getProducts, } from './getProducts';
28
+ export { CatalogRemoveProductImageInput, CatalogRemoveProductImageOutput, removeProductImage, } from './removeProductImage';
29
+ export { CatalogSetProductVisibilityInput, CatalogSetProductVisibilityOutput, setProductVisibility, } from './setProductVisibility';
30
+ export { CatalogUpdateCartEnabledInput, CatalogUpdateCartEnabledOutput, updateCartEnabled, } from './updateCartEnabled';
@@ -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,17 +13,26 @@
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 { ProductModel } from '../../whatsapp';
18
+ declare const catalogRemoveProductImageSchema: z.ZodObject<{
19
+ productId: z.ZodString;
20
+ index: z.ZodString;
21
+ }, z.core.$strip>;
22
+ export type CatalogRemoveProductImageInput = z.infer<typeof catalogRemoveProductImageSchema>;
23
+ export type CatalogRemoveProductImageOutput = ProductModel;
17
24
  /**
18
- * Remove image on product
19
- * This function remove additional images of product
20
- * for change main image use @changeProductImage
25
+ * Remove an additional image from a product by its index
21
26
  *
22
27
  * @example
23
28
  * ```javascript
24
- * await WPP.catalog.removeProductImage('68685985868923', '0');
29
+ * await WPP.catalog.removeProductImage({
30
+ * productId: '[productId]',
31
+ * index: '0',
32
+ * });
25
33
  * ```
26
- * @param index - Index of array additionalImageCdnUrl
34
+ *
27
35
  * @category Catalog
28
36
  */
29
- export declare function removeProductImage(productId: string, index: string): Promise<ProductModel>;
37
+ export declare function removeProductImage(params: CatalogRemoveProductImageInput): Promise<CatalogRemoveProductImageOutput>;
38
+ export {};
@@ -1,5 +1,5 @@
1
1
  /*!
2
- * Copyright 2022 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,18 +13,27 @@
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';
17
+ import { ProductModel } from '../../whatsapp';
18
+ declare const catalogSetProductVisibilitySchema: z.ZodObject<{
19
+ productId: z.ZodString;
20
+ isHidden: z.ZodBoolean;
21
+ }, z.core.$strip>;
22
+ export type CatalogSetProductVisibilityInput = z.infer<typeof catalogSetProductVisibilitySchema>;
23
+ export type CatalogSetProductVisibilityOutput = ProductModel;
16
24
  /**
17
- * Get your current catalog
25
+ * Show or hide a product in your catalog
18
26
  *
19
27
  * @example
20
28
  * ```javascript
21
- * // Set product visibility hidden
22
- * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, true);
23
- * ```
24
- * // Set product visible
25
- * const myCatalog = await WPP.catalog.setProductVisibility(54985569989897, false);
29
+ * // Hide a product
30
+ * await WPP.catalog.setProductVisibility({ productId: '[productId]', isHidden: true });
31
+ *
32
+ * // Make a product visible
33
+ * await WPP.catalog.setProductVisibility({ productId: '[productId]', isHidden: false });
26
34
  * ```
27
35
  *
28
- * @return Return sucess of product visibility set
36
+ * @category Catalog
29
37
  */
30
- export declare function setProductVisibility(productId: any, isHidden: boolean): Promise<any>;
38
+ export declare function setProductVisibility(params: CatalogSetProductVisibilityInput): Promise<CatalogSetProductVisibilityOutput>;
39
+ export {};