talkyzap-wapp-api 1.0.0

package/dist/group/events/eventTypes.d.ts

@@ -0,0 +1,53 @@
+/*!
+ * 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 interface GroupEventTypes {
+    /**
+     * Triggered when some member of group has changed
+     *
+     * @example
+     * ```javascript
+     * WPP.on('group.participant_changed', (event) => {
+     *   // Your code
+     * });
+     * ```
+     */
+    'group.participant_changed': {
+        /**
+         * Author of action for add, remove, demote and promote members
+         */
+        author?: string;
+        /**
+         * Author name of action for add, remove, demote and promote members
+         */
+        authorPushName?: string;
+        /**
+         * The group id
+         */
+        groupId: string;
+        /**
+         * The action by member
+         */
+        action: 'add' | 'remove' | 'demote' | 'promote' | 'leaver' | 'join';
+        /**
+         * The operation in group
+         */
+        operation: 'add' | 'remove' | 'demote' | 'promote';
+        /**
+         * List of members
+         */
+        participants: string[];
+    };
+}

package/dist/group/events/index.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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 './registerParticipantsChangedEvent';

package/dist/group/events/registerParticipantsChangedEvent.d.ts

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

package/dist/group/functions/addParticipants.d.ts

@@ -0,0 +1,59 @@
+/*!
+ * 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';
+declare global {
+    interface Window {
+        Debug: {
+            VERSION: string;
+        };
+    }
+}
+/**
+ * Add one or more participants to a group
+ *
+ * The method return a object with the result of each participant as the key
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.addParticipants('[group@g.us]', [number@c.us]);
+ *
+ * // Get participant result:
+ * console.log(result['123@c.us'].code);
+ * console.log(result['123@c.us'].invite_code);
+ * console.log(result['123@c.us'].invite_code_exp);
+ * console.log(result['123@c.us'].message);
+ * console.log(result['123@c.us'].wid);
+ *
+ * const memberResult = result['123@c.us']; // To a variable
+ * // or
+ * const memberResult = Object.values(result)[0]; // Always the first member result
+ *
+ * // How to send a custom invite link
+ * const link = 'https://chat.whatsapp.com/' + result['123@c.us'].invite_code;
+ * console.log(link);
+ * ```
+ *
+ * @category Group
+ */
+export declare function addParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<{
+    [key: `${number}@c.us`]: {
+        wid: string;
+        code: number;
+        message: string;
+        invite_code: string | null;
+        invite_code_exp: number | null;
+    };
+}>;

package/dist/group/functions/approve.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 { Wid } from '../../whatsapp';
+/**
+ * Approve a membership request to group
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.approve(12345645@g.us, 5554999999999@c.us);
+ * ```
+ *
+ * @category Group
+ */
+export declare function approve(groupId: string | Wid, membershipIds: (string | Wid) | (string | Wid)[]): Promise<{
+    error: any;
+    wid: Wid;
+}[]>;

package/dist/group/functions/canAdd.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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';
+/**
+ * Check if your account is allowed to add new participants
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.canAdd('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
+export declare function canAdd(groupId: string | Wid): Promise<boolean>;

package/dist/group/functions/canDemote.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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';
+/**
+ * Check if your account is allowed to demote participants
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.canDemote('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
+export declare function canDemote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/canPromote.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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';
+/**
+ * Check if your account is allowed to promote participants
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.canPromote('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
+export declare function canPromote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/canRemove.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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';
+/**
+ * Check if your account is allowed to remove participants
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.canRemove('group@g.us');
+ * console.log(result);
+ * ```
+ *
+ * @category Group
+ */
+export declare function canRemove(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<boolean>;

package/dist/group/functions/create.d.ts

@@ -0,0 +1,59 @@
+/*!
+ * 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';
+/**
+ * Create a new group
+ *
+ * The method return a object with the result of each participant as the key
+ *
+ * @example
+ * ```javascript
+ * const result = await WPP.group.create('Test Group', ['number@c.us']);
+ *
+ * console.log(result.gid.toString()); // Get the group ID
+ *
+ * // Get participant result:
+ * console.log(result['number@c.us'].code);
+ * console.log(result['number@c.us'].invite_code);
+ * console.log(result['number@c.us'].invite_code_exp);
+ * console.log(result['number@c.us'].message);
+ * console.log(result['number@c.us'].wid);
+ *
+ * const memberResult = result['number@c.us']; // To a variable
+ * // or
+ * const memberResult = Object.values(result)[0]; // Always the first member result
+ *
+ * // How to send a custom invite link
+ * const link = 'https://chat.whatsapp.com/' + result['number@c.us'].invite_code;
+ * console.log(link);
+ *
+ * // Create a Subgroup for a community
+ * const result = await WPP.group.create('Test Group', ['number@c.us'], 'communit@g.us');
+ * ```
+ *
+ * @category Group
+ */
+export declare function create(groupName: string, participantsIds: (string | Wid) | (string | Wid)[], parentGroup: string | Wid): Promise<{
+    gid: Wid;
+    participants: {
+        [key: `${number}@c.us`]: {
+            wid: string;
+            code: number;
+            invite_code: string | null;
+            invite_code_exp: number | null;
+        };
+    };
+}>;

package/dist/group/functions/demoteParticipants.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * 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';
+/**
+ * Remove admin of a group
+ *
+ * @example
+ * ```javascript
+ * // One member
+ * await WPP.group.demoteParticipants('123456@g.us', '123456@c.us');
+ *
+ * // More than one member
+ * await WPP.group.demoteParticipants('123456@g.us', ['123456@c.us','123456@c.us']);
+ * ```
+ */
+export declare function demoteParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;

package/dist/group/functions/ensureGroup.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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';
+export declare function ensureGroup(groupId: string | Wid, checkIsAdmin?: boolean): Promise<import("../../whatsapp").ChatModel>;

package/dist/group/functions/ensureGroupAndParticipants.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 { ParticipantModel, Wid } from '../../whatsapp';
+export declare function ensureGroupAndParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[], createIfNotExists?: boolean): Promise<{
+    groupChat: import("../../whatsapp").ChatModel;
+    participants: ParticipantModel[];
+}>;

