@open-wa/wa-automate-types-only 4.55.2 → 4.57.0

package/dist/api/Client.d.ts

@@ -4,7 +4,7 @@ import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatC
 import { Contact, NumberCheck } from './model/contact';
 import { Message, MessageInfo, PollData } from './model/message';
 import { AxiosRequestConfig } from 'axios';
-import { NewCommunityGroup, ParticipantChangedEventModel, GenericGroupChangeEvent } from './model/group-metadata';
+import { NewCommunityGroup, ParticipantChangedEventModel, GenericGroupChangeEvent, GroupMetadata } from './model/group-metadata';
 import { ConfigObject, STATE, LicenseType, Webhook, EventPayload } from './model';
 import PQueue, { DefaultAddOptions, Options } from 'p-queue';
 import { HealthCheck, SessionInfo } from './model/sessionInfo';
@@ -98,6 +98,10 @@ export declare class Client {
      * @returns SessionInfo
      */
     getSessionInfo(): SessionInfo;
+    /**
+     * Easily resize page on the fly. Useful if you're showing screenshots in a web-app.
+     */
+    resizePage(width?: number, height?: number): Promise<boolean>;
     /**
      * Get the config which was used to set up the client. Sensitive details (like devTools username and password, and browserWSEndpoint) are scrubbed
      *
@@ -766,8 +770,10 @@ export declare class Client {
      * @param to chat id - a group chat is required
      * @param name the name of the poll
      * @param options an array of poll options
+     * @param quotedMsgId A message to quote when sending the poll
+     * @param allowMultiSelect Whether or not to allow multiple selections. default false
      */
-    sendPoll(to: GroupChatId, name: string, options: string[]): Promise<MessageId>;
+    sendPoll(to: GroupChatId, name: string, options: string[], quotedMsgId?: MessageId, allowMultiSelect?: boolean): Promise<MessageId>;
     /**
      * Sends a video to given chat as a gif, with caption or not, using base64
      * @param to chat id `xxxxx@c.us`
@@ -808,9 +814,12 @@ export declare class Client {
     getFeatures(): Promise<any>;
     /**
      * Returns a PNG DataURL screenshot of the session
+     * @param chatId Chat ID to open before taking a snapshot
+     * @param width Width of the viewport for the snapshot. Height also required if you want to resize.
+     * @param height Height of the viewport for the snapshot. Width also required if you want to resize.
      * @returns `Promise<DataURL>`
      */
-    getSnapshot(chatId?: ChatId): Promise<DataURL>;
+    getSnapshot(chatId?: ChatId, width?: number, height?: number): Promise<DataURL>;
     /**
      * Returns some metrics of the session/page.
      * @returns `Promise<any>`
@@ -1033,6 +1042,11 @@ export declare class Client {
      * @returns array of groups
      */
     getAllGroups(withNewMessagesOnly?: boolean): Promise<Chat[]>;
+    /**
+     * Retrieve all commmunity Ids
+     * @returns array of group ids
+     */
+    getAllCommunities(): Promise<GroupId[]>;
     /**
      * Retrieves group members as [Id] objects
      * @param groupId group id
@@ -1043,6 +1057,56 @@ export declare class Client {
      * @param groupId group id
      */
     getGroupInfo(groupId: GroupChatId): Promise<any>;
+    /**
+     * Returns the community metadata. Like group metadata but with a `subGroups` property which is the group metadata of the community subgroups.
+     * @param communityId community id
+     */
+    getCommunityInfo(communityId: GroupChatId): Promise<GroupMetadata & {
+        subGroups: GroupMetadata[];
+    }>;
+    /**
+     *
+     * Accepts a request from a recipient to join a group. Takes the message ID of the request message.
+     *
+     * @param {string} messageId
+     */
+    acceptGroupJoinRequest(messageId: MessageId): Promise<boolean>;
+    /**
+     * Retrieves community members Ids
+     * @param communityId community id
+     */
+    getCommunityParticipantIds(communityId: GroupChatId): Promise<{
+        id: GroupChatId;
+        participants: ContactId[];
+        subgroup: boolean;
+    }[]>;
+    /**
+     * Retrieves community admin Ids
+     * @param communityId community id
+     */
+    getCommunityAdminIds(communityId: GroupChatId): Promise<{
+        id: GroupChatId;
+        admins: ContactId[];
+        subgroup: boolean;
+    }[]>;
+    /**
+     * Retrieves community members as Contact objects
+     * @param communityId community id
+     */
+    getCommunityParticipants(communityId: GroupChatId): Promise<{
+        id: GroupChatId;
+        participants: Contact[];
+        subgroup: boolean;
+    }[]>;
+    /**
+     * Retrieves community admins as Contact objects
+     * @param communityId community id
+     */
+    getCommunityAdmins(communityId: GroupChatId): Promise<{
+        id: GroupChatId;
+        admins: Contact[];
+        subgroup: boolean;
+    }[]>;
     /** Joins a group via the invite link, code, or message
      * @param link This param is the string which includes the invite link or code. The following work:
      * - Follow this link to join my WA group: https://chat.whatsapp.com/DHTGJUfFJAV9MxOpZO1fBZ
@@ -1708,6 +1772,14 @@ export declare class Client {
      */
     sendGiphyAsSticker(to: ChatId, giphyMediaUrl: URL | string): Promise<MessageId | string | boolean>;
     /**
+     * @deprecated
+     *
+     * :::danger
+     *
+     * Status features are broken for now. Please join our discord community for updates.
+     *
+     * :::
+     *
      * [REQUIRES A TEXT STORY LICENSE-KEY](https://gum.co/open-wa)
      *
      * Sends a formatted text story.
@@ -1725,6 +1797,14 @@ export declare class Client {
      */
     postTextStatus(text: Content, textRgba: string, backgroundRgba: string, font: number): Promise<MessageId | string | boolean>;
     /**
+     * @deprecated
+     *
+     * :::danger
+     *
+     * Status features are broken for now. Please join our discord community for updates.
+     *
+     * :::
+     *
      * [REQUIRES AN IMAGE STORY LICENSE-KEY](https://gum.co/open-wa)
      *
      * Posts an image story.
@@ -1734,6 +1814,14 @@ export declare class Client {
      */
     postImageStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
     /**
+     * @deprecated
+     *
+     * :::danger
+     *
+     * Status features are broken for now. Please join our discord community for updates.
+     *
+     * :::
+     *
      * [REQUIRES A VIDEO STORY LICENSE-KEY](https://gum.co/open-wa)
      *
      * Posts a video story.

package/dist/api/model/message.d.ts

@@ -1,4 +1,4 @@
-import { ChatId, ContactId, MessageId } from "./aliases";
+import { ChatId, ContactId, MessageId, GroupChatId } from "./aliases";
 import { Button, Row, Section } from "./button";
 import { Chat } from "./chat";
 import { Contact } from "./contact";
@@ -156,7 +156,7 @@ export interface Message {
      *
      * If this is `true` then you need to determine within your own code whether or not to accept the user to the group which is indicated with `quotedRemoteJid` using `addParticipant`.
      */
-    isGroupJoinRequest?: boolean;
+    isGroupJoinRequest?: GroupChatId;
     /**
      * The ID of the message sender
      */
@@ -168,7 +168,7 @@ export interface Message {
     /**
      * The parent group ID (community ID - communities are just groups made up of other groups) of the group represented by `quotedRemoteJid`
      */
-    quotedParentGroupJid?: string;
+    quotedParentGroupJid?: GroupChatId;
     mediaData: unknown;
     shareDuration: number;
     isAnimated: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.55.2",
+    "version": "4.57.0",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",