talkyzap-wapp-api 1.0.0

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

@@ -0,0 +1,22 @@
+/*!
+ * 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 { RawMessage, SendMessageOptions, SendMessageReturn } from '..';
+/**
+ * Send a raw message
+ *
+ * @category Message
+ */
+export declare function sendRawMessage(chatId: any, rawMessage: RawMessage, options?: SendMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,36 @@
+/*!
+ * 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 { Stringable } from '../../types';
+import { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Send a reaction to a message
+ *
+ * Full Emoji List: https://unicode.org/emoji/charts/full-emoji-list.html
+ *
+ * @example
+ * ```javascript
+ * // to react a message
+ * WPP.chat.sendReactionToMessage('[message_id]', '🤯');
+ *
+ * // to remove
+ * WPP.chat.sendReactionToMessage('[message_id]', false);
+ *
+ * ```
+ * @category Message
+ */
+export declare function sendReactionToMessage(messageId: string | MsgKey | MsgModel | Stringable, reaction: string | false | null): Promise<{
+    sendMsgResult: string;
+}>;

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

@@ -0,0 +1,40 @@
+/*!
+ * 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 { 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;
+    title: string;
+}
+/**
+ * Send a scheduled call message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendScheduledCallMessage('[number]@c.us', {
+ *  title: "Title of event"
+ *  callType: 'voice'
+ *  scheduledTimestampMs: 1696084222000
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendScheduledCallMessage(chatId: any, options: ScheduledCallMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,54 @@
+/*!
+ * 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 { LinkPreviewOptions, MessageButtonsOptions, SendMessageOptions, SendMessageReturn } from '..';
+export type TextMessageOptions = SendMessageOptions & MessageButtonsOptions & LinkPreviewOptions;
+/**
+ * Send a text message
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
+ *   createChat: true
+ * });
+ *
+ * // With Buttons
+ * WPP.chat.sendTextMessage('[number]@c.us', 'Hello', {
+ *   useTemplateButtons: true, // False for legacy
+ *   buttons: [
+ *     {
+ *       url: 'https://wppconnect.io/',
+ *       text: 'WPPConnect Site'
+ *     },
+ *     {
+ *       phoneNumber: '+55 11 22334455',
+ *       text: 'Call me'
+ *     },
+ *     {
+ *       id: 'your custom id 1',
+ *       text: 'Some text'
+ *     },
+ *     {
+ *       id: 'another id 2',
+ *       text: 'Another text'
+ *     }
+ *   ],
+ *   title: 'Title text', // Optional
+ *   footer: 'Footer text' // Optional
+ * });
+ * ```
+ * @category Message
+ */
+export declare function sendTextMessage(chatId: any, content: any, options?: TextMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,47 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { SendMessageOptions, SendMessageReturn } from '..';
+export interface VCardContact {
+    id: string | Wid;
+    name: string;
+}
+/**
+ * Send a VCard as message
+ * @example
+ * ```javascript
+ * // single contact
+ * WPP.chat.sendVCardContactMessage('[number]@c.us', {
+ *   id: '123456@c.us',
+ *   name: 'The Contact Name'
+ * });
+ *
+ * // multiple contacts
+ * WPP.chat.sendVCardContactMessage('[number]@c.us', [
+ *   {
+ *     id: '123456@c.us',
+ *     name: 'The Contact Name'
+ *   },
+ *   {
+ *     id: '456789@c.us',
+ *     name: 'Another Contact'
+ *   },
+ * ]);
+ *
+ * ```
+ * @category Message
+ */
+export declare function sendVCardContactMessage(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;

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

@@ -0,0 +1,47 @@
+/*!
+ * 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.
+ */
+export interface StarMessageReturn {
+    id: string;
+    star: boolean;
+}
+/**
+ * Star/Unstar a message
+ *
+ * @example
+ * ```javascript
+ * // star a message
+ * WPP.chat.starMessage('<message id>');
+ *
+ * // unstar a message
+ * WPP.chat.starMessage('<message id>', false);
+ * ```
+ * @category Message
+ */
+export declare function starMessage(id: string, star: boolean): Promise<StarMessageReturn>;
+/**
+ * Star/Unstar messages
+ *
+ * @example
+ * ```javascript
+ * // star messages
+ * WPP.chat.starMessage(['<message id>', '<message id>']);
+ *
+ * // unstar messages
+ * WPP.chat.starMessage(['<message id>', '<message id>'], false);
+ * ```
+ * @category Message
+ */
+export declare function starMessage(ids: string[], star: boolean): Promise<StarMessageReturn[]>;

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

@@ -0,0 +1,27 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Unmute a chat
+ *
+ * @example
+ * ```javascript
+ * WPP.chat.unmute('[number]@c.us');
+ * ```
+ *
+ * @category Chat
+ */
+export declare function unmute(chatId: string | Wid): Promise<void>;

package/dist/chat/index.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 './events';
+import './patch';
+export * from './defaultSendMessageOptions';
+export * from './functions';
+export * from './types';

package/dist/chat/patch.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/types.d.ts

@@ -0,0 +1,116 @@
+/*!
+ * 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 { ModelPropertiesContructor, MsgKey, MsgModel, Wid } from '../whatsapp';
+import { SendMsgResult } from '../whatsapp/enums';
+export interface SendMessageOptions {
+    /**
+     * Create a new chat to a new contact
+     *
+     * @default false
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Hello new contact', {
+     *   createChat: true
+     * });
+     * ```
+     */
+    createChat?: boolean;
+    /**
+     * Automatic detect and add the mentioned contacts with @[number]
+     *
+     * @default true
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
+     *   detectMentioned: true
+     * });
+     * ```
+     */
+    detectMentioned?: boolean;
+    /**
+     * Automatically mark chat is read after send a message
+     *
+     * @default true
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Replying your message', {
+     *   markIsRead: true
+     * });
+     * ```
+     */
+    markIsRead?: boolean;
+    /**
+     *
+     */
+    messageId?: string | MsgKey;
+    /**
+     * Define a mentioned list for a message
+     * This option work better with a message with mension
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Hello @123 and @456', {
+     *   mentionedList: ['123@c.us', '456@c.us']
+     * })
+     * ```
+     */
+    mentionedList?: (string | Wid)[];
+    /**
+     * Quote a message, like a reply message
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'This is a reply', {
+     *   quotedMsg: 'true_[number]@c.us_3EB0F435D95D32C4C638'
+     * })
+     * ```
+     */
+    quotedMsg?: string | MsgKey | MsgModel;
+    /**
+     * Wait for send while the ACK of message is SENT(1)
+     *
+     * @default true
+     *
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Wait for sent', {
+     *   waitForAck: true
+     * })
+     * ```
+     */
+    waitForAck?: boolean;
+    /**
+     * Delay some time (in ms) before sending message
+     * While delaying, Typing Status is used to look like a human interaction
+     * @default 0
+     * @example
+     * ```javascript
+     * WPP.chat.sendTextMessage('[number]@c.us', 'Delay with typing', {
+     *   delay: 4000
+     * })
+     * ```
+     */
+    delay?: number;
+}
+export interface SendMessageReturn {
+    id: string;
+    ack: number;
+    sendMsgResult: Promise<SendMsgResult>;
+}
+export type RawMessage = ModelPropertiesContructor<MsgModel>;

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

@@ -0,0 +1,33 @@
+/*!
+ * 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';
+/**
+ * Add groups do community
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.addSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
+ * ```
+ *
+ * @category Community
+ */
+export declare function addSubgroups(parentGroupId: string | Wid, subgroupIds: (string | Wid) | (string | Wid)[]): Promise<{
+    failedGroups: {
+        error: string;
+        jid: string;
+    }[];
+    linkedGroupJids: string[];
+}>;

package/dist/community/functions/create.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';
+/**
+ * Create a community
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.create('Name for community', 'description for community', ['123456@g.us', '123456@g.us']);
+ * ```
+ *
+ * @category Community
+ */
+export declare function create(name: string, desc: string, subGroupsIds: (string | Wid) | (string | Wid)[]): Promise<any>;

package/dist/community/functions/deactivate.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';
+/**
+ * Deactivated a community
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.deactivate('123456@g.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function deactivate(communityId: string | Wid): Promise<any>;

package/dist/community/functions/demoteParticipants.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';
+/**
+ * Remove admin of community participant
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.demoteParticipants('123456@g.us', '123456@c.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function demoteParticipants(communityId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<any>;

package/dist/community/functions/getParticipants.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 participants of a community
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.getParticipants('123456@g.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function getParticipants(communityId: string | Wid): Promise<any>;

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

@@ -0,0 +1,22 @@
+/*!
+ * 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.
+ */
+export { addSubgroups } from './addSubgroups';
+export { create } from './create';
+export { deactivate } from './deactivate';
+export { demoteParticipants } from './demoteParticipants';
+export { getParticipants } from './getParticipants';
+export { promoteParticipants } from './promoteParticipants';
+export { removeSubgroups } from './removeSubgroups';

package/dist/community/functions/promoteParticipants.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';
+/**
+ * Promote participant of community to admin
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.promoteParticipants('123456@g.us', '123456@c.us');
+ * ```
+ *
+ * @category Community
+ */
+export declare function promoteParticipants(communityId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<any>;

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

@@ -0,0 +1,33 @@
+/*!
+ * 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';
+/**
+ * Remove groups from community
+ *
+ * @example
+ * ```javascript
+ * await WPP.community.sendUnlinkSubgroups('123456@g.us', ['123456@g.us', '123456@g.us']);
+ * ```
+ *
+ * @category Community
+ */
+export declare function removeSubgroups(parentGroupId: string | Wid, subgroupIds: (string | Wid) | (string | Wid)[]): Promise<{
+    failedGroups: {
+        error: string;
+        jid: string;
+    }[];
+    linkedGroupJids: string[];
+}>;