@dawntech/blip-tools 0.5.0 → 0.6.0

package/dist/index.cjs

@@ -633,6 +633,59 @@ class BlipMonitoring {
     }
 }
 
+class BlipAnalytics {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns a list of reports by day with tickets status. Ommiting dates will return only the last report. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTicketReports({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/analytics/reports/tickets?${encodeBlipParams(params)}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    /**
+     * Returns ticket timings metrics. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTicketTimings({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: ['/analytics/reports/timings', encodeBlipParams(params)].filter((p) => p).join('?'),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
 class Blip {
     api;
     bucket;
@@ -646,6 +699,7 @@ class Blip {
     ticket;
     whatsapp;
     monitoring;
+    analytics;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -666,6 +720,7 @@ class Blip {
         this.ticket = new BlipTicket({ api: this.api });
         this.whatsapp = new BlipWhatsapp({ api: this.api });
         this.monitoring = new BlipMonitoring({ api: this.api });
+        this.analytics = new BlipAnalytics({ api: this.api });
     }
 }
 

package/dist/index.mjs

@@ -631,6 +631,59 @@ class BlipMonitoring {
     }
 }
 
+class BlipAnalytics {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns a list of reports by day with tickets status. Ommiting dates will return only the last report. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTicketReports({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/analytics/reports/tickets?${encodeBlipParams(params)}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    /**
+     * Returns ticket timings metrics. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTicketTimings({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: ['/analytics/reports/timings', encodeBlipParams(params)].filter((p) => p).join('?'),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
 class Blip {
     api;
     bucket;
@@ -644,6 +697,7 @@ class Blip {
     ticket;
     whatsapp;
     monitoring;
+    analytics;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -664,6 +718,7 @@ class Blip {
         this.ticket = new BlipTicket({ api: this.api });
         this.whatsapp = new BlipWhatsapp({ api: this.api });
         this.monitoring = new BlipMonitoring({ api: this.api });
+        this.analytics = new BlipAnalytics({ api: this.api });
     }
 }
 

package/dist/modules/blip-analytics.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from 'axios';
+import { TicketAnalyticsReport, TicketAnalyticsTimings } from '../types/analytics';
+export default class BlipAnalytics {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    /**
+     * Returns a list of reports by day with tickets status. Ommiting dates will return only the last report. Dates are expected to be in yyyy-mm-dd format.
+     */
+    getTicketReports({ beginDate, endDate }?: {
+        beginDate?: string;
+        endDate?: string;
+    }): Promise<TicketAnalyticsReport[]>;
+    /**
+     * Returns ticket timings metrics. Dates are expected to be in yyyy-mm-dd format.
+     */
+    getTicketTimings({ beginDate, endDate }?: {
+        beginDate?: string;
+        endDate?: string;
+    }): Promise<TicketAnalyticsTimings>;
+}

package/dist/modules/blip-main.d.ts

@@ -10,6 +10,7 @@ import BlipTicket from './blip-ticket';
 import BlipWhatsapp from './blip-whatsapp';
 import BlipContact from './blip-contact';
 import BlipMonitoring from './blip-monitoring';
+import BlipAnalytics from './blip-analytics';
 export declare class Blip {
     private api;
     bucket: BlipBucket;
@@ -23,5 +24,6 @@ export declare class Blip {
     ticket: BlipTicket;
     whatsapp: BlipWhatsapp;
     monitoring: BlipMonitoring;
+    analytics: BlipAnalytics;
     constructor(params: BlipConstructor);
 }

package/dist/modules/blip-monitoring.d.ts

@@ -5,7 +5,7 @@ export default class BlipMonitoring {
     constructor(context: {
         api: AxiosInstance;
     });
-    getTickets(): Promise<MonitoredTickets[]>;
-    getTicketMetrics(): Promise<MonitoredTicketMetrics[]>;
-    getAttendantStatusMetrics(): Promise<MonitoredAttendantStatusMetrics[]>;
+    getTickets(): Promise<MonitoredTickets>;
+    getTicketMetrics(): Promise<MonitoredTicketMetrics>;
+    getAttendantStatusMetrics(): Promise<MonitoredAttendantStatusMetrics>;
 }

package/dist/types/analytics.d.ts

@@ -0,0 +1,21 @@
+export interface TicketAnalyticsReport {
+    date: string;
+    waiting: number;
+    open: number;
+    closed: number;
+    closedAttendant: number;
+    closedClient: number;
+    transferred: number;
+    missed: number;
+    inAttendance: number;
+}
+export interface TicketAnalyticsTimings {
+    maxQueueTime: string;
+    maxFirstResponseTime: string;
+    maxWithoutFirstResponseTime: string;
+    avgQueueTime: string;
+    avgFirstResponseTime: string;
+    avgWaitTime: string;
+    avgResponseTime: string;
+    avgAttendanceTime: string;
+}

package/dist/types/index.d.ts

@@ -4,4 +4,6 @@ import { BlipRequestBody, BlipResponse, BlipArrayBody } from './blip';
 import { Parameter, Component, Template } from './template';
 import { TicketSearchResult } from './ticket-search-result';
 import { Ticket } from './ticket';
-export { AttendanceHourContainer, BlipConstructor, BlipRequestBody, BlipResponse, BlipArrayBody, Parameter, Component, Template, TicketSearchResult, Ticket, };
+import { MonitoredTickets, MonitoredTicketMetrics, MonitoredAttendantStatusMetrics } from './monitoring';
+import { TicketAnalyticsReport, TicketAnalyticsTimings } from './analytics';
+export { AttendanceHourContainer, BlipConstructor, BlipRequestBody, BlipResponse, BlipArrayBody, Parameter, Component, Template, TicketAnalyticsReport, MonitoredTickets, MonitoredTicketMetrics, MonitoredAttendantStatusMetrics, TicketSearchResult, TicketAnalyticsTimings, Ticket, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawntech/blip-tools",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Node package for Blip API",
   "exports": {
     ".": {