@in.pulse-crm/sdk 2.10.7 → 2.11.0

package/src/ready-message.client.ts

@@ -1,72 +1,72 @@
-import ApiClient from "./api-client";
-import { DataResponse } from "./types/response.types";
-import {
-	ReadyMessage,
-} from "./types/ready-messages.types";
-import FormData from "form-data";
-
-export default class ReadyMessageClient extends ApiClient {
-	public async createReadyMessage(
-		File: File | null = null,
-		TITULO: string| null = null,
-		TEXTO_MENSAGEM: string| null = null,
-		SETOR: number | null = null,
-	) {
-		const form = new FormData();
-
-		if (File) {
-			form.append("file", File);
-		}
-
-		form.append(
-			"data",
-			JSON.stringify({ TITULO, TEXTO_MENSAGEM,SETOR }),
-		);
-
-		const { data: res } = await this.ax.post<
-			DataResponse<ReadyMessage>
-		>(`/api/ready-messages`, form, {
-			headers: {
-				"Content-Type": "multipart/form-data",
-			},
-		});
-
-		return res.data;
-	}
-
-	public async deleteReadyMessage(chatId: number) {
-		const url = `/api/ready-messages/${chatId}`;
-		await this.ax.delete<DataResponse<ReadyMessage>>(url);
-	}
-
-	public async getReadyMessages() {
-		const url = `/api/ready-messages`;
-		const { data: res } =
-			await this.ax.get<DataResponse<ReadyMessage[]>>(url);
-
-		return res.data;
-	}
-
-	public async updateReadyMessage(id:number, ReadyMessage: ReadyMessage, file: File) {
-		const formData = new FormData();
-		formData.append("file", file);
-		formData.append(
-			"data",
-			JSON.stringify(ReadyMessage),
-		);
-
-		const { data: res } = await this.ax.put<
-			DataResponse<ReadyMessage>
-		>(`/api/ready-messages/${id}`, formData, {
-			headers: {
-				"Content-Type": "multipart/form-data",
-			},
-		});
-		return res.data;
-	}
-
-	public setAuth(token: string) {
-		this.ax.defaults.headers.common["Authorization"] =
-			`Bearer ${token}`;
-	}
-}
+import ApiClient from "./api-client";
+import { DataResponse } from "./types/response.types";
+import {
+	ReadyMessage,
+} from "./types/ready-messages.types";
+import FormData from "form-data";
+
+export default class ReadyMessageClient extends ApiClient {
+	public async createReadyMessage(
+		File: File | null = null,
+		TITULO: string| null = null,
+		TEXTO_MENSAGEM: string| null = null,
+		SETOR: number | null = null,
+	) {
+		const form = new FormData();
+
+		if (File) {
+			form.append("file", File);
+		}
+
+		form.append(
+			"data",
+			JSON.stringify({ TITULO, TEXTO_MENSAGEM,SETOR }),
+		);
+
+		const { data: res } = await this.ax.post<
+			DataResponse<ReadyMessage>
+		>(`/api/ready-messages`, form, {
+			headers: {
+				"Content-Type": "multipart/form-data",
+			},
+		});
+
+		return res.data;
+	}
+
+	public async deleteReadyMessage(chatId: number) {
+		const url = `/api/ready-messages/${chatId}`;
+		await this.ax.delete<DataResponse<ReadyMessage>>(url);
+	}
+
+	public async getReadyMessages() {
+		const url = `/api/ready-messages`;
+		const { data: res } =
+			await this.ax.get<DataResponse<ReadyMessage[]>>(url);
+
+		return res.data;
+	}
+
+	public async updateReadyMessage(id:number, ReadyMessage: ReadyMessage, file: File) {
+		const formData = new FormData();
+		formData.append("file", file);
+		formData.append(
+			"data",
+			JSON.stringify(ReadyMessage),
+		);
+
+		const { data: res } = await this.ax.put<
+			DataResponse<ReadyMessage>
+		>(`/api/ready-messages/${id}`, formData, {
+			headers: {
+				"Content-Type": "multipart/form-data",
+			},
+		});
+		return res.data;
+	}
+
+	public setAuth(token: string) {
+		this.ax.defaults.headers.common["Authorization"] =
+			`Bearer ${token}`;
+	}
+}

package/src/reports.client.ts

