@open-wa/wa-automate-types-only 4.44.9 → 4.45.0

package/dist/api/Client.d.ts

@@ -8,7 +8,7 @@ import { ParticipantChangedEventModel } 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';
-import { ChatId, GroupChatId, Content, Base64, MessageId, ContactId, DataURL, FilePath } from './model/aliases';
+import { ChatId, GroupChatId, Content, Base64, MessageId, ContactId, DataURL, AdvancedFile } from './model/aliases';
 import { CustomProduct, Order, Product } from './model/product';
 import { Label } from './model/label';
 import { Mp4StickerConversionProcessOptions, StickerMetadata } from './model/media';
@@ -637,7 +637,7 @@ export declare class Client {
      * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
      * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
-    sendImage(to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
+    sendImage(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
     /**
      * Automatically sends a youtube link with the auto generated link preview. You can also add a custom message.
      * @param chatId
@@ -696,7 +696,7 @@ export declare class Client {
      * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
      * @returns `Promise <boolean | MessageId>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
-    sendFile(to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
+    sendFile(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
     /**
      * {@license:insiders@}
      *
@@ -712,14 +712,14 @@ export declare class Client {
      * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
      * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
-    sendPtt(to: ChatId, file: DataURL | FilePath, quotedMsgId: MessageId): Promise<MessageId>;
+    sendPtt(to: ChatId, file: AdvancedFile, quotedMsgId: MessageId): Promise<MessageId>;
     /**
      * Send an audio file with the default audio player (not PTT/voice message)
      * @param to chat id `xxxxx@c.us`
      * @param base64 base64 data:image/xxx;base64,xxx or the path of the file you want to send.
      * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
      */
-    sendAudio(to: ChatId, file: DataURL | FilePath, quotedMsgId?: MessageId): Promise<MessageId>;
+    sendAudio(to: ChatId, file: AdvancedFile, quotedMsgId?: MessageId): Promise<MessageId>;
     /**
      * Sends a video to given chat as a gif, with caption or not, using base64
      * @param to chat id `xxxxx@c.us`
@@ -729,7 +729,7 @@ export declare class Client {
      * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
      * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
      */
-    sendVideoAsGif(to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig?: AxiosRequestConfig): Promise<MessageId>;
+    sendVideoAsGif(to: ChatId, file: AdvancedFile, filename: string, caption: Content, quotedMsgId?: MessageId, requestConfig?: AxiosRequestConfig): Promise<MessageId>;
     /**
      * Sends a video to given chat as a gif by using a giphy link, with caption or not, using base64
      * @param to chat id `xxxxx@c.us`

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

@@ -95,4 +95,12 @@ export declare type Base64 = Brand<string, "Base64">;
  * Learn more here: https://www.w3schools.com/html/html_filepaths.asp
  */
 export declare type FilePath = Brand<string, "FilePath">;
+/**
+ * A URL of a file used with a GET request
+ */
+export declare type GetURL = Brand<string, "GetURL">;
+/**
+ * Some file based actions in open-wa are powerful enough to take a dataurl, url or filepath
+ */
+export declare type AdvancedFile = DataURL | FilePath | GetURL;
 export {};

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

@@ -8,9 +8,25 @@ export interface Message {
      */
     selectedButtonId: string;
     /**
-     * The id of the message
+     * The id of the message. Consists of the Chat ID and a unique string.
+     *
+     * Example:
+     *
+     * ```
+     * false_447123456789@c.us_7D914FEA78BE10277743F4B785045C37
+     * ```
      */
     id: MessageId;
+    /**
+     * The unique segment of the message id.
+     *
+     * Example:
+     *
+     * ```
+     * 7D914FEA78BE10277743F4B785045C37
+     * ```
+     */
+    mId: string;
     /**
      * The body of the message. If the message type is `chat` , `body` will be the text of the chat. If the message type is some sort of media, then this body will be the thumbnail of the media.
      */

package/dist/cli/integrations/chatwoot.d.ts

@@ -1,6 +1,7 @@
 import { Client } from '../..';
 import { cliFlags } from '../server';
 import { Request, Response } from "express";
+export declare const chatwoot_webhook_check_event_name = "cli.integrations.chatwoot.check";
 export declare type expressMiddleware = (req: Request, res: Response) => Promise<Response<any, Record<string, any>>>;
 export declare const chatwootMiddleware: (cliConfig: cliFlags, client: Client) => expressMiddleware;
 export declare const setupChatwootOutgoingMessageHandler: (cliConfig: cliFlags, client: Client) => Promise<void>;

package/package.json

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