@in.pulse-crm/sdk 2.10.1 → 2.10.3

package/.prettierrc

@@ -1,4 +1,4 @@
-{
-	"tabWidth": 4,
-	"useTabs": true
-}
+{
+	"tabWidth": 4,
+	"useTabs": true
+}

package/dist/files.client.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 import ApiClient from "./api-client";
 import { File, UploadFileOptions } from "./types/files.types";
 declare class FilesClient extends ApiClient {

package/dist/types/files.types.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+/// <reference types="node" />
 export interface UploadFileOptions {
     /**
      * Nome da instância onde o arquivo está armazenado.

package/dist/types/socket-events.types.d.ts

@@ -7,6 +7,8 @@ export declare enum SocketEventType {
     WppChatFinished = "wpp_chat_finished",
     WppChatTransfer = "wpp_chat_transfer",
     WppMessage = "wpp_message",
+    WppMessageEdit = "wpp_message_edit",
+    WppMessageDelete = "wpp_message_delete",
     WppMessageStatus = "wpp_message_status",
     WppMessageReaction = "wpp_message_reaction",
     WppContactMessagesRead = "wpp_contact_messages_read",
@@ -25,6 +27,8 @@ export interface EmitSocketEventFn {
     (type: SocketEventType.WppChatFinished, room: SocketServerRoom, data: WppChatFinishedEventData): Promise<MessageResponse>;
     (type: SocketEventType.WppChatTransfer, room: SocketServerRoom, data: WppChatTransferEventData): Promise<MessageResponse>;
     (type: SocketEventType.WppMessage, room: SocketServerChatRoom, data: WppMessageEventData): Promise<MessageResponse>;
+    (type: SocketEventType.WppMessageEdit, room: SocketServerChatRoom, data: WppMessageEditEventData): Promise<MessageResponse>;
+    (type: SocketEventType.WppMessageDelete, room: SocketServerChatRoom, data: WppMessageDeleteEventData): Promise<MessageResponse>;
     (type: SocketEventType.WppMessageStatus, room: SocketServerChatRoom, data: WppMessageStatusEventData): Promise<MessageResponse>;
     (type: SocketEventType.WppContactMessagesRead, room: SocketServerChatRoom, data: WppContactMessagesReadEventData): Promise<MessageResponse>;
     (type: SocketEventType.WppMessageReaction, room: SocketServerChatRoom, data: WppMessageReactionEventData): Promise<MessageResponse>;
@@ -49,6 +53,8 @@ export interface ListenSocketEventFn {
     (type: SocketEventType.InternalChatFinished, callback: (data: InternalChatFinishedEventData) => void): void;
     (type: SocketEventType.InternalMessage, callback: (data: InternalMessageEventData) => void): void;
     (type: SocketEventType.InternalMessageStatus, callback: (data: InternalMessageStatusEventData) => void): void;
+    (type: SocketEventType.WppMessageEdit, callback: (data: WppMessageEditEventData) => void): void;
+    (type: SocketEventType.WppMessageDelete, callback: (data: WppMessageDeleteEventData) => void): void;
 }
 export interface UnlistenSocketEventFn {
     (type: SocketEventType): void;
@@ -77,6 +83,13 @@ export interface WppContactMessagesReadEventData {
 export interface WppMessageEventData {
     message: WppMessage;
 }
+export interface WppMessageEditEventData {
+    messageId: number;
+    newText: string;
+}
+export interface WppMessageDeleteEventData {
+    messageId: number;
+}
 export interface WppMessageStatusEventData {
     messageId: number;
     contactId: number;

package/dist/types/socket-events.types.js

@@ -7,6 +7,8 @@ var SocketEventType;
     SocketEventType["WppChatFinished"] = "wpp_chat_finished";
     SocketEventType["WppChatTransfer"] = "wpp_chat_transfer";
     SocketEventType["WppMessage"] = "wpp_message";
+    SocketEventType["WppMessageEdit"] = "wpp_message_edit";
+    SocketEventType["WppMessageDelete"] = "wpp_message_delete";
     SocketEventType["WppMessageStatus"] = "wpp_message_status";
     SocketEventType["WppMessageReaction"] = "wpp_message_reaction";
     SocketEventType["WppContactMessagesRead"] = "wpp_contact_messages_read";

package/dist/types/whatsapp.types.d.ts

@@ -4,20 +4,24 @@ export interface WppContact {
     name: string;
     phone: string;
     customerId?: number;
+    avatarUrl?: string;
     instance: string;
     isBlocked: boolean;
     isOnlyAdmin: boolean;
+    lastOutOfHoursReplySentAt?: Date | null;
 }
 export interface WppContactWithCustomer {
     id: number;
     name: string;
     phone: string;
     customerId?: number;
+    avatarUrl?: string;
     instance: string;
     isBlocked: boolean;
     isOnlyAdmin: boolean;
     customer: Customer | null;
     chatingWith: string | null;
+    lastOutOfHoursReplySentAt?: Date | null;
 }
 export interface WppMessage {
     id: number;
@@ -29,6 +33,7 @@ export interface WppMessage {
     type: string;
     quotedId?: number | null;
     chatId?: number | null;
+    userName?: string;
     contactId?: number | null;
     body: string;
     timestamp: string;
@@ -55,6 +60,7 @@ export interface WppChat {
     instance: string;
     contactId?: number;
     userId?: number;
+    userName?: string;
     walletId?: number;
     botId?: number;
     resultId?: number;
@@ -164,3 +170,32 @@ export interface PaginatedNotificationsResponse {
     notifications: AppNotification[];
     totalCount: number;
 }
+export interface AutomaticResponseSchedule {
+    id?: number;
+    dayOfWeek: number;
+    startTime: string;
+    endTime: string;
+}
+export interface AutomaticResponseRule {
+    id: number;
+    name: string;
+    message: string;
+    isEnabled: boolean;
+    isGlobal: boolean;
+    cooldownSeconds: number;
+    fileId: number | null;
+    schedules: AutomaticResponseSchedule[];
+    userAssignments: {
+        userId: number;
+    }[];
+}
+export interface AutomaticResponseRuleDTO {
+    name: string;
+    message: string;
+    isEnabled: boolean;
+    isGlobal: boolean;
+    cooldownSeconds: number;
+    fileId?: number | null;
+    userIds: number[];
+    schedules: Omit<AutomaticResponseSchedule, 'id'>[];
+}

package/dist/whatsapp.client.d.ts

@@ -1,7 +1,7 @@
 import ApiClient from "./api-client";
 import { RequestFilters } from "./types";
 import { DataResponse, MessageResponse } from "./types/response.types";
-import { AppNotification, CreateScheduleDTO, ForwardMessagesData, PaginatedNotificationsResponse, SendMessageData, WppChatsAndMessages, WppChatWithDetailsAndMessages, WppContact, WppContactWithCustomer, WppMessage, WppSchedule, WppWallet } from "./types/whatsapp.types";
+import { AppNotification, AutomaticResponseRule, AutomaticResponseRuleDTO, CreateScheduleDTO, ForwardMessagesData, PaginatedNotificationsResponse, SendMessageData, WppChatsAndMessages, WppChatWithDetailsAndMessages, WppContact, WppContactWithCustomer, WppMessage, WppSchedule, WppWallet } from "./types/whatsapp.types";
 interface FetchMessagesFilters {
     minDate: string;
     maxDate: string;
@@ -79,5 +79,9 @@ export default class WhatsappClient extends ApiClient {
     getMessages(token: string, filters: FetchMessagesFilters): Promise<(WppMessage & {
         WppContact: WppContact | null;
     })[]>;
+    getAutoResponseRules(): Promise<AutomaticResponseRule[]>;
+    createAutoResponseRule(ruleData: AutomaticResponseRuleDTO): Promise<AutomaticResponseRule>;
+    updateAutoResponseRule(id: number, ruleData: Omit<AutomaticResponseRuleDTO, 'instance'>): Promise<AutomaticResponseRule>;
+    deleteAutoResponseRule(id: number): Promise<void>;
 }
 export {};

package/dist/whatsapp.client.js

@@ -237,5 +237,24 @@ class WhatsappClient extends api_client_1.default {
         });
         return res.data;
     }
+    async getAutoResponseRules() {
+        const url = `/api/auto-response-rules`;
+        const { data: res } = await this.ax.get(url);
+        return res.data;
+    }
+    async createAutoResponseRule(ruleData) {
+        const url = `/api/auto-response-rules`;
+        const { data: res } = await this.ax.post(url, ruleData);
+        return res.data;
+    }
+    async updateAutoResponseRule(id, ruleData) {
+        const url = `/api/auto-response-rules/${id}`;
+        const { data: res } = await this.ax.put(url, ruleData);
+        return res.data;
+    }
+    async deleteAutoResponseRule(id) {
+        const url = `/api/auto-response-rules/${id}`;
+        await this.ax.delete(url);
+    }
 }
 exports.default = WhatsappClient;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@in.pulse-crm/sdk",
-	"version": "2.10.1",
+	"version": "2.10.3",
 	"description": "SDKs for abstraction of api consumption of in.pulse-crm application",
 	"main": "./dist/index.js",
 	"types": "./dist/index.d.ts",

package/src/socket-server.client.ts

@@ -8,26 +8,26 @@ import { MessageResponse } from "./types/response.types";
  * for emitting events to specific rooms on the server.
  */
 export default class SocketServerApi extends ApiClient {
-    /**
-     * Creates an instance of the SocketServerApiClient.
-     *
-     * @param baseUrl - The base URL for the socket server API.
-     */
-    constructor(baseUrl: string) {
-        super(baseUrl);
-    }
+	/**
+	 * Creates an instance of the SocketServerApiClient.
+	 *
+	 * @param baseUrl - The base URL for the socket server API.
+	 */
+	constructor(baseUrl: string) {
+		super(baseUrl);
+	}
 
-    /**
-     * Emits a socket event to a specified room with a given event name and value.
-     *
-     * @param event - The name of the event to emit.
-     * @param room - The name of the room to which the event should be emitted.
-     * @param value - The payload or data to send with the event.
-     * @returns A promise that resolves with the response from the API call.
-     */
-    public emit: EmitSocketEventFn = (event, room, value) => {
-        return this.ax
+	/**
+	 * Emits a socket event to a specified room with a given event name and value.
+	 *
+	 * @param event - The name of the event to emit.
+	 * @param room - The name of the room to which the event should be emitted.
+	 * @param value - The payload or data to send with the event.
+	 * @returns A promise that resolves with the response from the API call.
+	 */
+	public emit: EmitSocketEventFn = (event, room, value) => {
+		return this.ax
 			.post<MessageResponse>(`/api/ws/emit/${room}/${event}`, value)
 			.then((res) => res.data);
-    }
-}
+	};
+}

package/src/types/socket-events.types.ts

@@ -7,13 +7,19 @@ import {
 } from "./socket-rooms.types";
 import { MessageResponse } from "./response.types";
 import { WppMessage, WppMessageStatus } from "./whatsapp.types";
-import { InternalChat, InternalChatMember, InternalMessage } from "./internal.types";
+import {
+	InternalChat,
+	InternalChatMember,
+	InternalMessage,
+} from "./internal.types";
 
 export enum SocketEventType {
 	WppChatStarted = "wpp_chat_started",
 	WppChatFinished = "wpp_chat_finished",
 	WppChatTransfer = "wpp_chat_transfer",
 	WppMessage = "wpp_message",
+	WppMessageEdit = "wpp_message_edit",
+	WppMessageDelete = "wpp_message_delete",
 	WppMessageStatus = "wpp_message_status",
 	WppMessageReaction = "wpp_message_reaction",
 	WppContactMessagesRead = "wpp_contact_messages_read",
@@ -57,6 +63,16 @@ export interface EmitSocketEventFn {
 		room: SocketServerChatRoom,
 		data: WppMessageEventData,
 	): Promise<MessageResponse>;
+	(
+		type: SocketEventType.WppMessageEdit,
+		room: SocketServerChatRoom,
+		data: WppMessageEditEventData,
+	): Promise<MessageResponse>;
+	(
+		type: SocketEventType.WppMessageDelete,
+		room: SocketServerChatRoom,
+		data: WppMessageDeleteEventData,
+	): Promise<MessageResponse>;
 	(
 		type: SocketEventType.WppMessageStatus,
 		room: SocketServerChatRoom,
@@ -116,7 +132,7 @@ export interface ListenSocketEventFn {
 		type: SocketEventType.WppChatFinished,
 		callback: (data: WppChatFinishedEventData) => void,
 	): void;
-		(
+	(
 		type: SocketEventType.WppChatTransfer,
 		callback: (data: WppChatTransferEventData) => void,
 	): void;
@@ -156,6 +172,14 @@ export interface ListenSocketEventFn {
 		type: SocketEventType.InternalMessageStatus,
 		callback: (data: InternalMessageStatusEventData) => void,
 	): void;
+	(
+		type: SocketEventType.WppMessageEdit,
+		callback: (data: WppMessageEditEventData) => void,
+	): void;
+	(
+		type: SocketEventType.WppMessageDelete,
+		callback: (data: WppMessageDeleteEventData) => void,
+	): void;
 }
 
 export interface UnlistenSocketEventFn {
@@ -187,6 +211,15 @@ export interface WppContactMessagesReadEventData {
 export interface WppMessageEventData {
 	message: WppMessage;
 }
+
+export interface WppMessageEditEventData {
+	messageId: number;
+	newText: string;
+}
+
+export interface WppMessageDeleteEventData {
+	messageId: number;
+}
 export interface WppMessageStatusEventData {
 	messageId: number;
 	contactId: number;
@@ -197,7 +230,10 @@ export interface WppMessageReactionEventData {
 	reaction: string;
 }
 export interface InternalChatStartedEventData {
-	chat: InternalChat & { participants: InternalChatMember[], messages: InternalMessage[] };
+	chat: InternalChat & {
+		participants: InternalChatMember[];
+		messages: InternalMessage[];
+	};
 }
 export interface InternalChatFinishedEventData {
 	chatId: number;

package/src/types/whatsapp.types.ts

@@ -5,9 +5,11 @@ export interface WppContact {
 	name: string;
 	phone: string;
 	customerId?: number;
+	avatarUrl?: string;
 	instance: string;
 	isBlocked: boolean;
 	isOnlyAdmin: boolean;
+	lastOutOfHoursReplySentAt?: Date | null;
 }
 
 export interface WppContactWithCustomer {
@@ -15,11 +17,13 @@ export interface WppContactWithCustomer {
 	name: string;
 	phone: string;
 	customerId?: number;
+	avatarUrl?: string;
 	instance: string;
 	isBlocked: boolean;
 	isOnlyAdmin: boolean;
 	customer: Customer | null;
 	chatingWith: string | null;
+	lastOutOfHoursReplySentAt?: Date | null;
 }
 
 export interface WppMessage {
@@ -32,6 +36,7 @@ export interface WppMessage {
 	type: string;
 	quotedId?: number | null;
 	chatId?: number | null;
+	userName?: string;
 	contactId?: number | null;
 	body: string;
 	timestamp: string;
@@ -54,6 +59,7 @@ export interface WppChat {
 	instance: string;
 	contactId?: number;
 	userId?: number;
+	userName?: string;
 	walletId?: number;
 	botId?: number;
 	resultId?: number;
@@ -189,4 +195,34 @@ export interface AppNotification {
 export interface PaginatedNotificationsResponse {
   notifications: AppNotification[];
   totalCount: number;
-}
+}
+export interface AutomaticResponseSchedule {
+  id?: number;
+  dayOfWeek: number;
+  startTime: string;
+  endTime: string;
+}
+
+export interface AutomaticResponseRule {
+  id: number;
+  name: string;
+  message: string;
+  isEnabled: boolean;
+  isGlobal: boolean;
+  cooldownSeconds: number;
+  fileId: number | null;
+  schedules: AutomaticResponseSchedule[];
+  userAssignments: { userId: number }[];
+}
+
+export interface AutomaticResponseRuleDTO {
+  name: string;
+  message: string;
+  isEnabled: boolean;
+  isGlobal: boolean;
+  cooldownSeconds: number;
+  fileId?: number | null;
+  userIds: number[];
+  schedules: Omit<AutomaticResponseSchedule, 'id'>[];
+}
+

package/src/whatsapp.client.ts

@@ -3,6 +3,8 @@ import { RequestFilters } from "./types";
 import { DataResponse, MessageResponse } from "./types/response.types";
 import {
 	AppNotification,
+  AutomaticResponseRule,
+  AutomaticResponseRuleDTO,
   CreateScheduleDTO,
   ForwardMessagesData,
   PaginatedNotificationsResponse,
@@ -339,4 +341,26 @@ export default class WhatsappClient extends ApiClient {
     });
     return res.data;
   }
+  public async getAutoResponseRules() {
+    const url = `/api/auto-response-rules`;
+    const { data: res } = await this.ax.get<DataResponse<AutomaticResponseRule[]>>(url);
+    return res.data;
+  }
+
+  public async createAutoResponseRule(ruleData: AutomaticResponseRuleDTO) {
+    const url = `/api/auto-response-rules`;
+    const { data: res } = await this.ax.post<DataResponse<AutomaticResponseRule>>(url, ruleData);
+    return res.data;
+  }
+
+  public async updateAutoResponseRule(id: number, ruleData: Omit<AutomaticResponseRuleDTO, 'instance'>) {
+    const url = `/api/auto-response-rules/${id}`;
+    const { data: res } = await this.ax.put<DataResponse<AutomaticResponseRule>>(url, ruleData);
+    return res.data;
+  }
+
+  public async deleteAutoResponseRule(id: number) {
+    const url = `/api/auto-response-rules/${id}`;
+    await this.ax.delete<MessageResponse>(url);
+  }
 }

package/tsconfig.json

@@ -1,17 +1,17 @@
-{
-	"compilerOptions": {
-		"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
-		"module": "commonjs" /* Specify what module code is generated. */,
-		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
-		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
-		"strict": true /* Enable all strict type-checking options. */,
-		"skipLibCheck": true /* Skip type checking all .d.ts files. */,
-		"noUnusedLocals": false,
-		"outDir": "./dist", /* Redirect output structure to the directory. */
-		"declaration": true
-	},
-	"include": [
-		"src/index.ts",
-		"src/**/*.{ts}"
-	]
+{
+	"compilerOptions": {
+		"target": "es2022" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+		"module": "commonjs" /* Specify what module code is generated. */,
+		"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+		"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+		"strict": true /* Enable all strict type-checking options. */,
+		"skipLibCheck": true /* Skip type checking all .d.ts files. */,
+		"noUnusedLocals": false,
+		"outDir": "./dist", /* Redirect output structure to the directory. */
+		"declaration": true
+	},
+	"include": [
+		"src/index.ts",
+		"src/**/*.{ts}"
+	]
 }