@@ -1,111 +1,111 @@
-import ApiClient from "./api-client";
-import { ChatsReport, ExecuteSqlReportOptions, ExportSqlReportOptions, GenerateChatsReportOptions, SQLReportRow } from "./types/reports.types";
-import { DataResponse, MessageResponse } from "./types/response.types";
-
-/**
- * ReportsClient class to handle reports related API calls.
- *
- * This class extends the ApiClient class and provides methods to interact with the reports API.
- * It includes methods to get, generate, and delete chat reports.
- */
-export default class ReportsClient extends ApiClient {
-	/**
-	 * Retrieves chat reports from the server.
-	 *
-	 * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
-	 */
-	public async getChatsReports() {
-		const url = `/api/reports/chats`;
-		const { data: res } =
-			await this.ax.get<DataResponse<Array<ChatsReport>>>(url);
-
-		return res.data;
-	}
-
-	/**
-	 * Generates a report for chat interactions based on the provided options.
-	 *
-	 * @param body - The options for generating the chats report, including filters and parameters.
-	 * @returns A promise that resolves to the data of the generated chats report.
-	 */
-	public async generateChatsReport(body: GenerateChatsReportOptions) {
-		const url = `/api/reports/chats`;
-		const { data: res } = await this.ax.post<
-			DataResponse<ChatsReport>
-		>(url, body);
-
-		return res.data;
-	}
-
-	/**
-	 * Deletes a chat report by its unique identifier.
-	 *
-	 * @param chatsReportId - The unique identifier of the chat report to be deleted.
-	 */
-	public async deleteChatsReport(chatsReportId: number) {
-		const url = `/api/reports/chats/${chatsReportId}`;
-		await this.ax.delete<MessageResponse>(url);
-	}
-	/**
-	 * Desative a report sql by its unique identifier.
-	 *
-	 * @param reportId - The unique identifier of the chat report to be deleted.
-	 */
-
-	public async deleteHistoryReport(reportId: number) {
-		const url = `/api/reports-history/${reportId}`;
-		await this.ax.delete<MessageResponse>(url);
-	}
-		/**
-	 * Execute a report sql interactions based on the provided options.
-	 *
-	 * @param body - The options for execute the report sql.
-	 * @returns A promise that resolves to the data of the generated chats report.
-	 */
-
-		public async executeSqlReport(body: ExecuteSqlReportOptions) {
-			const url = `/api/execute-report-sql`;
-			const { data: res } = await this.ax.post<DataResponse<SQLReportRow[]>>(url, body);
-			return res.data;
-		}
-
-		/**
-	 * Retrieves chat reports from the server.
-	 *
-	 * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
-	 */
-	public async getSqlReportsHistory() {
-		const url = `/api/reports-history`;
-		const { data: res } =
-			await this.ax.get<DataResponse<Array<any>>>(url);
-
-		return res.data;
-	}
-			/**
-	 * Export a report sql interactions based on the provided options.
-	 *
-	 * @param body - The options for export the report sql.
-	 * @returns A promise that resolves to the data of the generated chats report.
-	 */
-
-		public async exportReportSql(body: ExportSqlReportOptions) {
-			const url = `/api/export-report-sql`;
-			const response = await this.ax.post(url, body, {
-				responseType: 'blob',
-			});
-			return response.data as Blob;
-		}
-
-
-	/**
-	 * Sets the authorization token for the HTTP client.
-	 *
-	 * @param token - The Bearer token to be used for authentication.
-	 *                This token will be included in the `Authorization` header
-	 *                of all HTTP requests made by the client.
-	 */
-	public setAuth(token: string) {
-		this.ax.defaults.headers.common["Authorization"] =
-			`Bearer ${token}`;
-	}
-}
+import ApiClient from "./api-client";
+import { ChatsReport, ExecuteSqlReportOptions, ExportSqlReportOptions, GenerateChatsReportOptions, SQLReportRow } from "./types/reports.types";
+import { DataResponse, MessageResponse } from "./types/response.types";
+
+/**
+ * ReportsClient class to handle reports related API calls.
+ *
+ * This class extends the ApiClient class and provides methods to interact with the reports API.
+ * It includes methods to get, generate, and delete chat reports.
+ */
+export default class ReportsClient extends ApiClient {
+	/**
+	 * Retrieves chat reports from the server.
+	 *
+	 * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+	 */
+	public async getChatsReports() {
+		const url = `/api/reports/chats`;
+		const { data: res } =
+			await this.ax.get<DataResponse<Array<ChatsReport>>>(url);
+
+		return res.data;
+	}
+
+	/**
+	 * Generates a report for chat interactions based on the provided options.
+	 *
+	 * @param body - The options for generating the chats report, including filters and parameters.
+	 * @returns A promise that resolves to the data of the generated chats report.
+	 */
+	public async generateChatsReport(body: GenerateChatsReportOptions) {
+		const url = `/api/reports/chats`;
+		const { data: res } = await this.ax.post<
+			DataResponse<ChatsReport>
+		>(url, body);
+
+		return res.data;
+	}
+
+	/**
+	 * Deletes a chat report by its unique identifier.
+	 *
+	 * @param chatsReportId - The unique identifier of the chat report to be deleted.
+	 */
+	public async deleteChatsReport(chatsReportId: number) {
+		const url = `/api/reports/chats/${chatsReportId}`;
+		await this.ax.delete<MessageResponse>(url);
+	}
+	/**
+	 * Desative a report sql by its unique identifier.
+	 *
+	 * @param reportId - The unique identifier of the chat report to be deleted.
+	 */
+
+	public async deleteHistoryReport(reportId: number) {
+		const url = `/api/reports-history/${reportId}`;
+		await this.ax.delete<MessageResponse>(url);
+	}
+		/**
+	 * Execute a report sql interactions based on the provided options.
+	 *
+	 * @param body - The options for execute the report sql.
+	 * @returns A promise that resolves to the data of the generated chats report.
+	 */
+
+		public async executeSqlReport(body: ExecuteSqlReportOptions) {
+			const url = `/api/execute-report-sql`;
+			const { data: res } = await this.ax.post<DataResponse<SQLReportRow[]>>(url, body);
+			return res.data;
+		}
+
+		/**
+	 * Retrieves chat reports from the server.
+	 *
+	 * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+	 */
+	public async getSqlReportsHistory() {
+		const url = `/api/reports-history`;
+		const { data: res } =
+			await this.ax.get<DataResponse<Array<any>>>(url);
+
+		return res.data;
+	}
+			/**
+	 * Export a report sql interactions based on the provided options.
+	 *
+	 * @param body - The options for export the report sql.
+	 * @returns A promise that resolves to the data of the generated chats report.
+	 */
+
+		public async exportReportSql(body: ExportSqlReportOptions) {
+			const url = `/api/export-report-sql`;
+			const response = await this.ax.post(url, body, {
+				responseType: 'blob',
+			});
+			return response.data as Blob;
+		}
+
+
+	/**
+	 * Sets the authorization token for the HTTP client.
+	 *
+	 * @param token - The Bearer token to be used for authentication.
+	 *                This token will be included in the `Authorization` header
+	 *                of all HTTP requests made by the client.
+	 */
+	public setAuth(token: string) {
+		this.ax.defaults.headers.common["Authorization"] =
+			`Bearer ${token}`;
+	}
+}

