@dawntech/blip-tools 0.1.8 → 0.1.10

package/dist/helpers/encode-blip-params.d.ts

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

package/dist/helpers/encode-blip-params.js

@@ -0,0 +1,13 @@
+function normalizeValue(value) {
+    return String(value).replaceAll(' ', '%20');
+}
+export default function encodeBlipParams(params) {
+    //This function does not uses any of the standard methods of URI parsing because Blip does not follow any of them
+    const parsedParams = [];
+    for (const [key, value] of Object.entries(params)) {
+        if (value && key) {
+            parsedParams.push(`${normalizeValue(key)}=${normalizeValue(value)}`);
+        }
+    }
+    return parsedParams.join('&');
+}

package/dist/index.d.ts

@@ -3,7 +3,11 @@ import { Template } from './types/template.js';
 import { Contact } from './types/contact.js';
 import { BlipConstructor } from './types/blip-constructor.js';
 import BlipError from './exceptions/blip-error.js';
-export { BlipError };
+import { AttendanceHourContainer } from './types/attendance-hour-container.js';
+import { Ticket } from './types/ticket.js';
+import { CampaignNotification } from './types/campaign-notification.js';
+import { CampaignNotificationStatus } from './types/campaign-notification-status.js';
+export { BlipError, type Ticket, type AttendanceHourContainer, type Contact, type Template };
 export default class Blip {
     api: AxiosInstance;
     constructor(params: BlipConstructor);
@@ -19,7 +23,10 @@ export default class Blip {
         phone: string;
         templateName: string;
         params: string[];
-    }): Promise<void>;
+    }): Promise<CampaignNotification>;
+    getCampaignNotificationStatus({ campaignNotificationId }: {
+        campaignNotificationId: string;
+    }): Promise<CampaignNotificationStatus[]>;
     getContextVariable({ identity, variableName }: {
         identity: string;
         variableName: string;
@@ -48,7 +55,7 @@ export default class Blip {
     getContact({ identity }: {
         identity: string;
     }): Promise<Contact>;
-    getWhatsAppTemplates(): Promise<Contact>;
+    getWhatsAppTemplates(): Promise<Template[]>;
     setContextVariable({ value, variableName, identity, }: {
         variableName: string;
         value: unknown;
@@ -60,4 +67,12 @@ export default class Blip {
         action: string;
         identity?: string;
     }): Promise<void>;
+    getAttendanceHourContainer({ attendanceContainerId }: {
+        attendanceContainerId: string;
+    }): Promise<AttendanceHourContainer>;
+    searchTickets({ filter, skip, take }: {
+        filter?: string;
+        skip?: number;
+        take?: number;
+    }): Promise<Ticket[]>;
 }

package/dist/index.js

@@ -5,6 +5,7 @@ import handleError from './helpers/handle-error.js';
 import formatTemplateParams from './helpers/format-template-params.js';
 import validateInstance from './helpers/validate-instance.js';
 import BlipError from './exceptions/blip-error.js';
+import encodeBlipParams from './helpers/encode-blip-params.js';
 export { BlipError };
 export default class Blip {
     api;
@@ -13,7 +14,7 @@ export default class Blip {
         this.api = axios.create({
             baseURL: `https://${params.contract}.http.msging.net`,
             headers: {
-                Authorization: `Key ${params.authToken}`,
+                Authorization: `Key ${params.authToken.replace('Key ', '')}`,
             },
             timeout: 30000,
         });
@@ -21,38 +22,57 @@ export default class Blip {
     /**
      * Sends a template-based message to any user. For sending messages to clients who are active, use `sendTemplateMessage` instead.
      */
-    async sendIndividualActiveCampaign({ campaignName, masterState, flowId, stateId, channelType, phone, templateName, params, }) {
+    async sendIndividualActiveCampaign({ campaignName, masterState, flowId, stateId, channelType, phone, templateName, params = [], }) {
+        const body = {
+            id: randomUUID(),
+            to: 'postmaster@activecampaign.msging.net',
+            method: 'set',
+            uri: '/campaign/full',
+            type: 'application/vnd.iris.activecampaign.full-campaign+json',
+            resource: {
+                campaign: {
+                    name: campaignName,
+                    campaignType: 'Individual',
+                    masterState,
+                    flowId,
+                    stateId,
+                    channelType,
+                },
+                audience: {
+                    recipient: `+${phone}`,
+                },
+                message: {
+                    messageTemplate: templateName,
+                    channelType,
+                },
+            },
+        };
+        if (params.length > 0) {
+            body.resource.audience.messageParams = formatTemplateParams(params);
+            body.resource.message.messageParams = params.map((_param, index) => String(index + 1));
+        }
+        try {
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async getCampaignNotificationStatus({ campaignNotificationId }) {
         try {
             const response = await this.api.post('/commands', {
                 id: randomUUID(),
-                to: 'postmaster@activecampaign.msging.net',
-                method: 'set',
-                uri: '/campaign/full',
-                type: 'application/vnd.iris.activecampaign.full-campaign+json',
-                resource: {
-                    campaign: {
-                        name: campaignName,
-                        campaignType: 'Individual',
-                        masterState,
-                        flowId,
-                        stateId,
-                        channelType,
-                    },
-                    audience: {
-                        recipient: `+${phone}`,
-                        messageParams: formatTemplateParams(params),
-                    },
-                    message: {
-                        messageTemplate: templateName,
-                        messageParams: params.map((_param, index) => String(index + 1)),
-                        channelType,
-                    },
-                },
+                to: 'postmaster@msging.net',
+                method: 'get',
+                uri: `/notifications?id=${campaignNotificationId}`,
             });
             validateResponse(response);
+            return response.data.resource.items;
         }
         catch (error) {
-            handleError(error);
+            throw handleError(error);
         }
     }
     async getContextVariable({ identity, variableName }) {
@@ -225,4 +245,41 @@ export default class Blip {
             throw handleError(error);
         }
     }
+    async getAttendanceHourContainer({ attendanceContainerId }) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/attendance-hour-container/${attendanceContainerId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async searchTickets({ filter, skip, take }) {
+        try {
+            const params = {
+                $filter: filter,
+                $skip: skip,
+                $take: take,
+            };
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@desk.msging.net',
+                method: 'get',
+                uri: `/tickets?${encodeBlipParams(params)}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dawntech/blip-tools",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Node package for Blip API",
   "main": "dist/index.js",
   "module": "dist/index.js",