@open-wa/wa-automate-types-only 4.63.0 → 4.64.1

package/dist/api/Client.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { Page } from 'puppeteer';
 import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatCreationResponse, EphemeralDuration } from './model/chat';
-import { Contact, NumberCheck } from './model/contact';
+import { BusinessProfile, Contact, NumberCheck } from './model/contact';
 import { Message, MessageInfo, PollData } from './model/message';
 import { AxiosRequestConfig } from 'axios';
 import { NewCommunityGroup, ParticipantChangedEventModel, GenericGroupChangeEvent, GroupMetadata } from './model/group-metadata';
@@ -591,6 +591,13 @@ export declare class Client {
      *
      * {@license:insiders@}
      *
+     * :::danger
+     *
+     * WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.
+     * THIS IS NOT WORKING FOR GROUPS YET.
+     *
+     * :::
+     *
      * Send generic quick reply buttons. This is an insiders feature for MD accounts.
      *
      * @param  {ChatId} to chat id
@@ -607,9 +614,13 @@ export declare class Client {
      * :::danger
      *
      * Template messages (URL & CALL buttons) are broken for the foreseeable future. Please DO NOT get a license solely for access to URL or CALL buttons. They are no longer reliable due to recent changes at WA.
+     * WA BIZ accounts CANNOT send buttons. This is a WA limitation. DO NOT get a license solely for access to buttons on wa business accounts.
+     *
+     * THIS IS NOT WORKING FOR GROUPS YET.
      *
      * :::
      *
+     *
      * 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.
@@ -635,6 +646,13 @@ export declare class Client {
      *
      * {@license:insiders@}
      *
+     * :::danger
+     *
+     * It is not currently possible to send a listmessage to a group chat. This is a WA limitation.
+     * Please DO NOT get a license solely for access to list messages in group chats.
+     *
+     * :::
+     *
      * Send a list message. This will not work when being sent from business accounts!
      *
      * @param  {ChatId} to
@@ -875,10 +893,17 @@ export declare class Client {
     /**
      * Find any product listings of the given number. Use this to query a catalog
      *
-     * @param id id of buseinss profile (i.e the number with @c.us)
+     * @param id id of business profile (i.e the number with @c.us)
      * @returns None
      */
     getBusinessProfilesProducts(id: ContactId): Promise<any>;
+    /**
+     * Get the business info of a given contact id
+     *
+     * @param id id of business profile (i.e the number with @c.us)
+     * @returns None
+     */
+    getBusinessProfile(id: ContactId): Promise<BusinessProfile>;
     /**
      * Sends product with image to chat
      * @param imgBase64 Base64 image data
@@ -1074,7 +1099,7 @@ export declare class Client {
      * @param last The amount of previous messages to retrieve. Defaults to 10
      * @returns
      */
-    getGptArray(last?: number): Promise<{
+    getGptArray(chatId: ChatId, last?: number): Promise<{
         role: "user" | "assistant";
         content: string;
     }[]>;

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

@@ -8,6 +8,92 @@ export interface NumberCheck {
     canReceiveMessage: boolean;
     numberExists: boolean;
 }
+export interface BizCategory {
+    id: string;
+    localized_display_name: string;
+}
+export interface BizProfileOptions {
+    commerceExperience: "catalog" | "none" | "shop";
+    cartEnabled: boolean;
+}
+export interface BusinessHours {
+    config: {
+        [day in "mon" | "tue" | "wed" | "thu" | "fri" | "sat" | "sun"]: {
+            mode: "specific_hours" | "open_24h" | "appointment_only";
+            hours: number[][];
+        };
+    };
+    timezone: string;
+}
+export interface BusinessProfile {
+    /**
+     * The Contact ID of the business
+     */
+    id: ContactId;
+    /**
+     * Some special string that identifies the business (?)
+     */
+    tag: string;
+    /**
+     * The business description
+     */
+    description: string;
+    /**
+     * The business' categories
+     */
+    categories: BizCategory[];
+    /**
+     * The business' profile options
+     */
+    profileOptions: BizProfileOptions;
+    /**
+     * The business' email address
+     */
+    email: string;
+    /**
+     * Array of strings that represent the business' websites
+     */
+    website: string[];
+    /**
+     * The operating hours of the business
+     */
+    businessHours: BusinessHours;
+    /**
+     * The status of the business' catalog
+     */
+    catalogStatus: "catalog_exists" | string;
+    /**
+     * The address of the business
+     */
+    address: string;
+    /**
+     * The facebook page of the business
+     */
+    fbPage: any;
+    /**
+     * The instagram profile of the business
+     */
+    igProfessional: any;
+    isProfileLinked: boolean;
+    coverPhoto: {
+        /**
+         * The id of the cover photo
+         */
+        id: string;
+        /**
+         * The URL of the cover photo. It might download as an .enc but just change the extension to .jpg
+         */
+        url: string;
+    };
+    /**
+     * The latitude of the business location if set
+     */
+    latitude: number;
+    /**
+     * The longitude of the business location if set
+     */
+    longitude: number;
+}
 export interface Contact {
     formattedName: string;
     id: ContactId;
@@ -48,4 +134,10 @@ export interface Contact {
     verifiedName: string;
     isOnline?: boolean;
     lastSeen?: number;
+    /**
+     * If the contact is a business, the business information will be added to the contact object.
+     *
+     * In some circumstances this will be out of date or lacking certain fields. In those cases you have to use `client.getBusinessProfile`
+     */
+    businessProfile?: BusinessProfile;
 }

package/dist/structures/preProcessors.d.ts

@@ -1,6 +1,13 @@
 import { Client } from "../api/Client";
 import { Message } from "../api/model/message";
-export type MessagePreProcessor = (message: Message, client?: Client) => Promise<Message>;
+/**
+ * A function that takes a message and returns a message.
+ *
+ * @param message The message to be processed
+ * @param client The client that received the message
+ * @param alreadyProcessed Whether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)
+ */
+export type MessagePreProcessor = (message: Message, client?: Client, alreadyProcessed?: boolean) => Promise<Message>;
 /**
  * An object that contains all available [[PREPROCESSORS]].
  *

package/package.json

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