@wppconnect/wa-js 4.0.2-alpha.0 → 4.1.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.
- package/CHANGELOG.md +3 -1
- package/README.md +2 -2
- package/changelog.config.cjs +43 -0
- package/dist/blocklist/functions/all.d.ts +2 -3
- package/dist/blocklist/functions/blockContact.d.ts +3 -12
- package/dist/blocklist/functions/index.d.ts +4 -4
- package/dist/blocklist/functions/isBlocked.d.ts +3 -9
- package/dist/blocklist/functions/unblockContact.d.ts +3 -12
- package/dist/blocklist/types.d.ts +20 -0
- package/dist/call/events/registerIncomingCallEvent.d.ts +0 -15
- package/dist/call/functions/accept.d.ts +6 -13
- package/dist/call/functions/enableCallInterface.d.ts +2 -3
- package/dist/call/functions/end.d.ts +4 -11
- package/dist/call/functions/index.d.ts +6 -6
- package/dist/call/functions/offer.d.ts +8 -13
- package/dist/call/functions/parseRelayResponse.d.ts +2 -9
- package/dist/call/functions/prepareDestination.d.ts +2 -10
- package/dist/call/functions/reject.d.ts +4 -11
- package/dist/cart/functions/add.d.ts +5 -29
- package/dist/cart/functions/clear.d.ts +2 -19
- package/dist/cart/functions/get.d.ts +5 -12
- package/dist/cart/functions/getThumbFromCart.d.ts +2 -19
- package/dist/cart/functions/index.d.ts +7 -7
- package/dist/cart/functions/remove.d.ts +2 -23
- package/dist/cart/functions/submit.d.ts +3 -40
- package/dist/cart/functions/update.d.ts +4 -25
- package/dist/catalog/functions/addProductImage.d.ts +6 -15
- package/dist/catalog/functions/changeProductImage.d.ts +6 -15
- package/dist/catalog/functions/createCollection.d.ts +5 -16
- package/dist/catalog/functions/createProduct.d.ts +25 -25
- package/dist/catalog/functions/deleteCollection.d.ts +5 -12
- package/dist/catalog/functions/deleteProduct.d.ts +9 -17
- package/dist/catalog/functions/editCollection.d.ts +10 -19
- package/dist/catalog/functions/editProduct.d.ts +15 -23
- package/dist/catalog/functions/getCollections.d.ts +3 -12
- package/dist/catalog/functions/getMyCatalog.d.ts +2 -4
- package/dist/catalog/functions/getProductById.d.ts +14 -24
- package/dist/catalog/functions/getProducts.d.ts +6 -16
- package/dist/catalog/functions/index.d.ts +16 -16
- package/dist/catalog/functions/removeProductImage.d.ts +7 -16
- package/dist/catalog/functions/setProductVisibility.d.ts +9 -18
- package/dist/catalog/functions/updateCartEnabled.d.ts +9 -16
- package/dist/chat/functions/archive.d.ts +20 -15
- package/dist/chat/functions/canMarkPlayed.d.ts +4 -9
- package/dist/chat/functions/canMute.d.ts +3 -9
- package/dist/chat/functions/canReply.d.ts +4 -9
- package/dist/chat/functions/clear.d.ts +5 -13
- package/dist/chat/functions/closeChat.d.ts +2 -3
- package/dist/chat/functions/delete.d.ts +4 -10
- package/dist/chat/functions/{deleteMessages.d.ts → deleteMessage.d.ts} +6 -15
- package/dist/chat/functions/downloadMedia.d.ts +3 -10
- package/dist/chat/functions/editMessage.d.ts +6 -33
- package/dist/chat/functions/find.d.ts +2 -9
- package/dist/chat/functions/forwardMessage.d.ts +7 -14
- package/dist/chat/functions/forwardMessages.d.ts +8 -15
- package/dist/chat/functions/generateMessageID.d.ts +2 -9
- package/dist/chat/functions/get.d.ts +2 -9
- package/dist/chat/functions/getActiveChat.d.ts +2 -4
- package/dist/chat/functions/getLastSeen.d.ts +2 -8
- package/dist/chat/functions/getMessageACK.d.ts +11 -18
- package/dist/chat/functions/getMessageById.d.ts +10 -12
- package/dist/chat/functions/getMessages.d.ts +53 -33
- package/dist/chat/functions/getNotes.d.ts +3 -10
- package/dist/chat/functions/getPlatformFromMessage.d.ts +3 -8
- package/dist/chat/functions/getQuotedMsg.d.ts +2 -9
- package/dist/chat/functions/getQuotedMsgKey.d.ts +2 -9
- package/dist/chat/functions/getReactions.d.ts +10 -17
- package/dist/chat/functions/getUnreadChats.d.ts +1 -8
- package/dist/chat/functions/getVotes.d.ts +10 -17
- package/dist/chat/functions/index.d.ts +65 -66
- package/dist/chat/functions/keepMessage.d.ts +4 -12
- package/dist/chat/functions/list.d.ts +33 -33
- package/dist/chat/functions/markIsComposing.d.ts +2 -9
- package/dist/chat/functions/markIsPaused.d.ts +2 -8
- package/dist/chat/functions/markIsRead.d.ts +5 -10
- package/dist/chat/functions/markIsRecording.d.ts +2 -9
- package/dist/chat/functions/markIsUnread.d.ts +4 -8
- package/dist/chat/functions/markPlayed.d.ts +4 -9
- package/dist/chat/functions/mute.d.ts +9 -13
- package/dist/chat/functions/openChatAt.d.ts +3 -11
- package/dist/chat/functions/openChatBottom.d.ts +2 -9
- package/dist/chat/functions/openChatFromUnread.d.ts +2 -9
- package/dist/chat/functions/pin.d.ts +20 -18
- package/dist/chat/functions/pinMsg.d.ts +11 -16
- package/dist/chat/functions/prepareAudioWaveform.d.ts +5 -30
- package/dist/chat/functions/prepareLinkPreview.d.ts +31 -31
- package/dist/chat/functions/prepareMessageButtons.d.ts +1 -41
- package/dist/chat/functions/prepareRawMessage.d.ts +3 -22
- package/dist/chat/functions/replyToButtonMessage.d.ts +1 -12
- package/dist/chat/functions/requestPhoneNumber.d.ts +3 -10
- package/dist/chat/functions/sendCatalogMessage.d.ts +12 -34
- package/dist/chat/functions/sendChargeMessage.d.ts +25 -65
- package/dist/chat/functions/sendCreatePollMessage.d.ts +18 -35
- package/dist/chat/functions/sendEventMessage.d.ts +22 -62
- package/dist/chat/functions/sendFileMessage.d.ts +2 -10
- package/dist/chat/functions/sendGroupInviteMessage.d.ts +16 -39
- package/dist/chat/functions/sendListMessage.d.ts +17 -50
- package/dist/chat/functions/sendLocationMessage.d.ts +48 -52
- package/dist/chat/functions/sendPixKeyMessage.d.ts +10 -26
- package/dist/chat/functions/sendRawMessage.d.ts +2 -22
- package/dist/chat/functions/sendReactionToMessage.d.ts +7 -13
- package/dist/chat/functions/sendScheduledCallMessage.d.ts +6 -17
- package/dist/chat/functions/sendTextMessage.d.ts +28 -11
- package/dist/chat/functions/sendVCardContactMessage.d.ts +19 -44
- package/dist/chat/functions/setChatList.d.ts +2 -10
- package/dist/chat/functions/setInputText.d.ts +3 -10
- package/dist/chat/functions/setNotes.d.ts +2 -10
- package/dist/chat/functions/starMessage.d.ts +16 -13
- package/dist/chat/functions/unmute.d.ts +2 -8
- package/dist/chat/types.d.ts +101 -13
- package/dist/community/functions/addSubgroups.d.ts +11 -21
- package/dist/community/functions/create.d.ts +4 -16
- package/dist/community/functions/deactivate.d.ts +4 -10
- package/dist/community/functions/demoteParticipants.d.ts +4 -14
- package/dist/community/functions/getAnnouncementGroup.d.ts +3 -11
- package/dist/community/functions/getParticipants.d.ts +3 -9
- package/dist/community/functions/getSubgroups.d.ts +3 -11
- package/dist/community/functions/index.d.ts +9 -9
- package/dist/community/functions/promoteParticipants.d.ts +4 -14
- package/dist/community/functions/removeSubgroups.d.ts +10 -20
- package/dist/conn/events/eventTypes.d.ts +16 -0
- package/dist/conn/events/index.d.ts +1 -0
- package/dist/conn/events/registerBackendEventBusEvents.d.ts +16 -0
- package/dist/conn/functions/changeEnviromentDevice.d.ts +2 -3
- package/dist/conn/functions/genLinkDeviceCodeForPhoneNumber.d.ts +4 -12
- package/dist/conn/functions/getABProps.d.ts +6 -15
- package/dist/conn/functions/getAuthCode.d.ts +2 -3
- package/dist/conn/functions/getAutoDownloadSettings.d.ts +6 -7
- package/dist/conn/functions/getBuildConstants.d.ts +8 -21
- package/dist/conn/functions/getHistorySyncProgress.d.ts +4 -4
- package/dist/conn/functions/getMigrationState.d.ts +4 -4
- package/dist/conn/functions/getMyDeviceId.d.ts +2 -3
- package/dist/conn/functions/getMyUserId.d.ts +2 -3
- package/dist/conn/functions/getMyUserLid.d.ts +2 -3
- package/dist/conn/functions/getMyUserWid.d.ts +2 -3
- package/dist/conn/functions/getPlatform.d.ts +2 -3
- package/dist/conn/functions/getStreamData.d.ts +3 -3
- package/dist/conn/functions/getTheme.d.ts +1 -2
- package/dist/conn/functions/index.d.ts +33 -33
- package/dist/conn/functions/isAuthenticated.d.ts +2 -3
- package/dist/conn/functions/isIdle.d.ts +2 -3
- package/dist/conn/functions/isMainInit.d.ts +2 -3
- package/dist/conn/functions/isMainLoaded.d.ts +2 -3
- package/dist/conn/functions/isMainReady.d.ts +2 -3
- package/dist/conn/functions/isMultiDevice.d.ts +2 -3
- package/dist/conn/functions/isOnline.d.ts +2 -3
- package/dist/conn/functions/isRegistered.d.ts +2 -3
- package/dist/conn/functions/joinWebBeta.d.ts +4 -11
- package/dist/conn/functions/logout.d.ts +2 -3
- package/dist/conn/functions/markAvailable.d.ts +4 -12
- package/dist/conn/functions/needsUpdate.d.ts +2 -3
- package/dist/conn/functions/refreshQR.d.ts +2 -3
- package/dist/conn/functions/setAutoDownloadSettings.d.ts +19 -11
- package/dist/conn/functions/setKeepAlive.d.ts +4 -11
- package/dist/conn/functions/setLimit.d.ts +38 -28
- package/dist/conn/functions/setMultiDevice.d.ts +4 -11
- package/dist/conn/functions/setTheme.d.ts +7 -14
- package/dist/contact/functions/get.d.ts +7 -12
- package/dist/contact/functions/getBusinessProfile.d.ts +5 -12
- package/dist/contact/functions/getCommonGroups.d.ts +3 -10
- package/dist/contact/functions/getPnLidEntry.d.ts +5 -10
- package/dist/contact/functions/getProfilePictureUrl.d.ts +5 -12
- package/dist/contact/functions/getStatus.d.ts +4 -10
- package/dist/contact/functions/index.d.ts +19 -14
- package/dist/contact/functions/list.d.ts +11 -15
- package/dist/contact/functions/queryExists.d.ts +5 -42
- package/dist/contact/functions/queryUsernameExists.d.ts +61 -0
- package/dist/contact/functions/queryWidExists.d.ts +51 -0
- package/dist/contact/functions/remove.d.ts +4 -11
- package/dist/contact/functions/reportContact.d.ts +14 -16
- package/dist/contact/functions/save.d.ts +11 -18
- package/dist/contact/functions/subscribePresence.d.ts +4 -11
- package/dist/contact/functions/unsubscribePresence.d.ts +3 -11
- package/dist/eventEmitter/eventTypes.d.ts +3 -3
- package/dist/eventEmitter/index.d.ts +41 -41
- package/dist/group/functions/addParticipants.d.ts +12 -19
- package/dist/group/functions/approve.d.ts +6 -14
- package/dist/group/functions/canAdd.d.ts +4 -10
- package/dist/group/functions/canDemote.d.ts +4 -11
- package/dist/group/functions/canPromote.d.ts +4 -11
- package/dist/group/functions/canRemove.d.ts +4 -11
- package/dist/group/functions/create.d.ts +14 -23
- package/dist/group/functions/demoteParticipants.d.ts +5 -12
- package/dist/group/functions/ensureGroup.d.ts +3 -11
- package/dist/group/functions/ensureGroupAndParticipants.d.ts +5 -14
- package/dist/group/functions/getAllGroups.d.ts +2 -4
- package/dist/group/functions/getGroupInfoFromInviteCode.d.ts +35 -10
- package/dist/group/functions/getGroupSizeLimit.d.ts +2 -3
- package/dist/group/functions/getInviteCode.d.ts +4 -10
- package/dist/group/functions/getMembershipRequests.d.ts +9 -16
- package/dist/group/functions/getParticipants.d.ts +4 -11
- package/dist/group/functions/getPastParticipants.d.ts +4 -11
- package/dist/group/functions/iAmAdmin.d.ts +3 -9
- package/dist/group/functions/iAmMember.d.ts +3 -9
- package/dist/group/functions/iAmRestrictedMember.d.ts +3 -9
- package/dist/group/functions/iAmSuperAdmin.d.ts +3 -9
- package/dist/group/functions/index.d.ts +32 -32
- package/dist/group/functions/join.d.ts +5 -12
- package/dist/group/functions/leave.d.ts +4 -10
- package/dist/group/functions/promoteParticipants.d.ts +5 -12
- package/dist/group/functions/reject.d.ts +6 -14
- package/dist/group/functions/removeIcon.d.ts +4 -10
- package/dist/group/functions/removeParticipants.d.ts +5 -12
- package/dist/group/functions/revokeInviteCode.d.ts +4 -10
- package/dist/group/functions/setDescription.d.ts +4 -11
- package/dist/group/functions/setIcon.d.ts +10 -17
- package/dist/group/functions/setProperty.d.ts +11 -19
- package/dist/group/functions/setSubject.d.ts +4 -11
- package/dist/index.d.ts +8 -8
- package/dist/indexdb/functions/getMessagesFromRowId.d.ts +13 -9
- package/dist/indexdb/functions/index.d.ts +1 -1
- package/dist/labels/functions/addNewLabel.d.ts +13 -14
- package/dist/labels/functions/addOrRemoveLabels.d.ts +11 -20
- package/dist/labels/functions/colorIsInLabelPalette.d.ts +5 -11
- package/dist/labels/functions/deleteAllLabels.d.ts +2 -14
- package/dist/labels/functions/deleteLabel.d.ts +3 -9
- package/dist/labels/functions/editLabel.d.ts +13 -15
- package/dist/labels/functions/getAllLabels.d.ts +2 -14
- package/dist/labels/functions/getLabelById.d.ts +2 -9
- package/dist/labels/functions/getLabelColorPalette.d.ts +2 -11
- package/dist/labels/functions/getNewLabelColor.d.ts +3 -12
- package/dist/labels/functions/index.d.ts +11 -11
- package/dist/loader/blacklist.d.ts +28 -0
- package/dist/{webpack → loader}/eventTypes.d.ts +4 -4
- package/dist/{webpack → loader}/index.d.ts +14 -9
- package/dist/newsletter/functions/create.d.ts +11 -16
- package/dist/newsletter/functions/destroy.d.ts +3 -10
- package/dist/newsletter/functions/edit.d.ts +16 -25
- package/dist/newsletter/functions/ensureNewsletter.d.ts +3 -8
- package/dist/newsletter/functions/follow.d.ts +2 -9
- package/dist/newsletter/functions/getSubscribers.d.ts +3 -10
- package/dist/newsletter/functions/index.d.ts +9 -9
- package/dist/newsletter/functions/mute.d.ts +4 -12
- package/dist/newsletter/functions/search.d.ts +12 -18
- package/dist/newsletter/functions/unfollow.d.ts +2 -9
- package/dist/order/functions/accept.d.ts +10 -9
- package/dist/order/functions/decline.d.ts +12 -10
- package/dist/order/functions/get.d.ts +5 -12
- package/dist/order/functions/index.d.ts +5 -5
- package/dist/order/functions/update.d.ts +3 -16
- package/dist/privacy/functions/get.d.ts +3 -14
- package/dist/privacy/functions/getDisallowedList.d.ts +13 -20
- package/dist/privacy/functions/index.d.ts +9 -9
- package/dist/privacy/functions/prepareDisallowedList.d.ts +6 -18
- package/dist/privacy/functions/setAbout.d.ts +6 -39
- package/dist/privacy/functions/setAddGroup.d.ts +6 -37
- package/dist/privacy/functions/setLastSeen.d.ts +6 -39
- package/dist/privacy/functions/setOnline.d.ts +3 -22
- package/dist/privacy/functions/setProfilePic.d.ts +6 -39
- package/dist/privacy/functions/setReadReceipts.d.ts +3 -22
- package/dist/privacy/functions/setStatus.d.ts +4 -31
- package/dist/profile/functions/editBusinessProfile.d.ts +4 -21
- package/dist/profile/functions/getMyProfileName.d.ts +2 -3
- package/dist/profile/functions/getMyProfilePicture.d.ts +2 -3
- package/dist/profile/functions/getMyStatus.d.ts +2 -3
- package/dist/profile/functions/index.d.ts +9 -9
- package/dist/profile/functions/isBusiness.d.ts +3 -4
- package/dist/profile/functions/removeMyProfilePicture.d.ts +2 -3
- package/dist/profile/functions/setMyProfileName.d.ts +3 -10
- package/dist/profile/functions/setMyProfilePicture.d.ts +9 -16
- package/dist/profile/functions/setMyStatus.d.ts +3 -10
- package/dist/status/defaultSendStatusOptions.d.ts +19 -0
- package/dist/status/functions/get.d.ts +3 -18
- package/dist/status/functions/getMyStatus.d.ts +2 -3
- package/dist/status/functions/index.d.ts +10 -10
- package/dist/status/functions/postSendStatus.d.ts +2 -9
- package/dist/status/functions/remove.d.ts +3 -17
- package/dist/status/functions/sendImageStatus.d.ts +5 -14
- package/dist/status/functions/sendRawStatus.d.ts +8 -12
- package/dist/status/functions/sendReadStatus.d.ts +4 -11
- package/dist/status/functions/sendTextStatus.d.ts +8 -16
- package/dist/status/functions/sendVideoStatus.d.ts +5 -14
- package/dist/status/functions/updateParticipants.d.ts +9 -11
- package/dist/status/index.d.ts +1 -0
- package/dist/types.d.ts +0 -20
- package/dist/whatsapp/exportModule.d.ts +2 -2
- package/dist/whatsapp/functions/deleteContactAction.d.ts +23 -3
- package/dist/whatsapp/functions/index.d.ts +1 -0
- package/dist/whatsapp/functions/sendQueryExists.d.ts +2 -1
- package/dist/whatsapp/functions/sendQueryUsernameExists.d.ts +36 -0
- package/dist/whatsapp/functions/setArchive.d.ts +9 -0
- package/dist/whatsapp/misc/BackendEventBus.d.ts +55 -0
- package/dist/whatsapp/misc/DBCreateLidPnMappings.d.ts +1 -0
- package/dist/whatsapp/misc/USyncQuery.d.ts +46 -15
- package/dist/whatsapp/misc/index.d.ts +1 -0
- package/dist/wppconnect-wa.js +1 -1
- package/dist/wppconnect-wa.js.LICENSE.txt +1 -1
- package/eslint.config.mjs +14 -0
- package/package.json +6 -9
package/dist/chat/types.d.ts
CHANGED
|
@@ -13,21 +13,109 @@
|
|
|
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
16
|
import { ModelPropertiesContructor, MsgKey, MsgModel, SendMsgResultObject, Wid } from '../whatsapp';
|
|
18
17
|
export type { SendMsgResultObject };
|
|
19
|
-
export
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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
|
+
}
|
|
31
119
|
export interface SendMessageReturn {
|
|
32
120
|
id: string;
|
|
33
121
|
from?: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2023 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,31 +13,21 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
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
|
-
};
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
29
17
|
/**
|
|
30
|
-
* Add groups
|
|
18
|
+
* Add groups do community
|
|
31
19
|
*
|
|
32
20
|
* @example
|
|
33
21
|
* ```javascript
|
|
34
|
-
* await WPP.community.addSubgroups(
|
|
35
|
-
* communityId: '123456@g.us',
|
|
36
|
-
* subgroupIds: ['[groupId1]', '[groupId2]'],
|
|
37
|
-
* });
|
|
22
|
+
* await WPP.community.addSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
|
|
38
23
|
* ```
|
|
39
24
|
*
|
|
40
25
|
* @category Community
|
|
41
26
|
*/
|
|
42
|
-
export declare function addSubgroups(
|
|
43
|
-
|
|
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
|
+
}>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2023 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,27 +13,15 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityCreateSchema: z.ZodObject<{
|
|
18
|
-
name: z.ZodString;
|
|
19
|
-
description: z.ZodString;
|
|
20
|
-
subgroupIds: z.ZodArray<z.ZodString>;
|
|
21
|
-
}, z.core.$strip>;
|
|
22
|
-
export type CommunityCreateInput = z.infer<typeof communityCreateSchema>;
|
|
23
|
-
export type CommunityCreateOutput = any;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
24
17
|
/**
|
|
25
18
|
* Create a community
|
|
26
19
|
*
|
|
27
20
|
* @example
|
|
28
21
|
* ```javascript
|
|
29
|
-
*
|
|
30
|
-
* name: 'My Community',
|
|
31
|
-
* description: 'Community description',
|
|
32
|
-
* subgroupIds: ['[groupId1]', '[groupId2]'],
|
|
33
|
-
* });
|
|
22
|
+
* await WPP.community.create('Name for community', 'description for community', ['123456@g.us', '123456@g.us']);
|
|
34
23
|
* ```
|
|
35
24
|
*
|
|
36
25
|
* @category Community
|
|
37
26
|
*/
|
|
38
|
-
export declare function create(
|
|
39
|
-
export {};
|
|
27
|
+
export declare function create(name: string, desc: string, subGroupsIds: (string | Wid) | (string | Wid)[]): Promise<any>;
|
|
@@ -13,21 +13,15 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityDeactivateSchema: z.ZodObject<{
|
|
18
|
-
communityId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type CommunityDeactivateInput = z.infer<typeof communityDeactivateSchema>;
|
|
21
|
-
export type CommunityDeactivateOutput = any;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
22
17
|
/**
|
|
23
|
-
*
|
|
18
|
+
* Deactivated a community
|
|
24
19
|
*
|
|
25
20
|
* @example
|
|
26
21
|
* ```javascript
|
|
27
|
-
* await WPP.community.deactivate(
|
|
22
|
+
* await WPP.community.deactivate('123456@g.us');
|
|
28
23
|
* ```
|
|
29
24
|
*
|
|
30
25
|
* @category Community
|
|
31
26
|
*/
|
|
32
|
-
export declare function deactivate(
|
|
33
|
-
export {};
|
|
27
|
+
export declare function deactivate(communityId: string | Wid): Promise<any>;
|
|
@@ -13,25 +13,15 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityDemoteParticipantsSchema: z.ZodObject<{
|
|
18
|
-
communityId: z.ZodString;
|
|
19
|
-
participantsIds: z.ZodArray<z.ZodString>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type CommunityDemoteParticipantsInput = z.infer<typeof communityDemoteParticipantsSchema>;
|
|
22
|
-
export type CommunityDemoteParticipantsOutput = any;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
|
-
* Remove admin
|
|
18
|
+
* Remove admin of community participant
|
|
25
19
|
*
|
|
26
20
|
* @example
|
|
27
21
|
* ```javascript
|
|
28
|
-
* await WPP.community.demoteParticipants(
|
|
29
|
-
* communityId: '[chatId]',
|
|
30
|
-
* participantsIds: ['[number]@[c.us | lid]'],
|
|
31
|
-
* });
|
|
22
|
+
* await WPP.community.demoteParticipants('123456@g.us', '123456@c.us');
|
|
32
23
|
* ```
|
|
33
24
|
*
|
|
34
25
|
* @category Community
|
|
35
26
|
*/
|
|
36
|
-
export declare function demoteParticipants(
|
|
37
|
-
export {};
|
|
27
|
+
export declare function demoteParticipants(communityId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<any>;
|
|
@@ -13,24 +13,16 @@
|
|
|
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
16
|
import { Wid } from '../../whatsapp';
|
|
18
|
-
declare const communityGetAnnouncementGroupSchema: z.ZodObject<{
|
|
19
|
-
communityId: z.ZodString;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type CommunityGetAnnouncementGroupInput = z.infer<typeof communityGetAnnouncementGroupSchema>;
|
|
22
|
-
export type CommunityGetAnnouncementGroupOutput = Wid | undefined;
|
|
23
17
|
/**
|
|
24
18
|
* Get the default announcement group of a community
|
|
25
|
-
*
|
|
26
|
-
* You can pass any group ID inside a community
|
|
19
|
+
* You can pass any group id inside a community
|
|
27
20
|
*
|
|
28
21
|
* @example
|
|
29
22
|
* ```javascript
|
|
30
|
-
*
|
|
23
|
+
* WPP.community.getAnnouncementGroup('123456@g.us');
|
|
31
24
|
* ```
|
|
32
25
|
*
|
|
33
26
|
* @category Community
|
|
34
27
|
*/
|
|
35
|
-
export declare function getAnnouncementGroup(
|
|
36
|
-
export {};
|
|
28
|
+
export declare function getAnnouncementGroup(communityId: string | Wid): Wid | undefined;
|
|
@@ -13,21 +13,15 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityGetParticipantsSchema: z.ZodObject<{
|
|
18
|
-
communityId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type CommunityGetParticipantsInput = z.infer<typeof communityGetParticipantsSchema>;
|
|
21
|
-
export type CommunityGetParticipantsOutput = any;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
22
17
|
/**
|
|
23
18
|
* Get all participants of a community
|
|
24
19
|
*
|
|
25
20
|
* @example
|
|
26
21
|
* ```javascript
|
|
27
|
-
*
|
|
22
|
+
* await WPP.community.getParticipants('123456@g.us');
|
|
28
23
|
* ```
|
|
29
24
|
*
|
|
30
25
|
* @category Community
|
|
31
26
|
*/
|
|
32
|
-
export declare function getParticipants(
|
|
33
|
-
export {};
|
|
27
|
+
export declare function getParticipants(communityId: string | Wid): Promise<any>;
|
|
@@ -13,24 +13,16 @@
|
|
|
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
16
|
import { Wid } from '../../whatsapp';
|
|
18
|
-
declare const communityGetSubgroupsSchema: z.ZodObject<{
|
|
19
|
-
communityId: z.ZodString;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type CommunityGetSubgroupsInput = z.infer<typeof communityGetSubgroupsSchema>;
|
|
22
|
-
export type CommunityGetSubgroupsOutput = Wid[];
|
|
23
17
|
/**
|
|
24
18
|
* Get all subgroups of a community
|
|
25
|
-
*
|
|
26
|
-
* You can pass the community ID or the ID of any group inside the community
|
|
19
|
+
* You can pass id of group community, or id of a inside a grupo
|
|
27
20
|
*
|
|
28
21
|
* @example
|
|
29
22
|
* ```javascript
|
|
30
|
-
*
|
|
23
|
+
* await WPP.community.getSubgroups('123456@g.us');
|
|
31
24
|
* ```
|
|
32
25
|
*
|
|
33
26
|
* @category Community
|
|
34
27
|
*/
|
|
35
|
-
export declare function getSubgroups(
|
|
36
|
-
export {};
|
|
28
|
+
export declare function getSubgroups(communityId: string | Wid): Wid[];
|
|
@@ -13,12 +13,12 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
export { addSubgroups
|
|
17
|
-
export {
|
|
18
|
-
export {
|
|
19
|
-
export {
|
|
20
|
-
export {
|
|
21
|
-
export {
|
|
22
|
-
export {
|
|
23
|
-
export {
|
|
24
|
-
export {
|
|
16
|
+
export { addSubgroups } from './addSubgroups';
|
|
17
|
+
export { create } from './create';
|
|
18
|
+
export { deactivate } from './deactivate';
|
|
19
|
+
export { demoteParticipants } from './demoteParticipants';
|
|
20
|
+
export { getAnnouncementGroup } from './getAnnouncementGroup';
|
|
21
|
+
export { getParticipants } from './getParticipants';
|
|
22
|
+
export { getSubgroups } from './getSubgroups';
|
|
23
|
+
export { promoteParticipants } from './promoteParticipants';
|
|
24
|
+
export { removeSubgroups } from './removeSubgroups';
|
|
@@ -13,25 +13,15 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityPromoteParticipantsSchema: z.ZodObject<{
|
|
18
|
-
communityId: z.ZodString;
|
|
19
|
-
participantsIds: z.ZodArray<z.ZodString>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type CommunityPromoteParticipantsInput = z.infer<typeof communityPromoteParticipantsSchema>;
|
|
22
|
-
export type CommunityPromoteParticipantsOutput = any;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
|
-
* Promote community
|
|
18
|
+
* Promote participant of community to admin
|
|
25
19
|
*
|
|
26
20
|
* @example
|
|
27
21
|
* ```javascript
|
|
28
|
-
* await WPP.community.promoteParticipants(
|
|
29
|
-
* communityId: '123456@g.us',
|
|
30
|
-
* participantsIds: ['[number]@c.us', '[number]@lid'],
|
|
31
|
-
* });
|
|
22
|
+
* await WPP.community.promoteParticipants('123456@g.us', '123456@c.us');
|
|
32
23
|
* ```
|
|
33
24
|
*
|
|
34
25
|
* @category Community
|
|
35
26
|
*/
|
|
36
|
-
export declare function promoteParticipants(
|
|
37
|
-
export {};
|
|
27
|
+
export declare function promoteParticipants(communityId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<any>;
|
|
@@ -13,31 +13,21 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
declare const communityRemoveSubgroupsSchema: z.ZodObject<{
|
|
18
|
-
communityId: z.ZodString;
|
|
19
|
-
subgroupIds: z.ZodArray<z.ZodString>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type CommunityRemoveSubgroupsInput = z.infer<typeof communityRemoveSubgroupsSchema>;
|
|
22
|
-
export type CommunityRemoveSubgroupsOutput = {
|
|
23
|
-
failedGroups: {
|
|
24
|
-
error: string;
|
|
25
|
-
jid: string;
|
|
26
|
-
}[];
|
|
27
|
-
linkedGroupJids: string[];
|
|
28
|
-
};
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
29
17
|
/**
|
|
30
|
-
* Remove groups from
|
|
18
|
+
* Remove groups from community
|
|
31
19
|
*
|
|
32
20
|
* @example
|
|
33
21
|
* ```javascript
|
|
34
|
-
* await WPP.community.
|
|
35
|
-
* communityId: '123456@g.us',
|
|
36
|
-
* subgroupIds: ['[groupId1]', '[groupId2]'],
|
|
37
|
-
* });
|
|
22
|
+
* await WPP.community.sendUnlinkSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
|
|
38
23
|
* ```
|
|
39
24
|
*
|
|
40
25
|
* @category Community
|
|
41
26
|
*/
|
|
42
|
-
export declare function removeSubgroups(
|
|
43
|
-
|
|
27
|
+
export declare function removeSubgroups(parentGroupId: string | Wid, subgroupIds: (string | Wid) | (string | Wid)[]): Promise<{
|
|
28
|
+
failedGroups: {
|
|
29
|
+
error: string;
|
|
30
|
+
jid: string;
|
|
31
|
+
}[];
|
|
32
|
+
linkedGroupJids: string[];
|
|
33
|
+
}>;
|
|
@@ -13,10 +13,26 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
+
import { BackendEventName } from '../../whatsapp';
|
|
16
17
|
import { LogoutReason, StreamInfo, StreamMode } from '../../whatsapp/enums';
|
|
17
18
|
import { AuthCode } from '../types';
|
|
18
19
|
export interface ConnEventTypes {
|
|
19
20
|
'conn.auth_code_change': AuthCode | null;
|
|
21
|
+
/**
|
|
22
|
+
* Triggered for every event emitted by WhatsApp Web's internal BackendEventBus.
|
|
23
|
+
* The first argument is the event name (one of the BackendEvent constant values).
|
|
24
|
+
* Some events carry additional arguments (e.g. set_socket_state passes the new state).
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```javascript
|
|
28
|
+
* WPP.on('conn.backend_event', (eventName, ...args) => {
|
|
29
|
+
* if (eventName === 'storage_initialization_error') {
|
|
30
|
+
* // Browser IndexedDB failed — clear profile and restart to recover
|
|
31
|
+
* }
|
|
32
|
+
* });
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
'conn.backend_event': (eventName: BackendEventName, ...args: any[]) => void;
|
|
20
36
|
/**
|
|
21
37
|
* Triggered afted a success QR code scan
|
|
22
38
|
*
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/*!
|
|
2
|
+
* Copyright 2021 WPPConnect Team
|
|
3
|
+
*
|
|
4
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
5
|
+
* you may not use this file except in compliance with the License.
|
|
6
|
+
* You may obtain a copy of the License at
|
|
7
|
+
*
|
|
8
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
9
|
+
*
|
|
10
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
11
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
12
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
13
|
+
* See the License for the specific language governing permissions and
|
|
14
|
+
* limitations under the License.
|
|
15
|
+
*/
|
|
16
|
+
export {};
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2021 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,8 +13,7 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
export type ConnChangeEnviromentDeviceOutput = void;
|
|
17
16
|
/**
|
|
18
17
|
* Change the current environment device between Web and Windows.
|
|
19
18
|
*/
|
|
20
|
-
export declare function changeEnviromentDevice():
|
|
19
|
+
export declare function changeEnviromentDevice(): void;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2023 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,26 +13,18 @@
|
|
|
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 connGenLinkDeviceCodeForPhoneNumberSchema: z.ZodObject<{
|
|
18
|
-
phone: z.ZodString;
|
|
19
|
-
sendPushNotification: z.ZodOptional<z.ZodBoolean>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ConnGenLinkDeviceCodeForPhoneNumberInput = z.infer<typeof connGenLinkDeviceCodeForPhoneNumberSchema>;
|
|
22
|
-
export type ConnGenLinkDeviceCodeForPhoneNumberOutput = string;
|
|
23
16
|
/**
|
|
24
17
|
* Alternative login method using code
|
|
25
18
|
* Get the Link Device Code for Authentication using the phone number
|
|
26
19
|
*
|
|
27
20
|
* @example
|
|
28
21
|
* ```javascript
|
|
29
|
-
* const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber(
|
|
22
|
+
* const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');
|
|
30
23
|
*
|
|
31
24
|
* // Disable push notification
|
|
32
|
-
* const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber(
|
|
25
|
+
* const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
|
|
33
26
|
* ```
|
|
34
27
|
*
|
|
35
28
|
* @category Conn
|
|
36
29
|
*/
|
|
37
|
-
export declare function genLinkDeviceCodeForPhoneNumber(
|
|
38
|
-
export {};
|
|
30
|
+
export declare function genLinkDeviceCodeForPhoneNumber(phone: string, sendPushNotification?: boolean): Promise<string>;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2021 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,7 +13,6 @@
|
|
|
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
16
|
import { RawABPropConfig } from '../../whatsapp/functions/abPropsCache';
|
|
18
17
|
/**
|
|
19
18
|
* A/B test property configuration
|
|
@@ -22,7 +21,6 @@ export interface ABPropConfig extends RawABPropConfig {
|
|
|
22
21
|
/** The human-readable config name (e.g., "web_pwa_background_sync") */
|
|
23
22
|
name: string | null;
|
|
24
23
|
}
|
|
25
|
-
export type ConnGetABPropsOutput = ABPropConfig[];
|
|
26
24
|
/**
|
|
27
25
|
* Get all A/B test property configurations for the current session
|
|
28
26
|
* These are experimental flags that WhatsApp uses for feature testing
|
|
@@ -41,8 +39,7 @@ export type ConnGetABPropsOutput = ABPropConfig[];
|
|
|
41
39
|
*
|
|
42
40
|
* @returns {ABPropConfig[]} Array of A/B property configurations with names
|
|
43
41
|
*/
|
|
44
|
-
export declare function getABProps():
|
|
45
|
-
export type ConnGetABPropsMapOutput = Map<string, ABPropConfig>;
|
|
42
|
+
export declare function getABProps(): ABPropConfig[];
|
|
46
43
|
/**
|
|
47
44
|
* Get all A/B test property configurations as a Map
|
|
48
45
|
* The map is keyed by the config code for easier lookup
|
|
@@ -69,24 +66,18 @@ export type ConnGetABPropsMapOutput = Map<string, ABPropConfig>;
|
|
|
69
66
|
*
|
|
70
67
|
* @returns {Map<string, ABPropConfig>} Map of config code to A/B property configuration with names
|
|
71
68
|
*/
|
|
72
|
-
export declare function getABPropsMap():
|
|
73
|
-
declare const connGetABPropNameSchema: z.ZodObject<{
|
|
74
|
-
configCode: z.ZodString;
|
|
75
|
-
}, z.core.$strip>;
|
|
76
|
-
export type ConnGetABPropNameInput = z.infer<typeof connGetABPropNameSchema>;
|
|
77
|
-
export type ConnGetABPropNameOutput = string | null;
|
|
69
|
+
export declare function getABPropsMap(): Map<string, ABPropConfig>;
|
|
78
70
|
/**
|
|
79
71
|
* Get the human-readable name of an A/B config from its code
|
|
80
72
|
*
|
|
81
73
|
* @example
|
|
82
74
|
* ```javascript
|
|
83
75
|
* // Get name from config code
|
|
84
|
-
* const name = WPP.conn.getABPropName(
|
|
76
|
+
* const name = WPP.conn.getABPropName('12345');
|
|
85
77
|
* console.log('Config name:', name);
|
|
86
78
|
* ```
|
|
87
79
|
*
|
|
88
|
-
* @param
|
|
80
|
+
* @param configCode - The numeric config code
|
|
89
81
|
* @returns {string|null} The human-readable config name or null if not found
|
|
90
82
|
*/
|
|
91
|
-
export declare function getABPropName(
|
|
92
|
-
export {};
|
|
83
|
+
export declare function getABPropName(configCode: string): string | null;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/*!
|
|
2
|
-
* Copyright
|
|
2
|
+
* Copyright 2021 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.
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
16
|
import { AuthCode } from '..';
|
|
17
|
-
export type ConnGetAuthCodeOutput = AuthCode | null;
|
|
18
17
|
/**
|
|
19
18
|
* Return the current auth code
|
|
20
19
|
*
|
|
@@ -26,4 +25,4 @@ export type ConnGetAuthCodeOutput = AuthCode | null;
|
|
|
26
25
|
*
|
|
27
26
|
* @return {Promise<AuthCode>}[return description]
|
|
28
27
|
*/
|
|
29
|
-
export declare function getAuthCode(): Promise<
|
|
28
|
+
export declare function getAuthCode(): Promise<AuthCode | null>;
|
|
@@ -13,12 +13,6 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
export type ConnGetAutoDownloadSettingsOutput = {
|
|
17
|
-
photos: boolean;
|
|
18
|
-
audio: boolean;
|
|
19
|
-
videos: boolean;
|
|
20
|
-
documents: boolean;
|
|
21
|
-
};
|
|
22
16
|
/**
|
|
23
17
|
* Get auto-download settings for media types
|
|
24
18
|
*
|
|
@@ -32,4 +26,9 @@ export type ConnGetAutoDownloadSettingsOutput = {
|
|
|
32
26
|
*
|
|
33
27
|
* @category Config
|
|
34
28
|
*/
|
|
35
|
-
export declare function getAutoDownloadSettings():
|
|
29
|
+
export declare function getAutoDownloadSettings(): {
|
|
30
|
+
photos: boolean;
|
|
31
|
+
audio: boolean;
|
|
32
|
+
videos: boolean;
|
|
33
|
+
documents: boolean;
|
|
34
|
+
};
|