package/dist/group/functions/getAllGroups.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.
+ */
+/**
+ * Get all groups
+ *
+ * @example
+ * ```javascript
+ * WPP.group.getAllGroups();
+ * ```
+ *
+ * @category Group
+ */
+export declare function getAllGroups(): Promise<(import("../../whatsapp").ChatModel | undefined)[]>;

package/dist/group/functions/getGroupInfoFromInviteCode.d.ts

@@ -0,0 +1,51 @@
+/*!
+ * 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.
+ */
+/**
+ * Get group info from an inviteCode
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.getGroupInfoFromInviteCode('<inviteCode>');
+ * ```
+ *
+ * @category Group
+ */
+export declare function getGroupInfoFromInviteCode(inviteCode: string): Promise<{
+    descOwner: string | undefined;
+    id: string;
+    owner: string | undefined;
+    participants: {
+        id: string;
+        isAdmin: boolean;
+        isSuperAdmin: boolean;
+    }[];
+    subjectOwner: string | undefined;
+    announce: boolean;
+    creation: number;
+    desc: string;
+    descId: string;
+    descTime: number;
+    noFrequentlyForwarded: boolean;
+    parent: boolean;
+    pvId?: string | undefined;
+    restrict: boolean;
+    size: number;
+    status: number;
+    subject: string;
+    subjectTime: number;
+    support: boolean;
+    suspended: boolean;
+}>;

package/dist/group/functions/getGroupSizeLimit.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.
+ */
+/**
+ * Get the max number of participants for a group
+ *
+ * @example
+ * ```javascript
+ * const limit = await WPP.group.getGroupSizeLimit();
+ * console.log(limit);
+ * ```
+ *
+ * @category Group
+ */
+export declare function getGroupSizeLimit(): Promise<number>;

package/dist/group/functions/getInviteCode.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * 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';
+/**
+ * Get the currend invite code of the group
+ *
+ * @example
+ * ```javascript
+ * const code = WPP.group.getInviteCode('[group-id]@g.us');
+ * const link = 'https://chat.whatsapp.com/' + code;
+ * ```
+ *
+ * @category Group
+ */
+export declare function getInviteCode(groupId: string | Wid): Promise<string>;

package/dist/group/functions/getMembershipRequests.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';
+/**
+ * Retrieve a lista of a membership approval requests
+ *
+ * @example
+ * ```javascript
+ * await WPP.group.getMembershipRequests(12345645@g.us);
+ * ```
+ *
+ * @category Group
+ */
+export declare function getMembershipRequests(groupId: string | Wid): Promise<{
+    addedBy: Wid;
+    id: Wid;
+    parentGroupId?: Wid;
+    requestMethod: 'InviteLink' | 'LinkedGroupJoin' | 'NonAdminAdd';
+    t: number;
+}[]>;

package/dist/group/functions/getParticipants.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';
+/**
+ * Get an array of participants of a group
+ *
+ * @example
+ * ```javascript
+ * WPP.group.getParticipants('[group-id]@g.us');
+ * ```
+ *
+ * @category Group
+ */
+export declare function getParticipants(groupId: string | Wid): Promise<import("../../whatsapp").ParticipantModel[]>;

package/dist/group/functions/iAmAdmin.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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';
+export declare function iAmAdmin(groupId: string | Wid): Promise<boolean>;

package/dist/group/functions/iAmMember.d.ts

@@ -0,0 +1,17 @@
+/*!
+ * 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';
+export declare function iAmMember(groupId: string | Wid): Promise<boolean>;