@dawntech/blip-tools 0.5.1 → 0.6.1

package/dist/helpers/create-uri.d.ts

@@ -0,0 +1 @@
+export default function createUri(url: string, params: Record<string, unknown>): string;

package/dist/index.cjs

@@ -493,12 +493,20 @@ class BlipInteraction {
     }
 }
 
+function createUri(url, params) {
+    const encodedParams = encodeBlipParams(params);
+    if (encodedParams) {
+        return `${url}?${encodedParams}`;
+    }
+    return url;
+}
+
 class BlipTicket {
     api;
     constructor(context) {
         this.api = context.api;
     }
-    async search({ filter, skip, take }) {
+    async search({ filter, skip, take } = {}) {
         try {
             const params = {
                 $filter: filter,
@@ -509,7 +517,7 @@ class BlipTicket {
                 id: crypto.randomUUID(),
                 to: 'postmaster@desk.msging.net',
                 method: 'get',
-                uri: `/tickets?${encodeBlipParams(params)}`,
+                uri: createUri('/tickets', params),
             };
             const response = await this.api.post('/commands', body);
             validateResponse(response);
@@ -519,6 +527,22 @@ class BlipTicket {
             throw handleError(error);
         }
     }
+    async getTicket(ticketId) {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/ticket/${ticketId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class BlipWhatsapp {
@@ -631,6 +655,74 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    async getWaitingTicketsMetrics() {
+        try {
+            const response = await this.api.post('/commands', {
+                id: crypto.randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: '/monitoring/waiting-tickets',
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+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 {
@@ -646,6 +738,7 @@ class Blip {
     ticket;
     whatsapp;
     monitoring;
+    analytics;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -666,6 +759,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

@@ -491,12 +491,20 @@ class BlipInteraction {
     }
 }
 
+function createUri(url, params) {
+    const encodedParams = encodeBlipParams(params);
+    if (encodedParams) {
+        return `${url}?${encodedParams}`;
+    }
+    return url;
+}
+
 class BlipTicket {
     api;
     constructor(context) {
         this.api = context.api;
     }
-    async search({ filter, skip, take }) {
+    async search({ filter, skip, take } = {}) {
         try {
             const params = {
                 $filter: filter,
@@ -507,7 +515,7 @@ class BlipTicket {
                 id: randomUUID(),
                 to: 'postmaster@desk.msging.net',
                 method: 'get',
-                uri: `/tickets?${encodeBlipParams(params)}`,
+                uri: createUri('/tickets', params),
             };
             const response = await this.api.post('/commands', body);
             validateResponse(response);
@@ -517,6 +525,22 @@ class BlipTicket {
             throw handleError(error);
         }
     }
+    async getTicket(ticketId) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/ticket/${ticketId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class BlipWhatsapp {
@@ -629,6 +653,74 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    async getWaitingTicketsMetrics() {
+        try {
+            const response = await this.api.post('/commands', {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: '/monitoring/waiting-tickets',
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+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 {
@@ -644,6 +736,7 @@ class Blip {
     ticket;
     whatsapp;
     monitoring;
+    analytics;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -664,6 +757,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

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { MonitoredAttendantStatusMetrics, MonitoredTicketMetrics, MonitoredTickets } from '../types/monitoring';
+import { MonitoredAttendantStatusMetrics, MonitoredTicketMetrics, MonitoredTickets, MonitoredWaitingTicketsMetrics } from '../types/monitoring';
 export default class BlipMonitoring {
     private api;
     constructor(context: {
@@ -8,4 +8,5 @@ export default class BlipMonitoring {
     getTickets(): Promise<MonitoredTickets>;
     getTicketMetrics(): Promise<MonitoredTicketMetrics>;
     getAttendantStatusMetrics(): Promise<MonitoredAttendantStatusMetrics>;
+    getWaitingTicketsMetrics(): Promise<MonitoredWaitingTicketsMetrics[]>;
 }

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

@@ -1,12 +1,14 @@
 import { AxiosInstance } from 'axios';
+import { TicketSearchResult } from '../types/ticket-search-result';
 export default class BlipTicket {
     private api;
     constructor(context: {
         api: AxiosInstance;
     });
-    search({ filter, skip, take }: {
+    search({ filter, skip, take }?: {
         filter?: string;
         skip?: number;
         take?: number;
-    }): Promise<import("../types").Ticket[]>;
+    }): Promise<import("../types/ticket-search-result").Ticket[]>;
+    getTicket(ticketId: string): Promise<TicketSearchResult>;
 }

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/dist/types/monitoring.d.ts

@@ -25,3 +25,12 @@ export interface MonitoredAttendantStatusMetrics {
     invisible: number;
     offline: number;
 }
+export interface MonitoredWaitingTicketsMetrics {
+    id: string;
+    sequentialId: number;
+    customerIdentity: string;
+    customerName: string;
+    team: string;
+    queueTime: string;
+    priority: number;
+}

package/dist/types/ticket-search-result.d.ts

@@ -1,6 +1,21 @@
-import { Ticket } from './ticket';
 export interface TicketSearchResult {
     total: number;
     itemType: string;
     items: Ticket[];
 }
+export interface Ticket {
+    closed: boolean;
+    customerDomain: string;
+    customerIdentity: string;
+    externalId: string;
+    id: string;
+    ownerIdentity: string;
+    priority: number;
+    provider: string;
+    rating: number;
+    sequentialId: number;
+    status: string;
+    storageDate: string;
+    team: string;
+    unreadMessages: number;
+}

package/package.json

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