@dawntech/blip-tools 0.6.1 → 0.7.0

package/dist/exceptions/index.d.ts

@@ -1,5 +1,2 @@
 import BlipError from './blip-error';
-declare const _default: {
-    BlipError: typeof BlipError;
-};
-export default _default;
+export { BlipError };

package/dist/index.cjs

@@ -40,7 +40,6 @@ function handleError(error) {
         if (error.response?.data.code) {
             throw new BlipError(error.response?.data.description, error.response?.data.code);
         }
-        throw new BlipError(error.message, 0);
     }
     throw error;
 }
@@ -204,6 +203,14 @@ class BlipAttendance {
     }
 }
 
+function createUri(url, params) {
+    const encodedParams = encodeBlipParams(params);
+    if (encodedParams) {
+        return `${url}?${encodedParams}`;
+    }
+    return url;
+}
+
 class BlipContact {
     api;
     constructor(context) {
@@ -243,6 +250,26 @@ class BlipContact {
             throw handleError(error);
         }
     }
+    async search({ filter, skip, take } = {}) {
+        const params = {
+            $filter: filter,
+            $skip: skip,
+            $take: take,
+        };
+        try {
+            const response = await this.api.post('/commands', {
+                id: crypto.randomUUID(),
+                to: 'postmaster@crm.msging.net',
+                method: 'get',
+                uri: createUri('/contacts', params),
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class BlipContext {
@@ -313,7 +340,7 @@ class BlipDispatch {
     /**
      * 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 = [], scheduled, }) {
         const body = {
             id: crypto.randomUUID(),
             to: 'postmaster@activecampaign.msging.net',
@@ -328,9 +355,10 @@ class BlipDispatch {
                     flowId,
                     stateId,
                     channelType,
+                    scheduled: scheduled?.toISOString(),
                 },
                 audience: {
-                    recipient: `+${phone}`,
+                    recipient: `+${phone.replace('+', '')}`,
                 },
                 message: {
                     messageTemplate: templateName,
@@ -390,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(),
@@ -493,14 +521,6 @@ class BlipInteraction {
     }
 }
 
-function createUri(url, params) {
-    const encodedParams = encodeBlipParams(params);
-    if (encodedParams) {
-        return `${url}?${encodedParams}`;
-    }
-    return url;
-}
-
 class BlipTicket {
     api;
     constructor(context) {
@@ -582,10 +602,70 @@ class BlipWhatsapp {
     }
 }
 
-var index = /*#__PURE__*/Object.freeze({
+class BlipCampaign {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    async search({ filter, skip, take } = {}) {
+        try {
+            const params = {
+                $filter: filter,
+                $skip: skip,
+                $take: take,
+            };
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'get',
+                uri: createUri('/campaigns', params),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async get(campaignId) {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'get',
+                uri: `/campaigns/${campaignId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async deleteCampaign(campaignId) {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'delete',
+                uri: `/campaigns/${campaignId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+var index$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     BlipAttendance: BlipAttendance,
     BlipBucket: BlipBucket,
+    BlipCampaign: BlipCampaign,
     BlipContact: BlipContact,
     BlipContext: BlipContext,
     BlipDispatch: BlipDispatch,
@@ -725,6 +805,36 @@ class BlipAnalytics {
     }
 }
 
+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 {
     api;
     bucket;
@@ -739,6 +849,8 @@ class Blip {
     whatsapp;
     monitoring;
     analytics;
+    campaign;
+    threads;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -760,8 +872,16 @@ class Blip {
         this.whatsapp = new BlipWhatsapp({ api: this.api });
         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 });
     }
 }
 
+var index = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    BlipError: BlipError
+});
+
 exports.Blip = Blip;
-exports.Modules = index;
+exports.Exceptions = index;
+exports.Modules = index$1;

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import * as Modules from './modules/index';
 import type * as Types from './types/index';
 import { Blip } from './modules/blip-main';
-export { Types, Blip, Modules };
+import * as Exceptions from './exceptions';
+export { Types, Blip, Modules, Exceptions };

package/dist/index.mjs

@@ -38,7 +38,6 @@ function handleError(error) {
         if (error.response?.data.code) {
             throw new BlipError(error.response?.data.description, error.response?.data.code);
         }
-        throw new BlipError(error.message, 0);
     }
     throw error;
 }
@@ -202,6 +201,14 @@ class BlipAttendance {
     }
 }
 
+function createUri(url, params) {
+    const encodedParams = encodeBlipParams(params);
+    if (encodedParams) {
+        return `${url}?${encodedParams}`;
+    }
+    return url;
+}
+
 class BlipContact {
     api;
     constructor(context) {
@@ -241,6 +248,26 @@ class BlipContact {
             throw handleError(error);
         }
     }
+    async search({ filter, skip, take } = {}) {
+        const params = {
+            $filter: filter,
+            $skip: skip,
+            $take: take,
+        };
+        try {
+            const response = await this.api.post('/commands', {
+                id: randomUUID(),
+                to: 'postmaster@crm.msging.net',
+                method: 'get',
+                uri: createUri('/contacts', params),
+            });
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
 }
 
 class BlipContext {
@@ -311,7 +338,7 @@ class BlipDispatch {
     /**
      * 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 = [], scheduled, }) {
         const body = {
             id: randomUUID(),
             to: 'postmaster@activecampaign.msging.net',
@@ -326,9 +353,10 @@ class BlipDispatch {
                     flowId,
                     stateId,
                     channelType,
+                    scheduled: scheduled?.toISOString(),
                 },
                 audience: {
-                    recipient: `+${phone}`,
+                    recipient: `+${phone.replace('+', '')}`,
                 },
                 message: {
                     messageTemplate: templateName,
@@ -388,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(),
@@ -491,14 +519,6 @@ class BlipInteraction {
     }
 }
 
-function createUri(url, params) {
-    const encodedParams = encodeBlipParams(params);
-    if (encodedParams) {
-        return `${url}?${encodedParams}`;
-    }
-    return url;
-}
-
 class BlipTicket {
     api;
     constructor(context) {
@@ -580,10 +600,70 @@ class BlipWhatsapp {
     }
 }
 
-var index = /*#__PURE__*/Object.freeze({
+class BlipCampaign {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    async search({ filter, skip, take } = {}) {
+        try {
+            const params = {
+                $filter: filter,
+                $skip: skip,
+                $take: take,
+            };
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'get',
+                uri: createUri('/campaigns', params),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async get(campaignId) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'get',
+                uri: `/campaigns/${campaignId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    async deleteCampaign(campaignId) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@activecampaign.msging.net',
+                method: 'delete',
+                uri: `/campaigns/${campaignId}`,
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+var index$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
     BlipAttendance: BlipAttendance,
     BlipBucket: BlipBucket,
+    BlipCampaign: BlipCampaign,
     BlipContact: BlipContact,
     BlipContext: BlipContext,
     BlipDispatch: BlipDispatch,
@@ -723,6 +803,36 @@ class BlipAnalytics {
     }
 }
 
+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 {
     api;
     bucket;
@@ -737,6 +847,8 @@ class Blip {
     whatsapp;
     monitoring;
     analytics;
+    campaign;
+    threads;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -758,7 +870,14 @@ class Blip {
         this.whatsapp = new BlipWhatsapp({ api: this.api });
         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 });
     }
 }
 
-export { Blip, index as Modules };
+var index = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    BlipError: BlipError
+});
+
+export { Blip, index as Exceptions, index$1 as Modules };

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

@@ -0,0 +1,15 @@
+import { AxiosInstance } from 'axios';
+import { Campaign } from '../types';
+export default class BlipCampaign {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    search({ filter, skip, take }?: {
+        filter?: string;
+        skip?: number;
+        take?: number;
+    }): Promise<Campaign[]>;
+    get(campaignId: string): Promise<Campaign>;
+    deleteCampaign(campaignId: string): Promise<void>;
+}

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

@@ -12,4 +12,9 @@ export default class BlipContact {
     get({ identity }: {
         identity: string;
     }): Promise<Contact>;
+    search({ filter, skip, take }?: {
+        filter?: string;
+        skip?: number;
+        take?: number;
+    }): Promise<Contact[]>;
 }

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

@@ -10,15 +10,16 @@ export default class BlipDispatch {
     /**
      * 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, }: {
+    sendIndividualActiveCampaign({ campaignName, masterState, flowId, stateId, channelType, phone, templateName, params, scheduled, }: {
         campaignName: string;
         masterState: string;
         flowId: string;
         stateId: string;
-        channelType: string;
+        channelType: 'whatsapp' | string;
         phone: string;
         templateName: string;
-        params: string[];
+        params?: string[];
+        scheduled?: Date;
     }): Promise<CampaignNotification>;
     getCampaignNotificationStatus({ campaignNotificationId }: {
         campaignNotificationId: string;
@@ -29,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.
@@ -47,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;
@@ -58,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

@@ -11,6 +11,8 @@ import BlipWhatsapp from './blip-whatsapp';
 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;
@@ -25,5 +27,7 @@ export declare class Blip {
     whatsapp: BlipWhatsapp;
     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/modules/blip-ticket.d.ts

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

package/dist/modules/index.d.ts

@@ -8,4 +8,5 @@ import BlipEvent from './blip-event';
 import BlipInteraction from './blip-interaction';
 import BlipTicket from './blip-ticket';
 import BlipWhatsapp from './blip-whatsapp';
-export { BlipMedia, BlipBucket, BlipAttendance, BlipContact, BlipContext, BlipDispatch, BlipEvent, BlipInteraction, BlipTicket, BlipWhatsapp, };
+import BlipCampaign from './blip-campaign';
+export { BlipMedia, BlipBucket, BlipAttendance, BlipContact, BlipContext, BlipDispatch, BlipEvent, BlipInteraction, BlipTicket, BlipWhatsapp, BlipCampaign, };

package/dist/types/campaign.d.ts

@@ -0,0 +1,14 @@
+export interface Campaign {
+    id: string;
+    name: string;
+    campaignType: string;
+    masterState: string;
+    flowId: string;
+    stateId: string;
+    status: string;
+    created: string;
+    scheduled: string;
+    isToUseLiteApi: boolean;
+    channelType: string;
+    canSendWithOpenTicket: boolean;
+}

package/dist/types/campaing-request.d.ts

@@ -12,6 +12,7 @@ export interface CampaignRequestBody {
             flowId: string;
             stateId: string;
             channelType: string;
+            scheduled?: string;
         };
         audience: {
             recipient: string;

package/dist/types/contact.d.ts

@@ -5,4 +5,6 @@ export interface Contact {
     phoneNumber: string;
     extras: Record<string, string>;
     source: string;
+    group?: string;
+    email?: string;
 }

package/dist/types/index.d.ts

@@ -2,8 +2,9 @@ import { AttendanceHourContainer } from './attendance-hour-container';
 import { BlipConstructor } from './blip-constructor';
 import { BlipRequestBody, BlipResponse, BlipArrayBody } from './blip';
 import { Parameter, Component, Template } from './template';
-import { TicketSearchResult } from './ticket-search-result';
 import { Ticket } from './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, };
+import { Campaign } from './campaign';
+import { Contact } from './contact';
+export { AttendanceHourContainer, BlipConstructor, BlipRequestBody, BlipResponse, BlipArrayBody, Parameter, Component, Template, TicketAnalyticsReport, MonitoredTickets, MonitoredTicketMetrics, MonitoredAttendantStatusMetrics, TicketAnalyticsTimings, Ticket, Campaign, Contact, };

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.1",
+  "version": "0.7.0",
   "description": "Node package for Blip API",
   "exports": {
     ".": {

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

@@ -1,21 +0,0 @@
-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;
-}