@green-api/greenapi-integration 0.3.0 → 0.5.0

package/dist/types/types.d.ts

@@ -2,7 +2,7 @@
  * Base interface for GREEN-API WhatsApp instances.
  * Contains the essential credentials needed to interact with the API.
  */
-interface BaseInstance {
+export interface BaseInstance {
     idInstance: number | bigint;
     apiTokenInstance: string;
     stateInstance?: InstanceState;
@@ -22,6 +22,7 @@ export interface Instance extends BaseInstance {
 export type Message = ({
     type: "text";
     message: string;
+    linkPreview?: boolean;
 } & BaseMessage) | ({
     type: "upload-file";
     caption?: string;
@@ -97,7 +98,57 @@ export type SendPoll = Extract<Message, {
 export type ForwardMessages = Extract<Message, {
     type: "forward";
 }>;
-export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "pollMessage";
+export type QueueMessageType = "sendMessage" | "sendPoll" | "sendFileByUrl" | "sendLocation" | "sendContact" | "ForwardMessages";
+export type QueueMessageBody = SendMessage | SendPoll | SendFileByUrl | SendLocation | SendContact | ForwardMessages;
+export interface QueueMessage {
+    messageID?: string;
+    messagesIDs?: string[];
+    type: QueueMessageType;
+    body: QueueMessageBody;
+}
+export interface ClearMessagesQueue {
+    isCleared: boolean;
+}
+export type MessageType = "textMessage" | "extendedTextMessage" | "imageMessage" | "videoMessage" | "documentMessage" | "audioMessage" | "contactMessage" | "locationMessage" | "pollMessage" | "reactionMessage" | "pollUpdateMessage" | "quotedMessage" | "stickerMessage";
+export interface GetMessage {
+    chatId: string;
+    idMessage: string;
+}
+export interface GetChatHistory {
+    chatId: string;
+    count?: number;
+}
+export interface BaseJournalMessage {
+    idMessage: string;
+    timestamp: number;
+    typeMessage: MessageType;
+    chatId: string;
+    isForwarded: boolean;
+    forwardingScore: number;
+}
+export interface IncomingJournalFields {
+    type: "incoming";
+    senderId: string;
+    senderName: string;
+    senderContactName: string;
+}
+export interface OutgoingJournalFields {
+    type: "outgoing";
+    statusMessage: OutgoingMessageStatus;
+    sendByApi: boolean;
+}
+export type BaseIncomingJournalMessage = BaseJournalMessage & IncomingJournalFields;
+export type BaseOutgoingJournalMessage = BaseJournalMessage & OutgoingJournalFields;
+export type BaseJournalResponse = BaseIncomingJournalMessage | BaseOutgoingJournalMessage;
+export type OutgoingJournalResponse = BaseOutgoingJournalMessage & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
+export type IncomingJournalResponse = BaseIncomingJournalMessage & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
+export type JournalResponse = BaseJournalResponse & WebhookMessageData & {
+    quotedMessage?: QuotedMessage;
+};
 export interface ForwardableMessage {
     forwardingScore: number;
     isForwarded: boolean;
@@ -129,6 +180,12 @@ export interface ContactMessageData extends ForwardableMessage {
     displayName: string;
     vcard: string;
 }
+export interface ContactsArrayMessageData extends ForwardableMessage {
+    contacts: Array<{
+        displayName: string;
+        vcard: string;
+    }>;
+}
 export interface PollMessageData {
     name: string;
     options: PollOption[];
@@ -147,6 +204,12 @@ type QuotedMessage = {
         displayName: string;
         vcard: string;
     };
+} | {
+    typeMessage: "contactsArrayMessage";
+    contacts: Array<{
+        displayName: string;
+        vcard: string;
+    }>;
 } | {
     typeMessage: "locationMessage";
     location: {
@@ -223,6 +286,9 @@ export type WebhookMessageData = {
 } | {
     typeMessage: "pollUpdateMessage";
     pollMessageData: PollUpdateMessageData;
+} | {
+    typeMessage: "contactsArrayMessage";
+    messageData: ContactsArrayMessageData;
 };
 export interface MessageWebhook {
     typeWebhook: "incomingMessageReceived" | "outgoingMessageReceived" | "outgoingAPIMessageReceived";
@@ -274,6 +340,83 @@ export interface Reboot {
 export interface Logout {
     isLogout: boolean;
 }
+export interface ReadChat {
+    chatId: string;
+    idMessage?: string;
+}
+export interface ReadChatResponse {
+    setRead: boolean;
+}
+export interface CheckWhatsapp {
+    phoneNumber: number;
+}
+export interface CheckWhatsappResponse {
+    existsWhatsapp: boolean;
+}
+export interface GetAvatar {
+    chatId: string;
+}
+export interface GetAvatarResponse {
+    urlAvatar: string;
+    available: boolean;
+}
+export type ContactType = "user" | "group";
+export interface Contact {
+    id: string;
+    name: string;
+    contactName: string;
+    type: ContactType;
+}
+export interface ProductImageUrls {
+    requested: string;
+    original: string;
+}
+export interface ProductReviewStatus {
+    whatsapp: string;
+}
+export interface Product {
+    id: string;
+    imageUrls: ProductImageUrls;
+    reviewStatus: ProductReviewStatus;
+    availability: string;
+    name: string;
+    description?: string;
+    price: string | null;
+    isHidden: boolean;
+}
+export interface ContactInfo {
+    avatar: string;
+    name: string;
+    contactName: string;
+    email: string;
+    category: string;
+    description: string;
+    products: Product[];
+    chatId: string;
+    lastSeen: string | null;
+    isArchive: boolean;
+    isDisappearing: boolean;
+    isMute: boolean;
+    messageExpiration: number;
+    muteExpiration: number | null;
+    isBusiness: boolean;
+}
+export interface ArchiveChat {
+    chatId: string;
+}
+export interface UnarchiveChat {
+    chatId: string;
+}
+export type EphemeralExpiration = 0 | 86400 | 604800 | 7776000;
+export interface SetDisappearingChat {
+    chatId: string;
+    ephemeralExpiration: EphemeralExpiration;
+}
+export interface SetDisappearingChatResponse {
+    chatId: string;
+    disappearingMessagesInChat: boolean;
+    ephemeralExpiration: EphemeralExpiration;
+}
 /**
  * Represents an instance state in the GREEN-API system.
  */
@@ -313,6 +456,84 @@ export interface SetProfilePicture {
     urlAvatar: string;
     setProfilePicture: boolean;
 }
+export interface CreateGroup {
+    groupName: string;
+    chatIds: string[];
+}
+export interface CreateGroupResponse {
+    created: boolean;
+    chatId: string;
+    groupInviteLink: string;
+}
+export interface UpdateGroupName {
+    groupId: string;
+    groupName: string;
+}
+export interface UpdateGroupNameResponse {
+    updateGroupName: boolean;
+}
+export interface GroupParticipant {
+    id: string;
+    isAdmin: boolean;
+    isSuperAdmin: boolean;
+}
+export interface GroupData {
+    groupId: string;
+    owner: string;
+    subject: string;
+    creation: number;
+    participants: GroupParticipant[];
+    subjectTime: number;
+    subjectOwner: string;
+    groupInviteLink: string;
+}
+export interface GetGroupData {
+    groupId: string;
+}
+export interface AddGroupParticipant {
+    groupId: string;
+    participantChatId: string;
+}
+export interface AddGroupParticipantResponse {
+    addParticipant: boolean;
+}
+export interface RemoveGroupParticipant {
+    groupId: string;
+    participantChatId: string;
+}
+export interface RemoveGroupParticipantResponse {
+    removeParticipant: boolean;
+}
+export interface SetGroupAdmin {
+    groupId: string;
+    participantChatId: string;
+}
+export interface SetGroupAdminResponse {
+    setGroupAdmin: boolean;
+}
+export interface RemoveAdmin {
+    groupId: string;
+    participantChatId: string;
+}
+export interface RemoveAdminResponse {
+    removeAdmin: boolean;
+}
+export interface SetGroupPicture {
+    groupId: string;
+    file: Blob | File;
+}
+export interface SetGroupPictureResponse {
+    setGroupPicture: boolean;
+    urlAvatar: string | null;
+    reason: string;
+}
+export interface LeaveGroup {
+    groupId: string;
+}
+export interface LeaveGroupResponse {
+    leaveGroup?: boolean;
+    removeAdmin?: boolean;
+}
 export interface BaseRequest {
     headers: Record<string, any>;
     body: any;

package/package.json

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