@green-api/greenapi-integration 0.8.0 → 0.9.0

package/dist/core/base-adapter.js

@@ -110,6 +110,10 @@ class BaseAdapter {
                     return client.sendLocation(transformedMessage);
                 case "forward":
                     return client.forwardMessages(transformedMessage);
+                case "interactive-buttons":
+                    return client.sendInteractiveButtons(transformedMessage);
+                case "interactive-buttons-reply":
+                    return client.sendInteractiveButtonsReply(transformedMessage);
                 default:
                     throw new Error("Invalid file message format");
             }

package/dist/core/green-api.client.d.ts

@@ -1,4 +1,4 @@
-import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse, SendInteractiveButtons, SendInteractiveButtonsReply, SendTextStatus, SendVoiceStatus, SendMediaStatus, GetStatusStatisticResponse } from "../types/types";
+import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, AccountSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse, QueueMessage, ClearMessagesQueue, ReadChatResponse, ReadChat, CheckWhatsapp, CheckWhatsappResponse, CheckAccount, CheckAccountResponse, GetAvatarResponse, GetAvatar, Contact, ContactInfo, ArchiveChat, UnarchiveChat, SetDisappearingChat, SetDisappearingChatResponse, CreateGroupResponse, CreateGroup, UpdateGroupName, UpdateGroupNameResponse, GetGroupData, GroupData, AddGroupParticipant, AddGroupParticipantResponse, RemoveGroupParticipant, RemoveGroupParticipantResponse, SetGroupAdmin, SetGroupAdminResponse, RemoveAdminResponse, RemoveAdmin, SetGroupPicture, SetGroupPictureResponse, LeaveGroup, LeaveGroupResponse, GetMessage, JournalResponse, GetChatHistory, IncomingJournalResponse, OutgoingJournalResponse, SendInteractiveButtons, SendInteractiveButtonsReply, SendTextStatus, SendVoiceStatus, SendMediaStatus, GetStatusStatisticResponse } from "../types/types";
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
@@ -261,6 +261,7 @@ export declare class GreenApiClient {
      *
      * @returns Promise resolving to WhatsApp settings
      */
+    getAccountSettings(): Promise<AccountSettings>;
     getWaSettings(): Promise<WaSettings>;
     /**
      * Sets the profile picture for the WhatsApp account.
@@ -356,6 +357,14 @@ export declare class GreenApiClient {
      * ```
      */
     checkWhatsapp(params: CheckWhatsapp): Promise<CheckWhatsappResponse>;
+    /**
+     * Checks whether a messenger account exists for a phone number or username (Telegram, MAX).
+     *
+     * @param params - Phone number in international format, or a Telegram username starting with "@"
+     * @returns Promise resolving to the existence flag and, when the account exists, its chat id
+     * @throws {Error} If neither phoneNumber nor username is given
+     */
+    checkAccount(params: CheckAccount): Promise<CheckAccountResponse>;
     /**
      * Gets a user or group chat avatar.
      *

package/dist/core/green-api.client.js

@@ -7,6 +7,7 @@ exports.GreenApiClient = void 0;
 const axios_1 = __importDefault(require("axios"));
 const errors_1 = require("./errors");
 const logger_1 = require("./logger");
+const defaults_1 = require("../defaults");
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
@@ -35,8 +36,8 @@ class GreenApiClient {
      */
     constructor(instance) {
         this.instance = instance;
-        this.baseUrl = "https://api.green-api.com";
         this.gaLogger = logger_1.GreenApiLogger.getInstance(GreenApiClient.name);
+        this.baseUrl = (instance.apiUrl || defaults_1.DEFAULT_API_URL).replace(/\/+$/, "");
         this.client = axios_1.default.create({
             baseURL: this.buildUrl(),
         });
@@ -64,7 +65,7 @@ class GreenApiClient {
             return response.data;
         }
         catch (error) {
-            throw new errors_1.IntegrationError(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${error.message}. ${JSON.stringify(error.response?.data)}`, "INTEGRATION_ERROR");
+            throw new errors_1.IntegrationError(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${error.message}. ${JSON.stringify(error.response?.data)}`, "INTEGRATION_ERROR", error.response?.status ?? 500, error.response?.data);
         }
     }
     async makeFileUploadRequest(endpoint, formData, headers) {
@@ -142,7 +143,7 @@ class GreenApiClient {
      */
     async sendFileByUpload(message) {
         const formData = new FormData();
-        formData.append("file", message.file.data);
+        formData.append("file", message.file.data, message.file.fileName);
         formData.append("chatId", message.chatId);
         formData.append("fileName", message.file.fileName);
         if (message.caption)
@@ -383,6 +384,9 @@ class GreenApiClient {
      *
      * @returns Promise resolving to WhatsApp settings
      */
+    async getAccountSettings() {
+        return this.makeRequest("get", "getAccountSettings");
+    }
     async getWaSettings() {
         return this.makeRequest("get", "getWaSettings");
     }
@@ -521,6 +525,22 @@ class GreenApiClient {
         }
         return this.makeRequest("post", "checkWhatsapp", params);
     }
+    /**
+     * Checks whether a messenger account exists for a phone number or username (Telegram, MAX).
+     *
+     * @param params - Phone number in international format, or a Telegram username starting with "@"
+     * @returns Promise resolving to the existence flag and, when the account exists, its chat id
+     * @throws {Error} If neither phoneNumber nor username is given
+     */
+    async checkAccount(params) {
+        if (params.phoneNumber === undefined && !params.username) {
+            throw new Error("Either phoneNumber or username is required");
+        }
+        if (params.phoneNumber !== undefined && !Number.isInteger(params.phoneNumber)) {
+            throw new Error("Phone number must contain only digits");
+        }
+        return this.makeRequest("post", "checkAccount", params);
+    }
     /**
      * Gets a user or group chat avatar.
      *

package/dist/defaults.d.ts

@@ -0,0 +1 @@
+export declare const DEFAULT_API_URL = "https://api.green-api.com";

package/dist/defaults.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_API_URL = void 0;
+exports.DEFAULT_API_URL = "https://api.green-api.com";

package/dist/types/types.d.ts

@@ -7,6 +7,7 @@ export interface BaseInstance {
     apiTokenInstance: string;
     stateInstance?: InstanceState | null;
     settings?: Settings | Record<string, any> | null;
+    apiUrl?: string | null;
 }
 /**
  * Extended instance interface that allows for additional platform-specific properties.
@@ -71,7 +72,7 @@ export interface SendInteractiveButtons extends BaseMessage {
     body: string;
     footer?: string;
     buttons: Array<{
-        type: "copy" | "call" | "url" | "reply";
+        type: "copy" | "call" | "url";
         buttonId: string;
         buttonText: string;
         copyCode?: string;
@@ -107,6 +108,10 @@ export type Message = (SendMessage & {
     type: "contact";
 }) | (ForwardMessages & {
     type: "forward";
+}) | (SendInteractiveButtons & {
+    type: "interactive-buttons";
+}) | (SendInteractiveButtonsReply & {
+    type: "interactive-buttons-reply";
 });
 export type QueueMessageType = "sendMessage" | "sendPoll" | "sendFileByUrl" | "sendLocation" | "sendContact" | "ForwardMessages";
 export type QueueMessageBody = SendMessage | SendPoll | SendFileByUrl | SendLocation | SendContact | ForwardMessages;
@@ -510,6 +515,7 @@ export interface MessageWebhook {
         chatName: string;
         senderName: string;
         senderContactName?: string;
+        senderPhoneNumber?: number;
     };
     messageData: WebhookMessageData & {
         quotedMessage?: QuotedMessage;
@@ -538,6 +544,7 @@ export type GreenApiWebhook = MessageWebhook | OutgoingMessageStatusWebhook | St
  */
 export interface Settings {
     wid?: string;
+    typeInstance?: string;
     webhookUrl?: string;
     webhookUrlToken?: string;
     delaySendMessagesMilliseconds?: number;
@@ -574,6 +581,18 @@ export interface CheckWhatsapp {
 export interface CheckWhatsappResponse {
     existsWhatsapp: boolean;
 }
+export interface CheckAccount {
+    phoneNumber?: number;
+    username?: string;
+    force?: boolean;
+}
+export interface CheckAccountResponse {
+    exist: boolean;
+    chatId: string;
+    username?: string;
+    phoneNumber?: number;
+    fromCache?: boolean;
+}
 export interface GetAvatar {
     chatId: string;
 }
@@ -583,10 +602,13 @@ export interface GetAvatarResponse {
 }
 export type ContactType = "user" | "group";
 export interface Contact {
-    id: string;
+    id?: string;
+    chatId?: string;
     name: string;
     contactName: string;
     type: ContactType;
+    phoneNumber?: number;
+    username?: string;
 }
 export interface ProductImageUrls {
     requested: string;
@@ -641,7 +663,7 @@ export interface SetDisappearingChatResponse {
 /**
  * Represents an instance state in the GREEN-API system.
  */
-export type InstanceState = "notAuthorized" | "authorized" | "blocked" | "starting" | "yellowCard";
+export type InstanceState = "notAuthorized" | "authorized" | "blocked" | "starting" | "yellowCard" | "suspended" | "pendingPassword";
 export interface StateInstance {
     stateInstance: InstanceState;
 }
@@ -672,6 +694,16 @@ export interface WaSettings {
     stateInstance: InstanceState;
     deviceId: string;
 }
+export interface AccountSettings {
+    avatar: string;
+    phone: string;
+    stateInstance: InstanceState;
+    chatId: string;
+    historySyncProgress: number;
+    username?: string;
+    logoutProcess?: boolean;
+    suspendedUntil?: number;
+}
 export interface SetProfilePicture {
     reason: string | null;
     urlAvatar: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@green-api/greenapi-integration",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "GREEN-API Integration library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",