@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
|
@@ -13,28 +13,20 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
onlyWithUnreadMessage: z.ZodOptional<z.ZodBoolean>;
|
|
31
|
-
onlyArchived: z.ZodOptional<z.ZodBoolean>;
|
|
32
|
-
withLabels: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
33
|
-
ignoreGroupMetadata: z.ZodOptional<z.ZodBoolean>;
|
|
34
|
-
}, z.core.$strip>>;
|
|
35
|
-
}, z.core.$strip>;
|
|
36
|
-
export type ChatListInput = z.infer<typeof chatListSchema>;
|
|
37
|
-
export type ChatListOutput = ChatModel[];
|
|
16
|
+
import { ChatModel, Wid } from '../../whatsapp';
|
|
17
|
+
export interface ChatListOptions {
|
|
18
|
+
id?: Wid;
|
|
19
|
+
count?: number;
|
|
20
|
+
direction?: 'after' | 'before';
|
|
21
|
+
onlyCommunities?: boolean;
|
|
22
|
+
onlyGroups?: boolean;
|
|
23
|
+
onlyNewsletter?: boolean;
|
|
24
|
+
onlyUsers?: boolean;
|
|
25
|
+
onlyWithUnreadMessage?: boolean;
|
|
26
|
+
onlyArchived?: boolean;
|
|
27
|
+
withLabels?: string[];
|
|
28
|
+
ignoreGroupMetadata?: boolean;
|
|
29
|
+
}
|
|
38
30
|
/**
|
|
39
31
|
* Return a list of chats
|
|
40
32
|
*
|
|
@@ -44,31 +36,39 @@ export type ChatListOutput = ChatModel[];
|
|
|
44
36
|
* const chats = await WPP.chat.list();
|
|
45
37
|
*
|
|
46
38
|
* // Some chats
|
|
47
|
-
* const chats =
|
|
39
|
+
* const chats = WPP.chat.list({count: 20});
|
|
48
40
|
*
|
|
49
41
|
* // 20 chats before specific chat
|
|
50
|
-
* const chats =
|
|
42
|
+
* const chats = WPP.chat.list({count: 20, direction: 'before', id: '[number]@c.us'});
|
|
51
43
|
*
|
|
52
44
|
* // Only users chats
|
|
53
|
-
* const chats = await WPP.chat.list({
|
|
45
|
+
* const chats = await WPP.chat.list({onlyUsers: true});
|
|
54
46
|
*
|
|
55
47
|
* // Only groups chats
|
|
56
|
-
* const chats = await WPP.chat.list({
|
|
48
|
+
* const chats = await WPP.chat.list({onlyGroups: true});
|
|
57
49
|
*
|
|
58
50
|
* // Only communities chats
|
|
59
|
-
* const chats = await WPP.chat.list({
|
|
51
|
+
* const chats = await WPP.chat.list({onlyCommunities: true});
|
|
60
52
|
*
|
|
61
53
|
* // Only Newsletter
|
|
62
|
-
* const chats = await WPP.chat.list({
|
|
54
|
+
* const chats = await WPP.chat.list({onlyNewsletter: true});
|
|
63
55
|
*
|
|
64
|
-
* // Only with label
|
|
65
|
-
* const chats = await WPP.chat.list({
|
|
56
|
+
* // Only with label Text
|
|
57
|
+
* const chats = await WPP.chat.list({withLabels: ['Test']});
|
|
58
|
+
*
|
|
59
|
+
* // Only with label id
|
|
60
|
+
* const chats = await WPP.chat.list({withLabels: ['1']});
|
|
61
|
+
*
|
|
62
|
+
* // Only with label with one of text or id
|
|
63
|
+
* const chats = await WPP.chat.list({withLabels: ['Alfa','5']});
|
|
66
64
|
*
|
|
67
65
|
* // Only archived chats
|
|
68
|
-
* const chats = await WPP.chat.list({
|
|
66
|
+
* const chats = await WPP.chat.list({onlyArchived: true});
|
|
67
|
+
*
|
|
68
|
+
* // Ignore group metadata search
|
|
69
|
+
* const chats = await WPP.chat.list({ignoreGroupMetadata: true})
|
|
69
70
|
* ```
|
|
70
71
|
*
|
|
71
72
|
* @category Chat
|
|
72
73
|
*/
|
|
73
|
-
export declare function list(
|
|
74
|
-
export {};
|
|
74
|
+
export declare function list(options?: ChatListOptions): Promise<ChatModel[]>;
|
|
@@ -13,13 +13,7 @@
|
|
|
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 chatMarkIsComposingSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
duration: z.ZodOptional<z.ZodNumber>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ChatMarkIsComposingInput = z.infer<typeof chatMarkIsComposingSchema>;
|
|
22
|
-
export type ChatMarkIsComposingOutput = void;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
18
|
* Mark a chat to composing state
|
|
25
19
|
* and keep sending "is writting a message"
|
|
@@ -34,5 +28,4 @@ export type ChatMarkIsComposingOutput = void;
|
|
|
34
28
|
* ```
|
|
35
29
|
* @category Chat
|
|
36
30
|
*/
|
|
37
|
-
export declare function markIsComposing(
|
|
38
|
-
export {};
|
|
31
|
+
export declare function markIsComposing(chatId: string | Wid, duration?: number): Promise<void>;
|
|
@@ -13,12 +13,7 @@
|
|
|
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 chatMarkIsPausedSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type ChatMarkIsPausedInput = z.infer<typeof chatMarkIsPausedSchema>;
|
|
21
|
-
export type ChatMarkIsPausedOutput = void;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
22
17
|
/**
|
|
23
18
|
* Mark a chat is paused state
|
|
24
19
|
*
|
|
@@ -29,5 +24,4 @@ export type ChatMarkIsPausedOutput = void;
|
|
|
29
24
|
* ```
|
|
30
25
|
* @category Chat
|
|
31
26
|
*/
|
|
32
|
-
export declare function markIsPaused(
|
|
33
|
-
export {};
|
|
27
|
+
export declare function markIsPaused(chatId: string | Wid): Promise<void>;
|
|
@@ -13,14 +13,7 @@
|
|
|
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 chatMarkIsReadSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type ChatMarkIsReadInput = z.infer<typeof chatMarkIsReadSchema>;
|
|
21
|
-
export type ChatMarkIsReadOutput = {
|
|
22
|
-
unreadCount: number;
|
|
23
|
-
};
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
24
17
|
/**
|
|
25
18
|
* Mark a chat as read and send SEEN event
|
|
26
19
|
*
|
|
@@ -31,5 +24,7 @@ export type ChatMarkIsReadOutput = {
|
|
|
31
24
|
* ```
|
|
32
25
|
* @category Chat
|
|
33
26
|
*/
|
|
34
|
-
export declare function markIsRead(
|
|
35
|
-
|
|
27
|
+
export declare function markIsRead(chatId: string | Wid): Promise<{
|
|
28
|
+
wid: Wid;
|
|
29
|
+
unreadCount: number;
|
|
30
|
+
}>;
|
|
@@ -13,13 +13,7 @@
|
|
|
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 chatMarkIsRecordingSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
duration: z.ZodOptional<z.ZodNumber>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ChatMarkIsRecordingInput = z.infer<typeof chatMarkIsRecordingSchema>;
|
|
22
|
-
export type ChatMarkIsRecordingOutput = void;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
18
|
* Mark a chat to recording state
|
|
25
19
|
* and keep sending "is recording"
|
|
@@ -34,5 +28,4 @@ export type ChatMarkIsRecordingOutput = void;
|
|
|
34
28
|
* ```
|
|
35
29
|
* @category Chat
|
|
36
30
|
*/
|
|
37
|
-
export declare function markIsRecording(
|
|
38
|
-
export {};
|
|
31
|
+
export declare function markIsRecording(chatId: string | Wid, duration?: number): Promise<void>;
|
|
@@ -13,12 +13,7 @@
|
|
|
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 chatMarkIsUnreadSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type ChatMarkIsUnreadInput = z.infer<typeof chatMarkIsUnreadSchema>;
|
|
21
|
-
export type ChatMarkIsUnreadOutput = void;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
22
17
|
/**
|
|
23
18
|
* Mark a chat as unread
|
|
24
19
|
*
|
|
@@ -29,5 +24,6 @@ export type ChatMarkIsUnreadOutput = void;
|
|
|
29
24
|
* ```
|
|
30
25
|
* @category Chat
|
|
31
26
|
*/
|
|
32
|
-
export declare function markIsUnread(
|
|
33
|
-
|
|
27
|
+
export declare function markIsUnread(chatId: string | Wid): Promise<{
|
|
28
|
+
wid: Wid;
|
|
29
|
+
}>;
|
|
@@ -13,20 +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
|
-
|
|
18
|
-
messageId: z.ZodString;
|
|
19
|
-
}, z.core.$strip>;
|
|
20
|
-
export type ChatMarkPlayedInput = z.infer<typeof chatMarkPlayedSchema>;
|
|
21
|
-
export type ChatMarkPlayedOutput = any;
|
|
16
|
+
import { Stringable } from '../../types';
|
|
17
|
+
import { MsgKey, MsgModel } from '../../whatsapp';
|
|
22
18
|
/**
|
|
23
19
|
* Mark message as played
|
|
24
20
|
*
|
|
25
21
|
* @example
|
|
26
22
|
* ```javascript
|
|
27
|
-
* WPP.chat.markPlayed(
|
|
23
|
+
* WPP.chat.markPlayed('[message_id]');
|
|
28
24
|
* ```
|
|
29
25
|
* @category Message
|
|
30
26
|
*/
|
|
31
|
-
export declare function markPlayed(
|
|
32
|
-
export {};
|
|
27
|
+
export declare function markPlayed(messageId: string | MsgKey | MsgModel | Stringable): Promise<any>;
|
|
@@ -13,18 +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';
|
|
17
16
|
import { Wid } from '../../whatsapp';
|
|
18
|
-
declare const chatMuteSchema: z.ZodObject<{
|
|
19
|
-
chatId: z.ZodString;
|
|
20
|
-
time: z.ZodAny;
|
|
21
|
-
}, z.core.$strip>;
|
|
22
|
-
export type ChatMuteInput = z.infer<typeof chatMuteSchema>;
|
|
23
|
-
export type ChatMuteOutput = {
|
|
24
|
-
wid: Wid;
|
|
25
|
-
expiration: number;
|
|
26
|
-
isMuted: boolean;
|
|
27
|
-
};
|
|
28
17
|
/**
|
|
29
18
|
* Mute a chat, you can use duration or expiration
|
|
30
19
|
* For expiration, use unix timestamp (seconds only)
|
|
@@ -45,5 +34,12 @@ export type ChatMuteOutput = {
|
|
|
45
34
|
*
|
|
46
35
|
* @category Chat
|
|
47
36
|
*/
|
|
48
|
-
export declare function mute(
|
|
49
|
-
|
|
37
|
+
export declare function mute(chatId: string | Wid, time: {
|
|
38
|
+
expiration: number | Date;
|
|
39
|
+
} | {
|
|
40
|
+
duration: number;
|
|
41
|
+
}): Promise<{
|
|
42
|
+
wid: Wid;
|
|
43
|
+
expiration: number;
|
|
44
|
+
isMuted: boolean;
|
|
45
|
+
}>;
|
|
@@ -13,25 +13,17 @@
|
|
|
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 chatOpenChatAtSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
messageId: z.ZodString;
|
|
20
|
-
chatEntryPoint: z.ZodOptional<z.ZodString>;
|
|
21
|
-
}, z.core.$strip>;
|
|
22
|
-
export type ChatOpenChatAtInput = z.infer<typeof chatOpenChatAtSchema>;
|
|
23
|
-
export type ChatOpenChatAtOutput = boolean;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
24
17
|
/**
|
|
25
18
|
* Open the chat in the WhatsApp interface in a specific message
|
|
26
19
|
*
|
|
27
20
|
* @example
|
|
28
21
|
* ```javascript
|
|
29
|
-
* await WPP.chat.openChatAt(
|
|
22
|
+
* await WPP.chat.openChatAt('[number]@c.us', <message_id>);
|
|
30
23
|
* ```
|
|
31
24
|
*
|
|
32
25
|
* @argument chatEntryPoint Optional chat entry point: "Chatlist" for any existing chat in the left panel, undefined for any other case.
|
|
33
26
|
*
|
|
34
27
|
* @category Chat
|
|
35
28
|
*/
|
|
36
|
-
export declare function openChatAt(
|
|
37
|
-
export {};
|
|
29
|
+
export declare function openChatAt(chatId: string | Wid, messageId: string, chatEntryPoint?: string | undefined): Promise<boolean>;
|
|
@@ -13,13 +13,7 @@
|
|
|
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 chatOpenChatBottomSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
chatEntryPoint: z.ZodOptional<z.ZodString>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ChatOpenChatBottomInput = z.infer<typeof chatOpenChatBottomSchema>;
|
|
22
|
-
export type ChatOpenChatBottomOutput = boolean;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
18
|
* Open the chat in the WhatsApp interface in bottom position
|
|
25
19
|
*
|
|
@@ -32,5 +26,4 @@ export type ChatOpenChatBottomOutput = boolean;
|
|
|
32
26
|
*
|
|
33
27
|
* @category Chat
|
|
34
28
|
*/
|
|
35
|
-
export declare function openChatBottom(
|
|
36
|
-
export {};
|
|
29
|
+
export declare function openChatBottom(chatId: string | Wid, chatEntryPoint?: string | undefined): Promise<boolean>;
|
|
@@ -13,13 +13,7 @@
|
|
|
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 chatOpenChatFromUnreadSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
chatEntryPoint: z.ZodOptional<z.ZodString>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ChatOpenChatFromUnreadInput = z.infer<typeof chatOpenChatFromUnreadSchema>;
|
|
22
|
-
export type ChatOpenChatFromUnreadOutput = boolean;
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
23
17
|
/**
|
|
24
18
|
* Open the chat in the WhatsApp interface from first unread message
|
|
25
19
|
*
|
|
@@ -32,5 +26,4 @@ export type ChatOpenChatFromUnreadOutput = boolean;
|
|
|
32
26
|
*
|
|
33
27
|
* @category Chat
|
|
34
28
|
*/
|
|
35
|
-
export declare function openChatFromUnread(
|
|
36
|
-
export {};
|
|
29
|
+
export declare function openChatFromUnread(chatId: string | Wid, chatEntryPoint?: string | undefined): Promise<boolean>;
|
|
@@ -13,40 +13,42 @@
|
|
|
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 chatPinSchema: z.ZodObject<{
|
|
18
|
-
chatId: z.ZodString;
|
|
19
|
-
pin: z.ZodOptional<z.ZodBoolean>;
|
|
20
|
-
}, z.core.$strip>;
|
|
21
|
-
export type ChatPinInput = z.infer<typeof chatPinSchema>;
|
|
22
|
-
export type ChatPinOutput = {
|
|
23
|
-
wid: import('../../whatsapp').Wid;
|
|
24
|
-
pin: boolean;
|
|
25
|
-
};
|
|
16
|
+
import { Wid } from '../../whatsapp';
|
|
26
17
|
/**
|
|
27
18
|
* Pin a chat
|
|
28
19
|
*
|
|
29
20
|
* @example
|
|
30
21
|
* ```javascript
|
|
31
22
|
* // Pin a chat
|
|
32
|
-
* WPP.chat.pin(
|
|
23
|
+
* WPP.chat.pin('[number]@c.us');
|
|
33
24
|
*
|
|
34
25
|
* // Unpin a chat
|
|
35
|
-
* WPP.chat.pin(
|
|
26
|
+
* WPP.chat.pin('[number]@c.us', false);
|
|
36
27
|
* // or
|
|
37
|
-
* WPP.chat.unpin(
|
|
28
|
+
* WPP.chat.unpin('[number]@c.us');
|
|
38
29
|
* ```
|
|
39
30
|
* @category Chat
|
|
40
31
|
*/
|
|
41
|
-
export declare function pin(
|
|
32
|
+
export declare function pin(chatId: string | Wid, pin?: boolean): Promise<{
|
|
33
|
+
wid: Wid;
|
|
34
|
+
pin: boolean;
|
|
35
|
+
}>;
|
|
42
36
|
/**
|
|
43
37
|
* Unpin a chat
|
|
44
38
|
*
|
|
45
39
|
* @alias pin
|
|
46
40
|
*
|
|
41
|
+
* @example
|
|
42
|
+
* ```javascript
|
|
43
|
+
* // Unpin a chat
|
|
44
|
+
* WPP.chat.unpin('[number]@c.us');
|
|
45
|
+
*
|
|
46
|
+
* // Alias for
|
|
47
|
+
* WPP.chat.pin('[number]@c.us', false);
|
|
48
|
+
* ```
|
|
47
49
|
* @category Chat
|
|
48
50
|
*/
|
|
49
|
-
export declare function unpin(
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
export declare function unpin(chatId: string | Wid): Promise<{
|
|
52
|
+
wid: Wid;
|
|
53
|
+
pin: boolean;
|
|
54
|
+
}>;
|
|
@@ -13,20 +13,8 @@
|
|
|
13
13
|
* See the License for the specific language governing permissions and
|
|
14
14
|
* limitations under the License.
|
|
15
15
|
*/
|
|
16
|
-
import {
|
|
17
|
-
import { MsgModel } from '../../whatsapp';
|
|
16
|
+
import { MsgKey, MsgModel } from '../../whatsapp';
|
|
18
17
|
import { PinExpiryDurationOption, SendMsgResult } from '../../whatsapp/enums';
|
|
19
|
-
declare const chatPinMsgSchema: z.ZodObject<{
|
|
20
|
-
msgId: z.ZodString;
|
|
21
|
-
pin: z.ZodOptional<z.ZodBoolean>;
|
|
22
|
-
duration: z.ZodOptional<z.ZodDefault<z.ZodEnum<typeof PinExpiryDurationOption>>>;
|
|
23
|
-
}, z.core.$strip>;
|
|
24
|
-
export type ChatPinMsgInput = z.infer<typeof chatPinMsgSchema>;
|
|
25
|
-
export type ChatPinMsgOutput = {
|
|
26
|
-
message: MsgModel;
|
|
27
|
-
pinned: boolean;
|
|
28
|
-
result: SendMsgResult;
|
|
29
|
-
};
|
|
30
18
|
/**
|
|
31
19
|
* Pin a message in chat
|
|
32
20
|
*
|
|
@@ -59,7 +47,11 @@ export type ChatPinMsgOutput = {
|
|
|
59
47
|
* ```
|
|
60
48
|
* @category Chat
|
|
61
49
|
*/
|
|
62
|
-
export declare function pinMsg(
|
|
50
|
+
export declare function pinMsg(msgId: string | MsgKey, pin?: boolean, duration?: number | PinExpiryDurationOption): Promise<{
|
|
51
|
+
message: MsgModel;
|
|
52
|
+
pinned: boolean;
|
|
53
|
+
result: SendMsgResult;
|
|
54
|
+
}>;
|
|
63
55
|
/**
|
|
64
56
|
* Unpin a message in chat
|
|
65
57
|
*
|
|
@@ -75,5 +67,8 @@ export declare function pinMsg(params: ChatPinMsgInput): Promise<ChatPinMsgOutpu
|
|
|
75
67
|
* ```
|
|
76
68
|
* @category Chat
|
|
77
69
|
*/
|
|
78
|
-
export declare function unpinMsg(msgId: string): Promise<
|
|
79
|
-
|
|
70
|
+
export declare function unpinMsg(msgId: string | MsgKey): Promise<{
|
|
71
|
+
message: MsgModel;
|
|
72
|
+
pinned: boolean;
|
|
73
|
+
result: SendMsgResult;
|
|
74
|
+
}>;
|
|
@@ -13,39 +13,14 @@
|
|
|
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 chatPrepareAudioWaveformSchema: z.ZodObject<{
|
|
18
|
-
options: z.ZodObject<{
|
|
19
|
-
createChat: z.ZodOptional<z.ZodBoolean>;
|
|
20
|
-
detectMentioned: z.ZodOptional<z.ZodBoolean>;
|
|
21
|
-
markIsRead: z.ZodOptional<z.ZodBoolean>;
|
|
22
|
-
messageId: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>]>>;
|
|
23
|
-
mentionedList: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").Wid, import("../../whatsapp").Wid>]>>>;
|
|
24
|
-
quotedMsg: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodCustom<import("../../whatsapp").MsgKey, import("../../whatsapp").MsgKey>, z.ZodCustom<import("../../whatsapp").MsgModel, import("../../whatsapp").MsgModel>]>>;
|
|
25
|
-
quotedMsgPayload: z.ZodOptional<z.ZodString>;
|
|
26
|
-
waitForAck: z.ZodOptional<z.ZodBoolean>;
|
|
27
|
-
delay: z.ZodOptional<z.ZodNumber>;
|
|
28
|
-
type: z.ZodLiteral<"audio">;
|
|
29
|
-
caption: z.ZodOptional<z.ZodString>;
|
|
30
|
-
footer: z.ZodOptional<z.ZodString>;
|
|
31
|
-
filename: z.ZodOptional<z.ZodString>;
|
|
32
|
-
mimetype: z.ZodOptional<z.ZodString>;
|
|
33
|
-
isPtt: z.ZodOptional<z.ZodBoolean>;
|
|
34
|
-
isViewOnce: z.ZodOptional<z.ZodBoolean>;
|
|
35
|
-
waveform: z.ZodOptional<z.ZodBoolean>;
|
|
36
|
-
}, z.core.$strip>;
|
|
37
|
-
file: z.ZodCustom<File, File>;
|
|
38
|
-
}, z.core.$strip>;
|
|
39
|
-
export type ChatPrepareAudioWaveformInput = z.infer<typeof chatPrepareAudioWaveformSchema>;
|
|
40
|
-
export type ChatPrepareAudioWaveformOutput = undefined | {
|
|
41
|
-
duration: number;
|
|
42
|
-
waveform: Uint8Array;
|
|
43
|
-
};
|
|
16
|
+
import type { AudioMessageOptions } from './sendFileMessage';
|
|
44
17
|
/**
|
|
45
18
|
* Prepare waveform form message audio file
|
|
46
19
|
*
|
|
47
20
|
* @category Message
|
|
48
21
|
* @internal
|
|
49
22
|
*/
|
|
50
|
-
export declare function prepareAudioWaveform(
|
|
51
|
-
|
|
23
|
+
export declare function prepareAudioWaveform(options: AudioMessageOptions, file: File): Promise<undefined | {
|
|
24
|
+
duration: number;
|
|
25
|
+
waveform: Uint8Array;
|
|
26
|
+
}>;
|
|
@@ -13,41 +13,41 @@
|
|
|
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 { RawMessage } from '..';
|
|
18
|
-
export
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
17
|
+
export interface LinkPreviewOptions {
|
|
18
|
+
/**
|
|
19
|
+
* Send text message with link preview
|
|
20
|
+
*
|
|
21
|
+
* @default true
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```javascript
|
|
25
|
+
* // Automatic detection
|
|
26
|
+
* WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8');
|
|
27
|
+
*
|
|
28
|
+
* // Overriding the title and description
|
|
29
|
+
* WPP.chat.sendTextMessage('[number]@c.us', 'See https://www.youtube.com/watch?v=v1PBptSDIh8', {
|
|
30
|
+
* linkPreview: {
|
|
31
|
+
* title: 'Another text',
|
|
32
|
+
* description: 'Another description'
|
|
33
|
+
* }
|
|
34
|
+
* });
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
linkPreview?: boolean | {
|
|
38
|
+
title?: string;
|
|
39
|
+
description?: string;
|
|
40
|
+
canonicalUrl?: string;
|
|
41
|
+
matchedText?: string;
|
|
42
|
+
richPreviewType?: number;
|
|
43
|
+
thumbnail?: string;
|
|
44
|
+
doNotPlayInline: boolean;
|
|
45
|
+
};
|
|
46
|
+
}
|
|
46
47
|
/**
|
|
47
48
|
* Prepare a message for link preview
|
|
48
49
|
*
|
|
49
50
|
* @category Message
|
|
50
51
|
* @internal
|
|
51
52
|
*/
|
|
52
|
-
export declare function prepareLinkPreview(
|
|
53
|
-
export {};
|
|
53
|
+
export declare function prepareLinkPreview<T extends RawMessage>(message: T, options: LinkPreviewOptions): Promise<T>;
|
|
@@ -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 { RawMessage } from '..';
|
|
18
17
|
export type MessageButtonsTypes = {
|
|
19
18
|
id: string;
|
|
@@ -42,49 +41,10 @@ export interface MessageButtonsOptions {
|
|
|
42
41
|
*/
|
|
43
42
|
footer?: string;
|
|
44
43
|
}
|
|
45
|
-
export declare const messageButtonsOptionsSchema: z.ZodObject<{
|
|
46
|
-
buttons: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
47
|
-
id: z.ZodString;
|
|
48
|
-
text: z.ZodString;
|
|
49
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
50
|
-
phoneNumber: z.ZodString;
|
|
51
|
-
text: z.ZodString;
|
|
52
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
53
|
-
url: z.ZodString;
|
|
54
|
-
text: z.ZodString;
|
|
55
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
56
|
-
code: z.ZodString;
|
|
57
|
-
text: z.ZodString;
|
|
58
|
-
}, z.core.$strip>]>>>;
|
|
59
|
-
title: z.ZodOptional<z.ZodString>;
|
|
60
|
-
footer: z.ZodOptional<z.ZodString>;
|
|
61
|
-
}, z.core.$strip>;
|
|
62
|
-
declare const chatPrepareMessageButtonsSchema: z.ZodObject<{
|
|
63
|
-
message: z.ZodCustom<RawMessage, RawMessage>;
|
|
64
|
-
options: z.ZodObject<{
|
|
65
|
-
buttons: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
66
|
-
id: z.ZodString;
|
|
67
|
-
text: z.ZodString;
|
|
68
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
69
|
-
phoneNumber: z.ZodString;
|
|
70
|
-
text: z.ZodString;
|
|
71
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
72
|
-
url: z.ZodString;
|
|
73
|
-
text: z.ZodString;
|
|
74
|
-
}, z.core.$strip>, z.ZodObject<{
|
|
75
|
-
code: z.ZodString;
|
|
76
|
-
text: z.ZodString;
|
|
77
|
-
}, z.core.$strip>]>>>;
|
|
78
|
-
title: z.ZodOptional<z.ZodString>;
|
|
79
|
-
footer: z.ZodOptional<z.ZodString>;
|
|
80
|
-
}, z.core.$strip>;
|
|
81
|
-
}, z.core.$strip>;
|
|
82
|
-
export type ChatPrepareMessageButtonsInput = z.infer<typeof chatPrepareMessageButtonsSchema>;
|
|
83
44
|
/**
|
|
84
45
|
* Prepare a message for buttons
|
|
85
46
|
*
|
|
86
47
|
* @category Message
|
|
87
48
|
* @internal
|
|
88
49
|
*/
|
|
89
|
-
export declare function prepareMessageButtons<T extends RawMessage>(
|
|
90
|
-
export {};
|
|
50
|
+
export declare function prepareMessageButtons<T extends RawMessage>(message: T, options: MessageButtonsOptions): T;
|