talkyzap-wapp-api 1.0.5 → 1.0.7

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-## 3.9.1 (2024-09-05)
+# 3.14.0 (2024-10-30)
 
 
 

package/README.md

@@ -2,8 +2,8 @@
 
 [![npm version](https://img.shields.io/npm/v/@wppconnect/wa-js.svg?color=green)](https://www.npmjs.com/package/@wppconnect/wa-js)
 [![Downloads](https://img.shields.io/npm/dm/@wppconnect/wa-js.svg)](https://www.npmjs.com/package/@wppconnect/wa-js)
-[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/wppconnect-team/wa-js.svg)](https://isitmaintained.com/project/wppconnect/wa-js 'Average time to resolve an issue')
-[![Percentage of issues still open](https://isitmaintained.com/badge/open/wppconnect-team/wa-js.svg)](https://isitmaintained.com/project/wppconnect/wa-js 'Percentage of issues still open')
+[![Average time to resolve an issue](https://isitmaintained.com/badge/resolution/wppconnect-team/wa-js.svg)](https://isitmaintained.com/project/wppconnect-team/wa-js 'Average time to resolve an issue')
+[![Percentage of issues still open](https://isitmaintained.com/badge/open/wppconnect-team/wa-js.svg)](https://isitmaintained.com/project/wppconnect-team/wa-js 'Percentage of issues still open')
 
 [![Build Status](https://img.shields.io/github/actions/workflow/status/wppconnect-team/wa-js/build.yml?branch=main)](https://github.com/wppconnect-team/wa-js/actions/workflows/build.yml)
 [![Build Status](https://img.shields.io/github/actions/workflow/status/wppconnect-team/wa-js/test.yml?branch=main)](https://github.com/wppconnect-team/wa-js/actions/workflows/test.yml)
@@ -15,9 +15,9 @@
 ## Our online channels
 
 [![Discord](https://img.shields.io/discord/844351092758413353?color=blueviolet&label=Discord&logo=discord&style=flat)](https://discord.gg/JU5JGGKGNG)
-[![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/wppconnect)
-[![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
 [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCD7J9LG08PmGQrF5IS7Yv9A?label=YouTube)](https://www.youtube.com/c/wppconnect)
+[![WhatsApp Group](https://img.shields.io/badge/WhatsApp-Group-25D366?logo=whatsapp)](https://chat.whatsapp.com/LJaQu6ZyNvnBPNAVRbX00K)
+[![Telegram Group](https://img.shields.io/badge/Telegram-Group-32AFED?logo=telegram)](https://t.me/wppconnect)
 
 
 ### Top Contributors (last 45 days) widget

package/dist/assert/assertColor.d.ts

@@ -15,12 +15,12 @@
  */
 import { WPPError } from '../util';
 export declare class InvalidColor extends WPPError {
-    readonly color?: string | number | {
+    readonly color?: (string | number | {
         _serialized: string;
-    } | undefined;
-    constructor(color?: string | number | {
+    }) | undefined;
+    constructor(color?: (string | number | {
         _serialized: string;
-    } | undefined);
+    }) | undefined);
 }
 /**
  * Return the color  in positive decimal

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

@@ -0,0 +1,24 @@
+/*!
+ * Copyright 2022 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, websocket, Wid } from '../../whatsapp';
+export declare function encryptAndParserMsgButtons<TFunc extends (...args: any[]) => any>(message: {
+    type: string;
+    data: MsgModel;
+}, proto: {
+    [key: string]: any;
+}, devices: Wid[], options: {
+    [key: string]: any;
+}, reporter: any, groupData: any, func: TFunc): Promise<websocket.WapNode>;

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

@@ -17,7 +17,7 @@ import { Wid } from '../../whatsapp';
 import { SendMsgResult } from '../../whatsapp/enums';
 export interface DeleteMessageReturn {
     id: string;
-    sendMsgResult: Promise<SendMsgResult>;
+    sendMsgResult: SendMsgResult;
     isRevoked: boolean;
     isDeleted: boolean;
     isSentByMe: boolean;
@@ -39,10 +39,4 @@ export interface DeleteMessageReturn {
  *
  * @category Message
  */
-export declare function deleteMessage(chatId: string | Wid, id: string, deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn>;
-/**
- * Delete a list of messages
- *
- * @category Message
- */
-export declare function deleteMessage(chatId: string | Wid, ids: string[], deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn[]>;
+export declare function deleteMessage(chatId: string | Wid, ids: string | string[], deleteMediaInDevice?: boolean, revoke?: boolean): Promise<DeleteMessageReturn | DeleteMessageReturn[]>;

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

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2022 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 { NoteModel, Wid } from '../../whatsapp';
+/**
+ * Get notes from a contact
+ * Only when are connected with business device
+ * @example
+ * ```javascript
+ * WPP.chat.getNotes('[number]@c.us', 'Text for your notes');
+ * ```
+ * @category Chat
+ */
+export declare function getNotes(chatId: string | Wid): Promise<NoteModel | null>;

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

@@ -32,6 +32,7 @@ export { getLastSeen } from './getLastSeen';
 export { getMessageACK } from './getMessageACK';
 export { getMessageById } from './getMessageById';
 export { getMessages, GetMessagesOptions } from './getMessages';
+export { getNotes } from './getNotes';
 export { getPlatformFromMessage } from './getPlatformFromMessage';
 export { getQuotedMsg } from './getQuotedMsg';
 export { getQuotedMsgKey } from './getQuotedMsgKey';
@@ -57,6 +58,7 @@ export { prepareRawMessage } from './prepareRawMessage';
 export { requestPhoneNumber } from './requestPhoneNumber';
 export { OrderItems, OrderMessageOptions, sendChargeMessage, } from './sendChargeMessage';
 export { PoolMessageOptions, sendCreatePollMessage, } from './sendCreatePollMessage';
+export { sendEventMessage } from './sendEventMessage';
 export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
 export { GroupInviteMessage, sendGroupInviteMessage, } from './sendGroupInviteMessage';
 export { ListMessageOptions, sendListMessage } from './sendListMessage';
@@ -68,5 +70,6 @@ export { ScheduledCallMessageOptions, sendScheduledCallMessage, } from './sendSc
 export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
 export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';
 export { setInputText } from './setInputText';
+export { setNotes } from './setNotes';
 export { starMessage, StarMessageReturn } from './starMessage';
 export { unmute } from './unmute';

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2024 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -23,6 +23,9 @@ export type MessageButtonsTypes = {
 } | {
     url: string;
     text: string;
+} | {
+    code: string;
+    text: string;
 };
 export interface MessageButtonsOptions {
     /**
@@ -33,17 +36,6 @@ export interface MessageButtonsOptions {
      * Title for buttons, only for text message
      */
     title?: string;
-    /**
-     * Set to use template buttons instead of reply buttons.
-     * @default: undefined - auto detect
-     * @deprecated
-     */
-    useTemplateButtons?: boolean | null;
-    /**
-     * Set to use interactive message instead of reply buttons.
-     * @default: undefined - auto detect
-     */
-    useInteractiveMessage?: boolean | null;
     /**
      * Footer text for buttons
      */

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

@@ -0,0 +1,64 @@
+/*!
+ * Copyright 2024 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 { SendMessageOptions, SendMessageReturn } from '..';
+export interface EventMessageOptions extends SendMessageOptions {
+    callType?: 'video' | 'voice';
+    name: string;
+    description?: string;
+    startTime: number;
+    endTime?: number;
+    location?: {
+        degreesLatitude: number;
+        degreesLongitude: number;
+        name: string;
+    };
+}
+/**
+ * Send a Event Message
+ *
+ * @example
+ * ```javascript
+ * // Simple com start time and end
+ * WPP.chat.sendEventMessage('[number]@c.us', {
+ *  name: "Title of event"
+ *  description: 'Description of your event',
+ *  startTime: 1729551600
+ *  endTime: 1729551900
+ * });
+ *
+ * // Event with location
+ * WPP.chat.sendEventMessage('[number]@c.us', {
+ *  name: "Title of event"
+ *  description: 'Description of your event',
+ *  startTime: 1729551600
+ *  location: {
+ *   degreesLatitude: -22.9518551,
+ *   degreesLongitude: -43.2108338,
+ *   name: 'Cristo Redentor - RJ',
+ *  }
+ * });
+ *
+ * // Event with link for call (use voice or video)
+ * WPP.chat.sendEventMessage('[number]@c.us', {
+ *  name: "Title of event"
+ *  callType: 'voice',
+ *  description: 'Description of your event',
+ *  startTime: 1729551600
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendEventMessage(chatId: any, options: EventMessageOptions): Promise<SendMessageReturn>;

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Wid } from '../../whatsapp';
 import { SendMessageOptions, SendMessageReturn } from '..';
 import { MessageButtonsOptions } from '.';
 export interface FileMessageOptions extends SendMessageOptions {
@@ -180,4 +181,4 @@ export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsO
  * @category Message
  * @return  {SendMessageReturn} The result
  */
-export declare function sendFileMessage(chatId: any, content: string | Blob | File, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions): Promise<SendMessageReturn>;
+export declare function sendFileMessage(chatId: string | Wid, content: string | Blob | File, options: AutoDetectMessageOptions | AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions | StickerMessageOptions): Promise<SendMessageReturn>;

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

@@ -1,5 +1,5 @@
 /*!
- * Copyright 2021 WPPConnect Team
+ * Copyright 2024 WPPConnect Team
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,15 +14,11 @@
  * limitations under the License.
  */
 import { SendMessageOptions, SendMessageReturn } from '..';
-export declare enum SCHEDULED_CALL_TYPE {
-    UNKNOWN = 0,
-    VOICE = 1,
-    VIDEO = 2
-}
 export interface ScheduledCallMessageOptions extends SendMessageOptions {
     scheduledTimestampMs: number | string;
-    callType: 'video' | 'voice' | SCHEDULED_CALL_TYPE;
+    callType: 'video' | 'voice';
     title: string;
+    description?: string;
 }
 /**
  * Send a scheduled call message
@@ -30,7 +26,8 @@ export interface ScheduledCallMessageOptions extends SendMessageOptions {
  * @example
  * ```javascript
  * WPP.chat.sendScheduledCallMessage('[number]@c.us', {
- *  title: "Title of event"
+ *  title: "Title of event call"
+ *  description: 'Description for Call",
  *  callType: 'voice'
  *  scheduledTimestampMs: 1696084222000
  * });

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

@@ -25,6 +25,7 @@ export type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & Li
  * });
  *
  * // With Buttons
+ * // Attention: The buttons are an alternative solution we found to make it work. There is no guarantee that they will continue functioning, or when they might stop: The only certainty is: They will stop, so use them responsibly.
  * WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
  *   useInteractiveMessage: true, // False for legacy
  *   buttons: [
@@ -41,7 +42,7 @@ export type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & Li
  *       text: 'Some text'
  *     },
  *     {
- *       id: 'another id 2',
+ *       code: '789890',
  *       text: 'Another text'
  *     }
  *   ],

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

@@ -0,0 +1,26 @@
+/*!
+ * Copyright 2022 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 { NoteModel, Wid } from '../../whatsapp';
+/**
+ * Set notes for a contact
+ * Only when are connected with business device
+ * @example
+ * ```javascript
+ * WPP.chat.setNotes('[number]@c.us', 'Text for your notes');
+ * ```
+ * @category Chat
+ */
+export declare function setNotes(chatId: string | Wid, content: string): Promise<NoteModel | null>;

package/dist/community/functions/getAnnouncementGroup.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2024 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 the default announcement group of a community
+ * You can pass any group id inside a community
+ *
+ * @example
+ * ```javascript
+ * WPP.community.getAnnouncementGroup('123456@g.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function getAnnouncementGroup(communityId: string | Wid): Wid | undefined;

package/dist/community/functions/getSubgroups.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2024 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 subgroups of a community
+ * You can pass id of group community, or id of a inside a grupo
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.getSubgroups('123456@g.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function getSubgroups(communityId: string | Wid): Wid[];

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

@@ -17,6 +17,8 @@ export { addSubgroups } from './addSubgroups';
 export { create } from './create';
 export { deactivate } from './deactivate';
 export { demoteParticipants } from './demoteParticipants';
+export { getAnnouncementGroup } from './getAnnouncementGroup';
 export { getParticipants } from './getParticipants';
+export { getSubgroups } from './getSubgroups';
 export { promoteParticipants } from './promoteParticipants';
 export { removeSubgroups } from './removeSubgroups';

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

@@ -22,6 +22,6 @@ import { Wid } from '../../whatsapp';
  * const url = await WPP.contact.getProfilePictureUrl('[number]@c.us');
  * ```
  *
- * @category Chat
+ * @category Contact
  */
 export declare function getProfilePictureUrl(contactId: string | Wid, full?: boolean): Promise<string | null | undefined>;

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

@@ -22,6 +22,6 @@ import { Wid } from '../../whatsapp';
  * await WPP.contact.getStatus('[number]@c.us');
  * ```
  *
- * @category Chat
+ * @category Contact
  */
 export declare function getStatus(contactId: string | Wid): Promise<string | null>;

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

@@ -20,3 +20,5 @@ export { getProfilePictureUrl } from './getProfilePictureUrl';
 export { getStatus } from './getStatus';
 export { ContactListOptions, list } from './list';
 export { queryExists } from './queryExists';
+export { subscribePresence } from './subscribePresence';
+export { unsubscribePresence } from './unsubscribePresence';

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

@@ -43,6 +43,6 @@ export interface QueryExistsResult {
  * console.log(result.wid); // Correct ID
  * ```
  *
- * @category Chat
+ * @category Contact
  */
 export declare function queryExists(contactId: string | Wid): Promise<QueryExistsResult | null>;

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

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2024 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';
+/**
+ * Subscribe presente from a contact
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.subscribePresence('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function subscribePresence(ids: string | string[]): Promise<Wid[]>;

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

@@ -0,0 +1,27 @@
+/*!
+ * Copyright 2024 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';
+/**
+ * Unsubscribe presence of a contact
+ *
+ * @example
+ * ```javascript
+ * await WPP.contact.unsubscribePresence('[number]@c.us');
+ * ```
+ *
+ * @category Contact
+ */
+export declare function unsubscribePresence(ids: string | string[]): Promise<Wid[]>;