@green-api/greenapi-integration 0.2.0 → 0.4.0

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

@@ -1,7 +1,8 @@
-import { Instance, Settings, SendMessage, SendFileByUrl, SendFileByUpload, SendPoll, StateInstance, Reboot, Logout, QR, SendResponse, SendFileByUploadResponse, SetSettingsResponse, GetAuthorizationCode, SetProfilePicture, WaSettings, UploadFile, SendLocation, SendContact, ForwardMessages, ForwardMessagesResponse } from "../types/types";
+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 } from "../types/types";
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
+ * For more information about the methods, refer to https://green-api.com/en/docs
  *
  * @category Client
  *
@@ -213,4 +214,227 @@ export declare class GreenApiClient {
      * @throws {Error} If phone number is not an integer
      */
     getAuthorizationCode(phoneNumber: number): Promise<GetAuthorizationCode>;
+    /**
+     * Gets the list of messages in the sending queue.
+     * Messages are stored for 24 hours and will be sent immediately after phone authorization.
+     * The sending speed is regulated by the Message Sending Interval parameter.
+     *
+     * @returns Promise resolving to an array of queued messages
+     *
+     * @example
+     * ```typescript
+     * const queuedMessages = await client.showMessagesQueue();
+     * console.log(queuedMessages);
+     * ```
+     */
+    showMessagesQueue(): Promise<QueueMessage[]>;
+    /**
+     * Clears the queue of messages waiting to be sent.
+     * Important when switching phone numbers to prevent sending queued messages with the new number.
+     *
+     * @returns Promise resolving to queue clearing status
+     *
+     * @example
+     * ```typescript
+     * const result = await client.clearMessagesQueue();
+     * if (result.isCleared) {
+     *   console.log('Queue successfully cleared');
+     * }
+     * ```
+     */
+    clearMessagesQueue(): Promise<ClearMessagesQueue>;
+    /**
+     * Marks messages in a chat as read.
+     * For this to work, "Receive webhooks on incoming messages and files" setting must be enabled.
+     * Note: Only messages received after enabling the setting can be marked as read.
+     *
+     * @param params - Parameters specifying which messages to mark as read
+     * @returns Promise resolving to read status
+     *
+     * @example
+     * ```typescript
+     * // Mark all messages in chat as read
+     * const result = await client.readChat({
+     *   chatId: "1234567890@c.us"
+     * });
+     *
+     * // Mark specific message as read
+     * const result = await client.readChat({
+     *   chatId: "1234567890@c.us",
+     *   idMessage: "B275A7AA0D6EF89BB9245169BDF174E6"
+     * });
+     * ```
+     */
+    readChat(params: ReadChat): Promise<ReadChatResponse>;
+    /**
+     * Checks WhatsApp account availability on a phone number.
+     *
+     * @param params - Parameters containing the phone number to check
+     * @returns Promise resolving to WhatsApp availability status
+     * @throws {Error} If phone number is not an integer or not 11-12 digits
+     *
+     * @example
+     * ```typescript
+     * const result = await client.checkWhatsapp({
+     *   phoneNumber: 11001234567
+     * });
+     *
+     * if (result.existsWhatsapp) {
+     *   console.log('WhatsApp account exists');
+     * }
+     * ```
+     */
+    checkWhatsapp(params: CheckWhatsapp): Promise<CheckWhatsappResponse>;
+    /**
+     * Gets a user or group chat avatar.
+     *
+     * @param params - Parameters containing the chat ID
+     * @returns Promise resolving to avatar information
+     */
+    getAvatar(params: GetAvatar): Promise<GetAvatarResponse>;
+    /**
+     * Gets a list of the current account contacts.
+     * Note: Contact information updates can take up to 5 minutes.
+     * If an empty array is received, retry the method call.
+     *
+     * @returns Promise resolving to array of contacts
+     */
+    getContacts(): Promise<Contact[]>;
+    /**
+     * Gets detailed information about a contact.
+     * Note: This method does not support group chats, use getGroupData for groups.
+     *
+     * @param params - Parameters containing the chat ID
+     * @returns Promise resolving to contact information
+     */
+    getContactInfo(params: GetAvatar): Promise<ContactInfo>;
+    /**
+     * Archives a chat. Chat must have at least one incoming message.
+     * Note: "Receive webhooks on incoming messages and files" setting must be enabled.
+     *
+     * @param params - Parameters containing the chat ID to archive
+     * @returns Promise resolving to void on success
+     */
+    archiveChat(params: ArchiveChat): Promise<void>;
+    /**
+     * Unarchives a chat.
+     *
+     * @param params - Parameters containing the chat ID to unarchive
+     * @returns Promise resolving to void on success
+     */
+    unarchiveChat(params: UnarchiveChat): Promise<void>;
+    /**
+     * Changes settings of disappearing messages in chats.
+     * Valid expiration times: 0 (off), 86400 (24h), 604800 (7d), 7776000 (90d)
+     *
+     * @param params - Parameters containing chat ID and message expiration time
+     * @returns Promise resolving to chat disappearing message settings
+     */
+    setDisappearingChat(params: SetDisappearingChat): Promise<SetDisappearingChatResponse>;
+    /**
+     * Creates a group chat.
+     * Note: Limited to creating 1 group per 5 minutes to simulate human behavior.
+     *
+     * @param params - Parameters containing group name and participant IDs
+     * @returns Promise resolving to group creation result
+     */
+    createGroup(params: CreateGroup): Promise<CreateGroupResponse>;
+    /**
+     * Changes a group chat name.
+     *
+     * @param params - Parameters containing group ID and new name
+     * @returns Promise resolving to update status
+     */
+    updateGroupName(params: UpdateGroupName): Promise<UpdateGroupNameResponse>;
+    /**
+     * Gets group chat data.
+     * Note: groupInviteLink will be empty if user is not an admin or owner.
+     *
+     * @param params - Parameters containing group ID
+     * @returns Promise resolving to group data
+     */
+    getGroupData(params: GetGroupData): Promise<GroupData>;
+    /**
+     * Adds a participant to a group chat.
+     * Note: Only group administrators can add members.
+     * The participant's number should be saved in the phonebook for reliable addition.
+     *
+     * @param params - Parameters containing group ID and participant ID
+     * @returns Promise resolving to addition status
+     */
+    addGroupParticipant(params: AddGroupParticipant): Promise<AddGroupParticipantResponse>;
+    /**
+     * Removes a participant from a group chat.
+     *
+     * @param params - Parameters containing group ID and participant ID to remove
+     * @returns Promise resolving to removal status
+     */
+    removeGroupParticipant(params: RemoveGroupParticipant): Promise<RemoveGroupParticipantResponse>;
+    /**
+     * Sets a group chat participant as an administrator.
+     *
+     * @param params - Parameters containing group ID and participant ID to promote
+     * @returns Promise resolving to admin status change result
+     */
+    setGroupAdmin(params: SetGroupAdmin): Promise<SetGroupAdminResponse>;
+    /**
+     * Removes administrator rights from a group chat participant.
+     *
+     * @param params - Parameters containing group ID and participant ID to demote
+     * @returns Promise resolving to admin removal status
+     */
+    removeAdmin(params: RemoveAdmin): Promise<RemoveAdminResponse>;
+    /**
+     * Sets a group chat picture.
+     *
+     * @param params - Parameters containing group ID and picture file (jpg)
+     * @returns Promise resolving to picture update status
+     */
+    setGroupPicture(params: SetGroupPicture): Promise<SetGroupPictureResponse>;
+    /**
+     * Makes the current account leave a group chat.
+     *
+     * @param params - Parameters containing the group ID to leave
+     * @returns Promise resolving to leave status
+     */
+    leaveGroup(params: LeaveGroup): Promise<LeaveGroupResponse>;
+    /**
+     * Gets details of a specific message.
+     * Note: To receive incoming webhooks, requires "Receive webhooks on incoming messages and files" setting to be enabled.
+     * Note: To receive statuses of sent messsages, requires "Receive notifications about the statuses of sent messages" to be enabled.
+     * Messages can take up to 2 minutes to appear in the journal.
+     *
+     * @param params - Parameters containing chat ID and message ID
+     * @returns Promise resolving to message details
+     */
+    getMessage(params: GetMessage): Promise<JournalResponse>;
+    /**
+     * Gets chat message history.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param params - Parameters containing chat ID and optional message count
+     * @returns Promise resolving to array of messages
+     */
+    getChatHistory(params: GetChatHistory): Promise<JournalResponse[]>;
+    /**
+     * Gets last incoming messages for the specified time period.
+     * Default is 24 hours (1440 minutes).
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of incoming messages
+     */
+    lastIncomingMessages(minutes?: number): Promise<IncomingJournalResponse[]>;
+    /**
+     * Gets last outgoing messages for the specified time period.
+     * Default is 24 hours (1440 minutes).
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of outgoing messages
+     */
+    lastOutgoingMessages(minutes?: number): Promise<OutgoingJournalResponse[]>;
 }

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

