@wppconnect/wa-js 2.27.0 → 2.28.1

package/CHANGELOG.md

@@ -1,9 +1,4 @@
-# 2.27.0 (2023-10-08)
-
-
-### Features
-
-* Added newsletter functions (close [#1365](https://github.com/wppconnect-team/wa-js/issues/1365)) ([#1386](https://github.com/wppconnect-team/wa-js/issues/1386)) ([b0bab71](https://github.com/wppconnect-team/wa-js/commit/b0bab717f9370a0be9767c6500df697cce083415))
+## 2.28.1 (2023-12-20)
 
 
 

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

@@ -28,13 +28,13 @@ export interface DeleteMessageReturn {
  * @example
  * ```javascript
  * // Delete a message
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid');
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid');
  * // Delete a list of messages
- * WPP.chat.deleteMessage('[number]@callback.us', ['msgid1', 'msgid2]);
+ * WPP.chat.deleteMessage('[number]@c.us', ['msgid1', 'msgid2]);
  * // Delete a message and delete media
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid', true);
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid', true);
  * // Revoke a message
- * WPP.chat.deleteMessage('[number]@callback.us', 'msgid', true, true);
+ * WPP.chat.deleteMessage('[number]@c.us', 'msgid', true, true);
  * ```
  *
  * @category Message

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

@@ -36,6 +36,7 @@ export { getQuotedMsg } from './getQuotedMsg';
 export { getQuotedMsgKey } from './getQuotedMsgKey';
 export { getReactions } from './getReactions';
 export { getVotes } from './getVotes';
+export { keepMessage } from './keepMessage';
 export { ChatListOptions, list } from './list';
 export { markIsComposing } from './markIsComposing';
 export { markIsPaused } from './markIsPaused';
@@ -56,10 +57,10 @@ export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMess
 export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
 export { ListMessageOptions, sendListMessage } from './sendListMessage';
 export { LocationMessageOptions, sendLocationMessage, } from './sendLocationMessage';
-export { sendOrderMessage } from './sendOrderMessage';
+export { OrderItems, OrderMessageOptions, sendOrderMessage, } from './sendOrderMessage';
 export { sendRawMessage } from './sendRawMessage';
 export { sendReactionToMessage } from './sendReactionToMessage';
-export { sendScheduledCallMessage } from './sendScheduledCallMessage';
+export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendScheduledCallMessage';
 export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
 export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
 export { starMessage, StarMessageReturn } from './starMessage';

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

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Keep or unkeep a message in a group chat with expiration
+ *
+ * @example
+ * ```javascript
+ * // To keep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', true);
+ *
+ * // To unkeep a message in chat
+ * WPP.chat.keepMessage('true_[number]@c.us_ABCDEF', false);
+ * ```
+ * @category Chat
+ */
+export declare function keepMessage(msgId: string | MsgKey, value?: boolean): Promise<MsgModel>;

package/dist/conn/functions/genLinkDeviceCodeForPhoneNumber.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Alternative login method using code
+ * Get the Link Device Code for Authentication using the phone number
+ *
+ * @example
+ * ```javascript
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]');
+ *
+ * // Disable push notification
+ * const code = await WPP.conn.genLinkDeviceCodeForPhoneNumber('[number]', false);
+ * ```
+ *
+ * @category Conn
+ */
+export declare function genLinkDeviceCodeForPhoneNumber(phone: string, sendPushNotification?: boolean): Promise<string>;

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { genLinkDeviceCodeForPhoneNumber } from './genLinkDeviceCodeForPhoneNumber';
 export { getAuthCode } from './getAuthCode';
 export { getHistorySyncProgress, HistorySyncProgress, } from './getHistorySyncProgress';
 export { getMyDeviceId } from './getMyDeviceId';

package/dist/contact/functions/get.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ContactModel, Wid } from '../../whatsapp';
+/**
+ * Get a contact by id
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.get('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function get(contactId: string | Wid): Promise<ContactModel | undefined>;

package/dist/contact/functions/getCommonGroups.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../../whatsapp';
+/**
+ * Get all commons groups for the contact
+ *
+ * @example
+ * ```javascript
+ * const groups_ids = await WPP.contact.getCommonGroups('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function getCommonGroups(wid: Wid | string): Promise<Wid[]>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2023 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { get } from './get';
 export { getBusinessProfile } from './getBusinessProfile';
+export { getCommonGroups } from './getCommonGroups';
 export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';

package/dist/whatsapp/enums/KIC_ENTRY_POINT_TYP.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @whatsapp 982015
+ */
+export declare enum KIC_ENTRY_POINT_TYPE {
+    CHAT_INFO = 1,
+    SEARCH = 2,
+    CHAT = 3,
+    MEDIA = 4,
+    DOCS = 5,
+    LINKS = 6
+}

package/dist/whatsapp/enums/index.d.ts

@@ -16,6 +16,7 @@
 export * from './ACK';
 export * from './CALL_STATES';
 export * from './GROUP_SETTING_TYPE';
+export * from './KIC_ENTRY_POINT_TYP';
 export * from './LogoutReason';
 export * from './MSG_TYPE';
 export * from './OUTWARD_TYPES';

package/dist/whatsapp/functions/GROUP_JID.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Wid } from '../misc';
+/**
+ * @whatsapp 355813
+ */
+export declare function GROUP_JID(jid: Wid): any;
+export declare function CHAT_JID(jid: Wid): any;

package/dist/whatsapp/functions/createFanoutMsgStanza.d.ts

@@ -17,7 +17,7 @@ import { MsgModel, websocket, Wid } from '..';
 /**
  *
  */
-export declare function createFanoutMsgStanza(msg: MsgModel, proto: {
+export declare function createFanoutMsgStanza(msg: MsgModel, data: any, proto: {
     [key: string]: any;
 }, devices: Wid[], options: {
     [key: string]: any;

package/dist/whatsapp/functions/findCommonGroups.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { BaseCollection } from '../collections';
+import { ChatModel, ContactModel } from '../models';
+/**
+ * @whatsapp 714574
+ */
+export declare function findCommonGroups(wid: ContactModel): Promise<BaseCollection<ChatModel>>;

package/dist/whatsapp/functions/forwardMessagesToChats.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright 2021 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { ChatModel, MsgModel } from '../models';
+/** @whatsapp 69951
+ * @whatsapp 450192 >= 2.2353.0
+ */
+export declare function forwardMessagesToChats(msgs: MsgModel[], chats: ChatModel[], displayCaptionText?: boolean): Promise<boolean>;

package/dist/whatsapp/functions/genLinkDeviceCodeForPhoneNumber.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @whatsapp 61777
+ */
+export declare function genLinkDeviceCodeForPhoneNumber(phone: string, pushNotification: boolean): Promise<string>;

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

@@ -39,9 +39,12 @@ export * from './encryptAndSendSenderKeyMsg';
 export * from './encryptMsgProtobuf';
 export * from './fetchLinkPreview';
 export * from './findChat';
+export * from './findCommonGroups';
 export * from './findFirstWebLink';
+export * from './forwardMessagesToChats';
 export * from './frontendFireAndForget';
 export * from './generateVideoThumbsAndDuration';
+export * from './genLinkDeviceCodeForPhoneNumber';
 export * from './genMinimalLinkPreview';
 export * from './getABPropConfigValue';
 export * from './getAsMms';
@@ -62,14 +65,17 @@ export * from './getReactions';
 export * from './getSearchContext';
 export * from './getVotes';
 export * from './getWhatsAppWebExternalBetaJoinedIdb';
+export * from './GROUP_JID';
 export * from './groupParticipants';
 export * from './handleAck';
 export * from './handleSingleMsg';
+export * from './initializeAltDeviceLinking';
 export * from './isAnimatedWebp';
 export * from './isAuthenticated';
 export * from './isRegistered';
 export * from './isUnreadTypeMsg';
 export * from './joinGroupViaInvite';
+export * from './keepMessage';
 export * from './markSeen';
 export * from './mediaTypeFromProtobuf';
 export * from './membershipApprovalRequestAction';

package/dist/whatsapp/functions/initializeAltDeviceLinking.d.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * @whatsapp 518043
+ */
+export declare function initializeAltDeviceLinking(): Promise<void>;

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

@@ -0,0 +1,23 @@
+/*!
+ * Copyright 2023 WPPConnect Team
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { MsgModel } from '..';
+/**
+ * @whatsapp 170235
+ */
+export declare function keepMessage(msg: MsgModel, t: number): Promise<any>;
+export declare function undoKeepMessage(msg: MsgModel, options: {
+    deleteExpired: boolean;
+}, n: number): Promise<any>;