package/src/socket-server.client.ts

@@ -1,33 +1,33 @@
-import { EmitSocketEventFn } from "./types/socket-events.types";
-import ApiClient from "./api-client";
-import { MessageResponse } from "./types/response.types";
-
-/**
- * A client for interacting with a socket server API.
- * Extends the `ApiClient` class to provide http functionality
- * 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);
-	}
-
-	/**
-	 * 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);
-	};
-}
+import { EmitSocketEventFn } from "./types/socket-events.types";
+import ApiClient from "./api-client";
+import { MessageResponse } from "./types/response.types";
+
+/**
+ * A client for interacting with a socket server API.
+ * Extends the `ApiClient` class to provide http functionality
+ * 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);
+	}
+
+	/**
+	 * 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/socket.client.ts

@@ -1,91 +1,91 @@
-import { io, Socket } from "socket.io-client";
-import {
-	ListenSocketEventFn,
-	SocketEventType,
-	UnlistenSocketEventFn,
-} from "./types/socket-events.types";
-import { JoinRoomFn } from "./types";
-
-/**
- * A client for interacting with a WebSocket server.
- * This class provides methods to connect to the server, listen for events,
- * and manage WebSocket connections.
- */
-export default class SocketClient {
-	private readonly ws: Socket;
-	private readonly listeners: Map<SocketEventType, any> = new Map();
-
-	/**
-	 * Initializes a new instance of the socket client.
-	 *
-	 * @param baseUrl - The base URL of the WebSocket server to connect to.
-	 *                  This URL is used to establish the WebSocket connection.
-	 *
-	 * The WebSocket client is configured with the following options:
-	 * - `autoConnect`: Disabled by default to allow manual connection control.
-	 * - `transports`: Uses the 'websocket' transport protocol exclusively.
-	 */
-	constructor(baseUrl: string) {
-		this.ws = io(baseUrl, {
-			autoConnect: false,
-			transports: ["websocket"],
-		});
-	}
-
-	/**
-	 * Establishes a WebSocket connection using the provided authentication token.
-	 *
-	 * @param token - The authentication token to be used for the WebSocket connection.
-	 *                This token is sent as part of the WebSocket authentication payload.
-	 */
-	public connect(token: string) {
-		this.ws.auth = { token };
-		this.ws.connect();
-	}
-
-	/**
-	 * Disconnects the WebSocket client from the server.
-	 * This method terminates the current WebSocket connection
-	 * by invoking the `disconnect` method on the WebSocket instance.
-	 */
-	public disconnect() {
-		this.ws.disconnect();
-	}
-
-	/**
-	 * Registers an event listener for a specified WebSocket event and provides a way to remove it.
-	 *
-	 * @param event - The name of the WebSocket event to listen for.
-	 * @param callback - A function to be executed when the event is triggered. The function receives the event data as its argument.
-	 * @returns A function that, when called, removes the event listener for the specified event.
-	 */
-	public on: ListenSocketEventFn = (event, callback) => {
-		const oldListener = this.listeners.get(event);
-		if (oldListener) {
-			this.ws.off(event, oldListener);
-		}
-
-		this.ws.on(event, callback);
-		this.listeners.set(event, callback);
-	};
-
-	/**
-	 * Removes a previously registered event listener from the WebSocket connection.
-	 *
-	 * @param event - The name of the event to stop listening for.
-	 * @param callback - The callback function that was previously registered for the event.
-	 */
-	public off: UnlistenSocketEventFn = (event) => {
-		const listener = this.listeners.get(event);
-		if (!listener) return;
-		this.ws.off(event, listener);
-	};
-
-	public joinRoom: JoinRoomFn = (room) => {
-		this.ws.emit("join-room", room);
-	};
-
-	public leaveRoom: JoinRoomFn = (room) => {
-		this.ws.emit("leave-room", room);
-	};
-}
+import { io, Socket } from "socket.io-client";
+import {
+	ListenSocketEventFn,
+	SocketEventType,
+	UnlistenSocketEventFn,
+} from "./types/socket-events.types";
+import { JoinRoomFn } from "./types";
+
+/**
+ * A client for interacting with a WebSocket server.
+ * This class provides methods to connect to the server, listen for events,
+ * and manage WebSocket connections.
+ */
+export default class SocketClient {
+	private readonly ws: Socket;
+	private readonly listeners: Map<SocketEventType, any> = new Map();
+
+	/**
+	 * Initializes a new instance of the socket client.
+	 *
+	 * @param baseUrl - The base URL of the WebSocket server to connect to.
+	 *                  This URL is used to establish the WebSocket connection.
+	 *
+	 * The WebSocket client is configured with the following options:
+	 * - `autoConnect`: Disabled by default to allow manual connection control.
+	 * - `transports`: Uses the 'websocket' transport protocol exclusively.
+	 */
+	constructor(baseUrl: string) {
+		this.ws = io(baseUrl, {
+			autoConnect: false,
+			transports: ["websocket"],
+		});
+	}
+
+	/**
+	 * Establishes a WebSocket connection using the provided authentication token.
+	 *
+	 * @param token - The authentication token to be used for the WebSocket connection.
+	 *                This token is sent as part of the WebSocket authentication payload.
+	 */
+	public connect(token: string) {
+		this.ws.auth = { token };
+		this.ws.connect();
+	}
+
+	/**
+	 * Disconnects the WebSocket client from the server.
+	 * This method terminates the current WebSocket connection
+	 * by invoking the `disconnect` method on the WebSocket instance.
+	 */
+	public disconnect() {
+		this.ws.disconnect();
+	}
+
+	/**
+	 * Registers an event listener for a specified WebSocket event and provides a way to remove it.
+	 *
+	 * @param event - The name of the WebSocket event to listen for.
+	 * @param callback - A function to be executed when the event is triggered. The function receives the event data as its argument.
+	 * @returns A function that, when called, removes the event listener for the specified event.
+	 */
+	public on: ListenSocketEventFn = (event, callback) => {
+		const oldListener = this.listeners.get(event);
+		if (oldListener) {
+			this.ws.off(event, oldListener);
+		}
+
+		this.ws.on(event, callback);
+		this.listeners.set(event, callback);
+	};
+
+	/**
+	 * Removes a previously registered event listener from the WebSocket connection.
+	 *
+	 * @param event - The name of the event to stop listening for.
+	 * @param callback - The callback function that was previously registered for the event.
+	 */
+	public off: UnlistenSocketEventFn = (event) => {
+		const listener = this.listeners.get(event);
+		if (!listener) return;
+		this.ws.off(event, listener);
+	};
+
+	public joinRoom: JoinRoomFn = (room) => {
+		this.ws.emit("join-room", room);
+	};
+
+	public leaveRoom: JoinRoomFn = (room) => {
+		this.ws.emit("leave-room", room);
+	};
+}