@@ -8,6 +8,7 @@ const axios_1 = __importDefault(require("axios"));
 /**
  * Client for direct interaction with GREEN-API's WhatsApp gateway.
  * Provides methods for sending messages, managing instances, and handling files.
+ * For more information about the methods, refer to https://green-api.com/en/docs
  *
  * @category Client
  *
@@ -43,19 +44,20 @@ class GreenApiClient {
     buildEndpoint(endpoint) {
         return `/${endpoint}/${this.instance.apiTokenInstance}`;
     }
-    async makeRequest(method, endpoint, data, config) {
+    async makeRequest(method, endpoint, data, queryParams, config) {
         try {
+            const url = this.buildEndpoint(endpoint) + (queryParams ? "?" + new URLSearchParams(Object.entries(queryParams).map(([key, value]) => [key, value.toString()])).toString() : "");
             const response = await (method === "get"
-                ? this.client.get(this.buildEndpoint(endpoint), config)
-                : this.client.post(this.buildEndpoint(endpoint), data, config));
+                ? this.client.get(url, config)
+                : this.client.post(url, data, config));
             return response.data;
         }
         catch (error) {
-            throw new Error(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${error.message}`);
+            throw new Error(`Failed to ${endpoint.replace(/([A-Z])/g, " $1").toLowerCase()}: ${error.message}. ${JSON.stringify(error.response?.data)}`);
         }
     }
     async makeFileUploadRequest(endpoint, formData, headers) {
-        return this.makeRequest("post", endpoint, formData, {
+        return this.makeRequest("post", endpoint, formData, undefined, {
             headers: { "Content-Type": "multipart/form-data" },
             ...headers,
         });
@@ -334,5 +336,284 @@ class GreenApiClient {
         }
         return this.makeRequest("post", "getAuthorizationCode", { phoneNumber });
     }
+    /**
+     * Gets the list of messages in the sending queue.
+     * Messages are stored for 24 hours and will be sent immediately after phone authorization.
+     * The sending speed is regulated by the Message Sending Interval parameter.
+     *
+     * @returns Promise resolving to an array of queued messages
+     *
+     * @example
+     * ```typescript
+     * const queuedMessages = await client.showMessagesQueue();
+     * console.log(queuedMessages);
+     * ```
+     */
+    async showMessagesQueue() {
+        return this.makeRequest("get", "showMessagesQueue");
+    }
+    /**
+     * Clears the queue of messages waiting to be sent.
+     * Important when switching phone numbers to prevent sending queued messages with the new number.
+     *
+     * @returns Promise resolving to queue clearing status
+     *
+     * @example
+     * ```typescript
+     * const result = await client.clearMessagesQueue();
+     * if (result.isCleared) {
+     *   console.log('Queue successfully cleared');
+     * }
+     * ```
+     */
+    async clearMessagesQueue() {
+        return this.makeRequest("get", "clearMessagesQueue");
+    }
+    /**
+     * Marks messages in a chat as read.
+     * For this to work, "Receive webhooks on incoming messages and files" setting must be enabled.
+     * Note: Only messages received after enabling the setting can be marked as read.
+     *
+     * @param params - Parameters specifying which messages to mark as read
+     * @returns Promise resolving to read status
+     *
+     * @example
+     * ```typescript
+     * // Mark all messages in chat as read
+     * const result = await client.readChat({
+     *   chatId: "1234567890@c.us"
+     * });
+     *
+     * // Mark specific message as read
+     * const result = await client.readChat({
+     *   chatId: "1234567890@c.us",
+     *   idMessage: "B275A7AA0D6EF89BB9245169BDF174E6"
+     * });
+     * ```
+     */
+    async readChat(params) {
+        return this.makeRequest("post", "readChat", params);
+    }
+    /**
+     * Checks WhatsApp account availability on a phone number.
+     *
+     * @param params - Parameters containing the phone number to check
+     * @returns Promise resolving to WhatsApp availability status
+     * @throws {Error} If phone number is not an integer or not 11-12 digits
+     *
+     * @example
+     * ```typescript
+     * const result = await client.checkWhatsapp({
+     *   phoneNumber: 11001234567
+     * });
+     *
+     * if (result.existsWhatsapp) {
+     *   console.log('WhatsApp account exists');
+     * }
+     * ```
+     */
+    async checkWhatsapp(params) {
+        const phoneStr = params.phoneNumber.toString();
+        if (!Number.isInteger(params.phoneNumber)) {
+            throw new Error("Phone number must contain only digits");
+        }
+        if (phoneStr.length < 11 || phoneStr.length > 12) {
+            throw new Error("Phone number must be 11 or 12 digits");
+        }
+        return this.makeRequest("post", "checkWhatsapp", params);
+    }
+    /**
+     * Gets a user or group chat avatar.
+     *
+     * @param params - Parameters containing the chat ID
+     * @returns Promise resolving to avatar information
+     */
+    async getAvatar(params) {
+        return this.makeRequest("post", "getAvatar", params);
+    }
+    /**
+     * Gets a list of the current account contacts.
+     * Note: Contact information updates can take up to 5 minutes.
+     * If an empty array is received, retry the method call.
+     *
+     * @returns Promise resolving to array of contacts
+     */
+    async getContacts() {
+        return this.makeRequest("get", "getContacts");
+    }
+    /**
+     * Gets detailed information about a contact.
+     * Note: This method does not support group chats, use getGroupData for groups.
+     *
+     * @param params - Parameters containing the chat ID
+     * @returns Promise resolving to contact information
+     */
+    async getContactInfo(params) {
+        return this.makeRequest("post", "getContactInfo", params);
+    }
+    /**
+     * Archives a chat. Chat must have at least one incoming message.
+     * Note: "Receive webhooks on incoming messages and files" setting must be enabled.
+     *
+     * @param params - Parameters containing the chat ID to archive
+     * @returns Promise resolving to void on success
+     */
+    async archiveChat(params) {
+        return this.makeRequest("post", "archiveChat", params);
+    }
+    /**
+     * Unarchives a chat.
+     *
+     * @param params - Parameters containing the chat ID to unarchive
+     * @returns Promise resolving to void on success
+     */
+    async unarchiveChat(params) {
+        return this.makeRequest("post", "unarchiveChat", params);
+    }
+    /**
+     * Changes settings of disappearing messages in chats.
+     * Valid expiration times: 0 (off), 86400 (24h), 604800 (7d), 7776000 (90d)
+     *
+     * @param params - Parameters containing chat ID and message expiration time
+     * @returns Promise resolving to chat disappearing message settings
+     */
+    async setDisappearingChat(params) {
+        return this.makeRequest("post", "setDisappearingChat", params);
+    }
+    /**
+     * Creates a group chat.
+     * Note: Limited to creating 1 group per 5 minutes to simulate human behavior.
+     *
+     * @param params - Parameters containing group name and participant IDs
+     * @returns Promise resolving to group creation result
+     */
+    async createGroup(params) {
+        return this.makeRequest("post", "createGroup", params);
+    }
+    /**
+     * Changes a group chat name.
+     *
+     * @param params - Parameters containing group ID and new name
+     * @returns Promise resolving to update status
+     */
+    async updateGroupName(params) {
+        return this.makeRequest("post", "updateGroupName", params);
+    }
+    /**
+     * Gets group chat data.
+     * Note: groupInviteLink will be empty if user is not an admin or owner.
+     *
+     * @param params - Parameters containing group ID
+     * @returns Promise resolving to group data
+     */
+    async getGroupData(params) {
+        return this.makeRequest("post", "getGroupData", params);
+    }
+    /**
+     * Adds a participant to a group chat.
+     * Note: Only group administrators can add members.
+     * The participant's number should be saved in the phonebook for reliable addition.
+     *
+     * @param params - Parameters containing group ID and participant ID
+     * @returns Promise resolving to addition status
+     */
+    async addGroupParticipant(params) {
+        return this.makeRequest("post", "addGroupParticipant", params);
+    }
+    /**
+     * Removes a participant from a group chat.
+     *
+     * @param params - Parameters containing group ID and participant ID to remove
+     * @returns Promise resolving to removal status
+     */
+    async removeGroupParticipant(params) {
+        return this.makeRequest("post", "removeGroupParticipant", params);
+    }
+    /**
+     * Sets a group chat participant as an administrator.
+     *
+     * @param params - Parameters containing group ID and participant ID to promote
+     * @returns Promise resolving to admin status change result
+     */
+    async setGroupAdmin(params) {
+        return this.makeRequest("post", "setGroupAdmin", params);
+    }
+    /**
+     * Removes administrator rights from a group chat participant.
+     *
+     * @param params - Parameters containing group ID and participant ID to demote
+     * @returns Promise resolving to admin removal status
+     */
+    async removeAdmin(params) {
+        return this.makeRequest("post", "removeAdmin", params);
+    }
+    /**
+     * Sets a group chat picture.
+     *
+     * @param params - Parameters containing group ID and picture file (jpg)
+     * @returns Promise resolving to picture update status
+     */
+    async setGroupPicture(params) {
+        const formData = new FormData();
+        formData.append("file", params.file);
+        formData.append("groupId", params.groupId);
+        return this.makeFileUploadRequest("setGroupPicture", formData);
+    }
+    /**
+     * Makes the current account leave a group chat.
+     *
+     * @param params - Parameters containing the group ID to leave
+     * @returns Promise resolving to leave status
+     */
+    async leaveGroup(params) {
+        return this.makeRequest("post", "leaveGroup", params);
+    }
+    /**
+     * Gets details of a specific message.
+     * Note: To receive incoming webhooks, requires "Receive webhooks on incoming messages and files" setting to be enabled.
+     * Note: To receive statuses of sent messsages, requires "Receive notifications about the statuses of sent messages" to be enabled.
+     * Messages can take up to 2 minutes to appear in the journal.
+     *
+     * @param params - Parameters containing chat ID and message ID
+     * @returns Promise resolving to message details
+     */
+    async getMessage(params) {
+        return this.makeRequest("post", "getMessage", params);
+    }
+    /**
+     * Gets chat message history.
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param params - Parameters containing chat ID and optional message count
+     * @returns Promise resolving to array of messages
+     */
+    async getChatHistory(params) {
+        return this.makeRequest("post", "getChatHistory", params);
+    }
+    /**
+     * Gets last incoming messages for the specified time period.
+     * Default is 24 hours (1440 minutes).
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of incoming messages
+     */
+    async lastIncomingMessages(minutes) {
+        return this.makeRequest("get", "lastIncomingMessages", undefined, minutes ? { minutes } : undefined);
+    }
+    /**
+     * Gets last outgoing messages for the specified time period.
+     * Default is 24 hours (1440 minutes).
+     * Note: Requires "Receive webhooks" setting to be enabled.
+     * Messages can take up to 2 minutes to appear in history.
+     *
+     * @param minutes - Optional time period in minutes
+     * @returns Promise resolving to array of outgoing messages
+     */
+    async lastOutgoingMessages(minutes) {
+        return this.makeRequest("get", "lastOutgoingMessages", undefined, minutes ? { minutes } : undefined);
+    }
 }
 exports.GreenApiClient = GreenApiClient;

package/dist/core/storage-provider.d.ts

@@ -1,4 +1,4 @@
-import { BaseUser, Instance, Settings } from "../types/types";
+import { BaseUser, Instance } from "../types/types";
 /**
  * Abstract class for managing instance and user data storage.
  * Implement this class to define how your integration stores and retrieves data.
@@ -26,10 +26,9 @@ export declare abstract class StorageProvider<TUser extends BaseUser = BaseUser,
      *
      * @param instance - The instance data to store
      * @param userId - ID of the user who owns this instance
-     * @param settings - Optional GREEN-API settings for the instance
      * @returns Promise resolving to the created instance
      */
-    abstract createInstance(instance: Instance, userId: bigint | number, settings?: Settings): Promise<TInstance>;
+    abstract createInstance(instance: Instance, userId: bigint | number): Promise<TInstance>;
     /**
      * Retrieves an instance by its ID.
      *