@dawntech/blip-tools 0.1.6 → 0.1.8

package/dist/exceptions/blip-error.d.ts

@@ -1,4 +1,4 @@
 export default class BlipError extends Error {
     code: number;
-    constructor(message: string, code: number);
+    constructor(message: string, code?: number);
 }

package/dist/exceptions/blip-error.js

@@ -1,6 +1,6 @@
 export default class BlipError extends Error {
     code;
-    constructor(message, code) {
+    constructor(message, code = 0) {
         super(message);
         this.code = code;
     }

package/dist/helpers/validate-instance.d.ts

@@ -0,0 +1,2 @@
+import { BlipConstructor } from '../types/blip-constructor.js';
+export default function validateInstance(params: BlipConstructor): void;

package/dist/helpers/validate-instance.js

@@ -0,0 +1,9 @@
+import BlipError from '../exceptions/blip-error.js';
+export default function validateInstance(params) {
+    if (!params.contract) {
+        throw new BlipError('A contract must be specified.');
+    }
+    if (!params.authToken) {
+        throw new BlipError('An authToken must be provided.');
+    }
+}

package/dist/index.d.ts

@@ -1,15 +1,17 @@
 import { AxiosInstance } from 'axios';
 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 };
 export default class Blip {
     api: AxiosInstance;
-    constructor({ contract, authToken }: {
-        contract: string;
-        authToken: string;
-    });
-    sendTemplate({ campaignName, campaignType, masterState, flowId, stateId, channelType, phone, templateName, params, }: {
+    constructor(params: BlipConstructor);
+    /**
+     * Sends a template-based message to any user. For sending messages to clients who are active, use `sendTemplateMessage` instead.
+     */
+    sendIndividualActiveCampaign({ campaignName, masterState, flowId, stateId, channelType, phone, templateName, params, }: {
         campaignName: string;
-        campaignType: string;
         masterState: string;
         flowId: string;
         stateId: string;
@@ -25,10 +27,16 @@ export default class Blip {
     getAvailableContextVariables({ identity }: {
         identity: string;
     }): Promise<Record<string, unknown>>;
+    /**
+     * Sends a template-based message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
+     */
     sendTemplateMessage({ identity, template }: {
         identity: string;
         template: Template;
     }): 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 }: {
         identity: string;
         content: string;
@@ -40,9 +48,16 @@ export default class Blip {
     getContact({ identity }: {
         identity: string;
     }): Promise<Contact>;
-    setVariable({ value, variableName, identity }: {
+    getWhatsAppTemplates(): Promise<Contact>;
+    setContextVariable({ value, variableName, identity, }: {
         variableName: string;
         value: unknown;
         identity: string;
     }): Promise<void>;
+    getWhatsAppIdentity(phone: string): Promise<string>;
+    createTrackEvent({ category, action, identity }: {
+        category: string;
+        action: string;
+        identity?: string;
+    }): Promise<void>;
 }

package/dist/index.js

@@ -3,18 +3,25 @@ import { randomUUID } from 'crypto';
 import validateResponse from './helpers/validate-response.js';
 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';
+export { BlipError };
 export default class Blip {
     api;
-    constructor({ contract, authToken }) {
+    constructor(params) {
+        validateInstance(params);
         this.api = axios.create({
-            baseURL: `https://${contract}.http.msging.net`,
+            baseURL: `https://${params.contract}.http.msging.net`,
             headers: {
-                Authorization: `Key ${authToken}`,
+                Authorization: `Key ${params.authToken}`,
             },
             timeout: 30000,
         });
     }
-    async sendTemplate({ campaignName, campaignType, masterState, flowId, stateId, channelType, phone, templateName, params, }) {
+    /**
+     * 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, }) {
         try {
             const response = await this.api.post('/commands', {
                 id: randomUUID(),
@@ -25,7 +32,7 @@ export default class Blip {
                 resource: {
                     campaign: {
                         name: campaignName,
-                        campaignType,
+                        campaignType: 'Individual',
                         masterState,
                         flowId,
                         stateId,
@@ -78,6 +85,9 @@ export default class Blip {
             throw handleError(error);
         }
     }
+    /**
+     * Sends a template-based message to an active user. For sending messages to clients who have never interacted or are inactive, use `sendTemplate` instead.
+     */
     async sendTemplateMessage({ identity, template }) {
         try {
             const response = await this.api.post('/messages', {
@@ -95,6 +105,9 @@ export default class Blip {
             handleError(error);
         }
     }
+    /**
+     * 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 }) {
         try {
             const response = await this.api.post('/messages', {
@@ -143,13 +156,29 @@ export default class Blip {
             throw handleError(error);
         }
     }
-    async setVariable({ value, variableName, identity }) {
+    async getWhatsAppTemplates() {
         try {
+            const response = await this.api.post('/commands', {
+                id: randomUUID(),
+                to: 'postmaster@wa.gw.msging.net',
+                method: 'get',
+                uri: '/message-templates',
+            });
+            validateResponse(response);
+            return response.data.resource.data;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async setContextVariable({ value, variableName, identity, }) {
+        try {
+            const resourceType = typeof value === 'object' ? 'application/vnd.lime.contact+json' : 'text/plain';
             const response = await this.api.post('/commands', {
                 id: randomUUID(),
                 method: 'set',
                 uri: `/contexts/${identity}/${variableName}`,
-                type: 'application/vnd.lime.contact+json',
+                type: resourceType,
                 resource: value,
             });
             validateResponse(response);
@@ -158,4 +187,42 @@ export default class Blip {
             handleError(error);
         }
     }
+    async getWhatsAppIdentity(phone) {
+        try {
+            const response = await this.api.post('/commands', {
+                id: randomUUID(),
+                to: 'postmaster@wa.gw.msging.net',
+                method: 'get',
+                uri: `lime://wa.gw.msging.net/accounts/+${phone}`,
+            });
+            validateResponse(response);
+            return response.data.resource.identity;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async createTrackEvent({ category, action, identity }) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@analytics.msging.net',
+                method: 'set',
+                type: 'application/vnd.iris.eventTrack+json',
+                uri: '/event-track',
+                resource: {
+                    category,
+                    action,
+                },
+            };
+            if (identity && body.resource) {
+                body.resource.contact = { identity };
+            }
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }

package/package.json

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