@open-wa/wa-automate-types-only 4.58.0 → 4.61.0

package/dist/api/Client.d.ts

@@ -328,6 +328,14 @@ export declare class Client {
      * @returns `true` if the callback was registered
      */
     onGlobalParticipantsChanged(fn: (participantChangedEvent: ParticipantChangedEventModel) => void): Promise<Listener | boolean>;
+    /**
+     * Listents to group approval requests. Emits a message object. Use it with `message.isGroupApprovalRequest()` to check if it is a group approval request.
+     *
+     * @event
+     * @param fn callback function that handles a [[Message]] as the first and only parameter.
+     * @returns `true` if the callback was registered
+     */
+    onGroupApprovalRequest(fn: (groupApprovalRequestMessage: Message) => void): Promise<Listener | boolean>;
     /**
      * Listens to all group (gp2) events. This can be useful if you want to catch when a group title, subject or picture is changed.
      *
@@ -517,6 +525,15 @@ export declare class Client {
      */
     forceUpdateLiveLocation(chatId: ChatId): Promise<LiveLocationChangedEvent[] | boolean>;
     /**
+     *
+     * @deprecated
+     *
+     * :::danger
+     *
+     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
+     *
+     * :::
+     *
      * Test the button commands on MD accounts with an insiders key. This is a temporary feature to help fix issue #2658
      */
     testButtons(chatId: ChatId): Promise<any>;
@@ -570,7 +587,14 @@ export declare class Client {
      */
     sendPaymentRequest(to: ChatId, amount: number, currency: string, message?: string): Promise<boolean | MessageId>;
     /**
-     * {@license:insiders@}
+     *
+     * @deprecated
+     *
+     * :::danger
+     *
+     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
+     *
+     * :::
      *
      * Send generic quick reply buttons. This is an insiders feature for MD accounts.
      *
@@ -582,16 +606,17 @@ export declare class Client {
      */
     sendButtons(to: ChatId, body: string | LocationButtonBody, buttons: Button[], title?: string, footer?: string): Promise<boolean | MessageId>;
     /**
-     * {@license:insiders@}
      *
-     * Send advanced buttons with media body. This is an insiders feature for MD accounts.
+     * @deprecated
      *
-     * :::caution
+     * :::danger
      *
-     *  Button messages are being progressively handicapped by recipient mobile devices. Some recipients may not see some types of button messages even though their devices will receive them.
+     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
      *
      * :::
      *
+     * Send advanced buttons with media body. This is an insiders feature for MD accounts.
+     *
      * Body can be location, image, video or document. Buttons can be quick reply, url or call buttons.
      *
      * @param  {ChatId} to chat id
@@ -612,7 +637,14 @@ export declare class Client {
      */
     sendBanner(to: ChatId, base64: Base64): Promise<boolean | MessageId>;
     /**
-     * {@license:insiders@}
+     * @deprecated
+     *
+     *
+     * :::danger
+     *
+     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
+     *
+     * :::
      *
      * Send a list message. This will not work when being sent from business accounts!
      *
@@ -1391,6 +1423,12 @@ export declare class Client {
      *
      * {@license:insiders@}
      *
+     * :::danger
+     *
+     * Buttons are broken for the foreseeable future. Please DO NOT get a license solely for access to buttons. They are no longer reliable due to recent changes at WA.
+     *
+     * :::
+     *
      * Use a raw payload within your open-wa session
      *
      * @param chatId
@@ -1443,6 +1481,26 @@ export declare class Client {
      * @returns `Promise<boolean>`
      */
     revokeGroupInviteLink(chatId: ChatId): Promise<boolean | string>;
+    /**
+     * Gets the contact IDs of members requesting approval to join the group
+     * @param groupChatId
+     * @returns `Promise<ContactId[]>`
+     */
+    getGroupApprovalRequests(groupChatId: GroupChatId): Promise<ContactId[]>;
+    /**
+      * Approves a group join request
+     * @param groupChatId The group chat id
+     * @param contactId The contact id of the person who is requesting to join the group
+     * @returns `Promise<boolean>`
+     */
+    approveGroupJoinRequest(groupChatId: GroupChatId, contactId: ContactId): Promise<boolean | string>;
+    /**
+    * Rejects a group join request
+     * @param groupChatId The group chat id
+     * @param contactId The contact id of the person who is requesting to join the group
+     * @returns `Promise<boolean>`
+     */
+    rejectGroupJoinRequest(groupChatId: GroupChatId, contactId: ContactId): Promise<boolean | string>;
     /**
      * Deletes message of given message id
      * @param chatId The chat id from which to delete the message.
@@ -1622,6 +1680,14 @@ export declare class Client {
     * @returns boolean true if action completed successfully.
     */
     setGroupEditToAdminsOnly(groupId: GroupChatId, onlyAdmins: boolean): Promise<boolean>;
+    /**
+     *
+    * Turn on or off the approval requirement for new members to join a group
+    * @param groupId '0000000000-00000000@g.us' the group id.
+    * @param requireApproval set to true to turn on the approval requirement, false to turn off
+    * @returns boolean true if action completed successfully.
+    */
+    setGroupApprovalMode(groupId: GroupChatId, requireApproval: boolean): Promise<boolean>;
     /**
     * Change the group chant description
     * @param groupId '0000000000-00000000@g.us' the group id.

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

@@ -84,6 +84,10 @@ export interface BaseChat {
      * @deprecated This is unreliable. Use the method [`getLastSeen`](https://open-wa.github.io/wa-automate-nodejs/classes/client.html#getlastseen) instead.
      */
     lastSeen?: any;
+    /**
+     * URL of the chat picture if available
+     */
+    pic?: string;
 }
 export interface SingleChat extends BaseChat {
     /**

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

@@ -46,6 +46,10 @@ export declare enum SimpleListener {
      * Represents [[onGlobalParticipantsChanged]]
      */
     GlobalParticipantsChanged = "onGlobalParticipantsChanged",
+    /**
+     * Represents [[onGroupApprovalRequest]]
+     */
+    GroupApprovalRequest = "onGroupApprovalRequest",
     /**
      * Represents [[onChatState]]
      */

package/dist/utils/tools.d.ts

@@ -142,3 +142,11 @@ export declare const pathExists: (_path: string, failSilent?: boolean) => Promis
  * @returns string
  */
 export declare const fixPath: (_path: string) => string;
+/**
+ *
+ * Accented filenames break file sending in docker containers. This is used to replace accented chars in strings to prevent file sending failures.
+ *
+ * @param input The raw string
+ * @returns A sanitized string with all accented chars removed
+ */
+export declare const sanitizeAccentedChars: (input: string) => string;

package/package.json

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