@in.pulse-crm/sdk 2.7.5 → 2.7.7

package/dist/reports.client.d.ts

@@ -1,5 +1,5 @@
 import ApiClient from "./api-client";
-import { ChatsReport, GenerateChatsReportOptions } from "./types/reports.types";
+import { ChatsReport, ExecuteSqlReportOptions, ExportSqlReportOptions, GenerateChatsReportOptions, SQLReportRow } from "./types/reports.types";
 /**
  * ReportsClient class to handle reports related API calls.
  *
@@ -26,6 +26,32 @@ export default class ReportsClient extends ApiClient {
      * @param chatsReportId - The unique identifier of the chat report to be deleted.
      */
     deleteChatsReport(chatsReportId: number): Promise<void>;
+    /**
+     * Desative a report sql by its unique identifier.
+     *
+     * @param reportId - The unique identifier of the chat report to be deleted.
+     */
+    deleteHistoryReport(reportId: number): Promise<void>;
+    /**
+ * 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.
+ */
+    executeSqlReport(body: ExecuteSqlReportOptions): Promise<SQLReportRow[]>;
+    /**
+ * Retrieves chat reports from the server.
+ *
+ * @returns A promise that resolves to an array of chat reports wrapped in a `DataResponse` object.
+ */
+    getSqlReportsHistory(): Promise<any[]>;
+    /**
+* 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.
+*/
+    exportReportSql(body: ExportSqlReportOptions): Promise<Blob>;
     /**
      * Sets the authorization token for the HTTP client.
      *

package/dist/reports.client.js

@@ -41,6 +41,49 @@ class ReportsClient extends api_client_1.default {
         const url = `/api/reports/chats/${chatsReportId}`;
         await this.httpClient.delete(url);
     }
+    /**
+     * Desative a report sql by its unique identifier.
+     *
+     * @param reportId - The unique identifier of the chat report to be deleted.
+     */
+    async deleteHistoryReport(reportId) {
+        const url = `/api/reports-history/${reportId}`;
+        await this.httpClient.delete(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.
+ */
+    async executeSqlReport(body) {
+        const url = `/api/execute-report-sql`;
+        const { data: res } = await this.httpClient.post(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.
+ */
+    async getSqlReportsHistory() {
+        const url = `/api/reports-history`;
+        const { data: res } = await this.httpClient.get(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.
+*/
+    async exportReportSql(body) {
+        const url = `/api/export-report-sql`;
+        const response = await this.httpClient.post(url, body, {
+            responseType: 'blob',
+        });
+        return response.data;
+    }
     /**
      * Sets the authorization token for the HTTP client.
      *

package/dist/types/reports.types.d.ts

@@ -20,3 +20,23 @@ export interface GenerateChatsReportOptions {
     startDate: string;
     endDate: string;
 }
+export interface SQLReportColumn {
+    name: string;
+    type: string;
+}
+export type SQLReportRow = Record<string, any>;
+export interface SqlReport {
+    id: string;
+    description: string;
+    sql: string;
+    createdAt: string;
+    status: "pending" | "completed" | "failed";
+    resultUrl?: string;
+}
+export interface ExecuteSqlReportOptions {
+    sql: string;
+    description?: string;
+}
+export interface ExportSqlReportOptions extends ExecuteSqlReportOptions {
+    format: ChatsReportFormat;
+}

package/package.json

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

package/src/reports.client.ts

@@ -1,5 +1,5 @@
 import ApiClient from "./api-client";
-import { ChatsReport, GenerateChatsReportOptions } from "./types/reports.types";
+import { ChatsReport, ExecuteSqlReportOptions, ExportSqlReportOptions, GenerateChatsReportOptions, SQLReportRow } from "./types/reports.types";
 import { DataResponse, MessageResponse } from "./types/response.types";
 
 /**
@@ -46,6 +46,56 @@ export default class ReportsClient extends ApiClient {
 		const url = `/api/reports/chats/${chatsReportId}`;
 		await this.httpClient.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.httpClient.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.httpClient.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.httpClient.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.httpClient.post(url, body, {
+				responseType: 'blob',
+			});
+			return response.data as Blob;
+		}
+
 
 	/**
 	 * Sets the authorization token for the HTTP client.

package/src/types/reports.types.ts

@@ -21,4 +21,29 @@ export interface GenerateChatsReportOptions {
     format: ChatsReportFormat;
     startDate: string;
     endDate: string;
-}
+}
+
+export interface SQLReportColumn {
+  name: string;
+  type: string;
+}
+
+export type SQLReportRow = Record<string, any>;
+
+export interface SqlReport {
+  id: string;
+  description: string;
+  sql: string;
+  createdAt: string;
+  status: "pending" | "completed" | "failed";
+  resultUrl?: string;
+}
+
+export interface ExecuteSqlReportOptions {
+  sql: string;
+  description?: string;
+}
+
+export interface ExportSqlReportOptions extends ExecuteSqlReportOptions {
+	format: ChatsReportFormat;
+}