@open-wa/wa-automate-types-only 4.38.1 → 4.40.1

package/dist/api/Client.d.ts

@@ -19,7 +19,7 @@ import { Listener } from 'eventemitter2';
 import PriorityQueue from 'p-queue/dist/priority-queue';
 import { NextFunction, Request, Response } from 'express';
 import { Call } from './model/call';
-import { Button, LocationButtonBody, Section } from './model/button';
+import { AdvancedButton, Button, LocationButtonBody, Section } from './model/button';
 import { JsonObject } from 'type-fest';
 import { ReactionEvent } from './model/reactions';
 export declare enum namespace {
@@ -515,6 +515,21 @@ export declare class Client {
      * @param  {string} footer The footer of the buttons message
      */
     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.
+     *
+     * Body can be location, image, video or document. Buttons can be quick reply, url or call buttons.
+     *
+     * @param  {ChatId} to chat id
+     * @param  {string | LocationButtonBody} body The body of the buttons message
+     * @param  {AdvancedButton[]} buttons Array of buttons - limit is 3!
+     * @param  {string} title The title/header of the buttons message
+     * @param  {string} footer The footer of the buttons message
+     * @param  {string} filename Required if body is a file!!
+     */
+    sendAdvancedButtons(to: ChatId, body: string | LocationButtonBody, buttons: AdvancedButton[], text: string, footer: string, filename: string): Promise<boolean | MessageId>;
     /**
      * Send a banner image
      *
@@ -527,20 +542,6 @@ export declare class Client {
     /**
      * {@license:insiders@}
      *
-     * :::documentation-page{title="Welcome"}
-     *
-     * Please install :inline-code[unified]!
-     *
-     * ::copyright-notice{year="2020"}
-     *
-     * :::
-     * ::license-required[insiders]
-     *
-     * ::span{year="2020"}
-     *
-     * :span{year="2020"}
-     *
-     * <span theme="badge contrast license">Insiders</span>
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
      *
      * Send a list message. This will not work when being sent from business accounts!

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

@@ -2,6 +2,12 @@ export interface Button {
     id: string;
     text: string;
 }
+export interface AdvancedButton {
+    id?: string;
+    text: string;
+    url?: string;
+    number?: string;
+}
 export interface Row {
     title: string;
     description: string;

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

@@ -34,6 +34,16 @@ export declare enum DIRECTORY_STRATEGY {
      */
     DATE_CHAT = "DATE_CHAT"
 }
+declare type SessionId = string;
+declare type LicenseKey = string;
+declare type HostAccountNumber = `${number}`;
+declare type HostAccountNumberOrSessionID = HostAccountNumber | SessionId;
+declare type LicenseKeyConfigObject = {
+    [key: HostAccountNumberOrSessionID]: LicenseKey;
+};
+declare type LicenseKeyConfigFunctionReturn = LicenseKeyConfigObject | LicenseKey;
+declare type LicenseKeyConfigFunction = (sessionId?: SessionId, number?: HostAccountNumber) => LicenseKeyConfigFunctionReturn | Promise<LicenseKeyConfigFunctionReturn>;
+declare type LicenseKeyConfig = LicenseKeyConfigFunction | LicenseKeyConfigObject | LicenseKey;
 /**
  * The available languages for the host security notification
  */
@@ -98,7 +108,8 @@ export declare enum LicenseType {
     TEXT_STORY = "Text Story License Key",
     IMAGE_STORY = "Image Story License Key",
     VIDEO_STORY = "Video Story License Key",
-    PREMIUM = "Premium License Key"
+    PREMIUM = "Premium License Key",
+    NONE = "NONE"
 }
 export interface SessionData {
     WABrowserId?: string;
@@ -264,7 +275,7 @@ export interface ConfigObject {
      * 1. You can change the number assigned to that License Key at any time, just message me the new number on the private discord channel.
      * 2. In order to cancel your License Key, simply stop your membership.
      */
-    licenseKey?: string | string[];
+    licenseKey?: LicenseKey;
     /**
      * You may set a custom user agent. However, due to recent developments, this is not really neccessary any more.
      */
@@ -770,3 +781,7 @@ export interface ConfigObject {
     /**@internal */
     [x: string]: any;
 }
+export declare type AdvancedConfig = ConfigObject & {
+    licenseKey: LicenseKeyConfig;
+};
+export {};

package/dist/cli/setup.d.ts

@@ -19,7 +19,7 @@ export declare const cliOptionNames: import("type-fest").Simplify<import("type-f
 export declare const meowFlags: () => AnyFlags;
 export declare const helptext: string;
 export declare const envArgs: () => JsonObject;
-export declare const configFile: (config: string) => JsonObject;
+export declare const configFile: (config?: string) => JsonObject;
 export declare const cli: () => {
     createConfig: ConfigObject;
     cliConfig: Merge<ConfigObject, {

package/dist/controllers/initializer.d.ts

@@ -1,5 +1,5 @@
 import { Client } from '../api/Client';
-import { ConfigObject } from '../api/model/index';
+import { AdvancedConfig, ConfigObject } from '../api/model/index';
 export declare const pkg: any, configWithCases: any, timeout: (ms: number) => Promise<unknown>;
 export declare let screenshot: any;
 /**
@@ -17,6 +17,6 @@ export declare let screenshot: any;
  * ...
  * })....
  * ```
- * @param config ConfigObject] The extended custom configuration
+ * @param config AdvancedConfig The extended custom configuration
  */
-export declare function create(config?: ConfigObject): Promise<Client>;
+export declare function create(config?: AdvancedConfig | ConfigObject): Promise<Client>;

package/package.json

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