@dawntech/blip-tools 0.6.2 → 0.7.1

package/dist/index.cjs

@@ -418,7 +418,7 @@ class BlipDispatch {
     /**
      * Sends a simple text message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
      */
-    async sendSimpleMessage({ identity, content, metadata }) {
+    async sendSimpleMessage({ identity, content, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
                 id: crypto.randomUUID(),
@@ -793,7 +793,7 @@ class BlipAnalytics {
                 id: crypto.randomUUID(),
                 to: 'postmaster@desk.msging.net',
                 method: 'get',
-                uri: ['/analytics/reports/timings', encodeBlipParams(params)].filter((p) => p).join('?'),
+                uri: createUri('/analytics/reports/timings', params),
             };
             const response = await this.api.post('/commands', body);
             validateResponse(response);
@@ -803,6 +803,59 @@ class BlipAnalytics {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a summary of tickets grouped by tag. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTagReports({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: createUri('/analytics/reports/tags', params),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+class BlipThreads {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    async getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }) {
+        const params = {
+            refreshExpiredMedia: refreshExpiredMedia ? 'true' : 'false',
+            $skip: skip,
+            $take: take,
+            messageId,
+            storageDate,
+            direction,
+            getFromOriginator,
+        };
+        try {
+            const response = await this.api.post('/commands', {
+                id: crypto.randomUUID(),
+                method: 'get',
+                uri: createUri(`/threads/${identity}`, params),
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class Blip {
@@ -820,6 +873,7 @@ class Blip {
     monitoring;
     analytics;
     campaign;
+    threads;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -842,6 +896,7 @@ class Blip {
         this.monitoring = new BlipMonitoring({ api: this.api });
         this.analytics = new BlipAnalytics({ api: this.api });
         this.campaign = new BlipCampaign({ api: this.api });
+        this.threads = new BlipThreads({ api: this.api });
     }
 }
 

package/dist/index.mjs

@@ -416,7 +416,7 @@ class BlipDispatch {
     /**
      * Sends a simple text message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
      */
-    async sendSimpleMessage({ identity, content, metadata }) {
+    async sendSimpleMessage({ identity, content, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
                 id: randomUUID(),
@@ -791,7 +791,7 @@ class BlipAnalytics {
                 id: randomUUID(),
                 to: 'postmaster@desk.msging.net',
                 method: 'get',
-                uri: ['/analytics/reports/timings', encodeBlipParams(params)].filter((p) => p).join('?'),
+                uri: createUri('/analytics/reports/timings', params),
             };
             const response = await this.api.post('/commands', body);
             validateResponse(response);
@@ -801,6 +801,59 @@ class BlipAnalytics {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a summary of tickets grouped by tag. Dates are expected to be in yyyy-mm-dd format.
+     */
+    async getTagReports({ beginDate, endDate } = {}) {
+        try {
+            const params = {
+                beginDate,
+                endDate,
+            };
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: createUri('/analytics/reports/tags', params),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+class BlipThreads {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    async getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }) {
+        const params = {
+            refreshExpiredMedia: refreshExpiredMedia ? 'true' : 'false',
+            $skip: skip,
+            $take: take,
+            messageId,
+            storageDate,
+            direction,
+            getFromOriginator,
+        };
+        try {
+            const response = await this.api.post('/commands', {
+                id: randomUUID(),
+                method: 'get',
+                uri: createUri(`/threads/${identity}`, params),
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class Blip {
@@ -818,6 +871,7 @@ class Blip {
     monitoring;
     analytics;
     campaign;
+    threads;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -840,6 +894,7 @@ class Blip {
         this.monitoring = new BlipMonitoring({ api: this.api });
         this.analytics = new BlipAnalytics({ api: this.api });
         this.campaign = new BlipCampaign({ api: this.api });
+        this.threads = new BlipThreads({ api: this.api });
     }
 }
 

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

@@ -1,5 +1,5 @@
 import { AxiosInstance } from 'axios';
-import { TicketAnalyticsReport, TicketAnalyticsTimings } from '../types/analytics';
+import { TagTicketsSummary, TicketAnalyticsReport, TicketAnalyticsTimings } from '../types/analytics';
 export default class BlipAnalytics {
     private api;
     constructor(context: {
@@ -19,4 +19,11 @@ export default class BlipAnalytics {
         beginDate?: string;
         endDate?: string;
     }): Promise<TicketAnalyticsTimings>;
+    /**
+     * Returns a summary of tickets grouped by tag. Dates are expected to be in yyyy-mm-dd format.
+     */
+    getTagReports({ beginDate, endDate }?: {
+        beginDate?: string;
+        endDate?: string;
+    }): Promise<TagTicketsSummary[]>;
 }

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

@@ -30,15 +30,15 @@ export default class BlipDispatch {
     sendTemplateMessage({ identity, template, metadata, }: {
         identity: string;
         template: Template;
-        metadata?: string;
+        metadata?: Record<string, string>;
     }): Promise<void>;
     /**
      * Sends a simple text message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
      */
-    sendSimpleMessage({ identity, content, metadata }: {
+    sendSimpleMessage({ identity, content, metadata, }: {
         identity: string;
         content: string;
-        metadata?: string;
+        metadata?: Record<string, string>;
     }): Promise<void>;
     /**
      * Sends a text message to an active user with a midia. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
@@ -48,7 +48,7 @@ export default class BlipDispatch {
         uri: string;
         identity: string;
         text: string;
-        metadata?: string;
+        metadata?: Record<string, string>;
         title: string;
         aspectRatio?: string;
         size?: number;
@@ -59,6 +59,6 @@ export default class BlipDispatch {
         identity: string;
         message: string;
         buttons: string[];
-        metadata?: string;
+        metadata?: Record<string, string>;
     }): Promise<void>;
 }

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

@@ -12,6 +12,7 @@ import BlipContact from './blip-contact';
 import BlipMonitoring from './blip-monitoring';
 import BlipAnalytics from './blip-analytics';
 import BlipCampaign from './blip-campaign';
+import BlipThreads from './blip-threads';
 export declare class Blip {
     private api;
     bucket: BlipBucket;
@@ -27,5 +28,6 @@ export declare class Blip {
     monitoring: BlipMonitoring;
     analytics: BlipAnalytics;
     campaign: BlipCampaign;
+    threads: BlipThreads;
     constructor(params: BlipConstructor);
 }

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

@@ -0,0 +1,18 @@
+import { AxiosInstance } from 'axios';
+import { ThreadItem } from '../types/threads';
+export default class BlipThreads {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }: {
+        identity: string;
+        refreshExpiredMedia?: boolean;
+        skip?: number;
+        take?: number;
+        messageId?: string;
+        storageDate?: string;
+        direction?: 'asc' | 'desc';
+        getFromOriginator?: string;
+    }): Promise<ThreadItem[]>;
+}

package/dist/types/analytics.d.ts

@@ -19,3 +19,8 @@ export interface TicketAnalyticsTimings {
     avgResponseTime: string;
     avgAttendanceTime: string;
 }
+export interface TagTicketsSummary {
+    name: string;
+    closedTickets: number;
+    ticketsCount: number;
+}

package/dist/types/threads.d.ts

@@ -0,0 +1,13 @@
+export interface ThreadItem {
+    id: string;
+    direction: string;
+    type: string;
+    content: unknown;
+    date: string;
+    status: string;
+    metadata: Record<string, string>;
+    reason?: {
+        code: number;
+        description: string;
+    };
+}

package/package.json

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