@dawntech/blip-tools 0.7.1 → 0.7.2

package/dist/index.cjs

@@ -93,6 +93,9 @@ class BlipBucket {
             throw handleError(error);
         }
     }
+    /**
+     * Returns all document ids stored in the Blip bucket.
+     */
     async getAllContentIdsFromBucket() {
         try {
             const body = {
@@ -185,6 +188,9 @@ class BlipAttendance {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the attendance hour container for the given id.
+     */
     async getAttendanceHourContainer({ attendanceContainerId }) {
         try {
             const body = {
@@ -216,6 +222,9 @@ class BlipContact {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Merges the provided fields into the contact identified by `identity`.
+     */
     async update({ identity, contactData }) {
         try {
             const response = await this.api.post('/commands', {
@@ -235,6 +244,9 @@ class BlipContact {
             handleError(error);
         }
     }
+    /**
+     * Returns the contact for the given identity.
+     */
     async get({ identity }) {
         try {
             const response = await this.api.post('/commands', {
@@ -250,6 +262,9 @@ class BlipContact {
             throw handleError(error);
         }
     }
+    /**
+     * Searches contacts. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         const params = {
             $filter: filter,
@@ -277,6 +292,9 @@ class BlipContext {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the value of a context variable for the given identity.
+     */
     async getContextVariable({ identity, variableName }) {
         try {
             const response = await this.api.post('/commands', {
@@ -292,6 +310,9 @@ class BlipContext {
             throw handleError(error);
         }
     }
+    /**
+     * Returns all available context variables for the given identity.
+     */
     async getAvailableContextVariables({ identity }) {
         try {
             const response = await this.api.post('/commands', {
@@ -307,6 +328,9 @@ class BlipContext {
             throw handleError(error);
         }
     }
+    /**
+     * Sets a context variable for the given identity. Object values are stored as JSON, primitive values as plain text.
+     */
     async setContextVariable({ value, variableName, identity, }) {
         try {
             const resourceType = typeof value === 'object' ? 'application/vnd.lime.contact+json' : 'text/plain';
@@ -379,6 +403,9 @@ class BlipDispatch {
             throw handleError(error);
         }
     }
+    /**
+     * Returns the delivery status entries of a campaign notification by id.
+     */
     async getCampaignNotificationStatus({ campaignNotificationId }) {
         try {
             const response = await this.api.post('/commands', {
@@ -459,6 +486,9 @@ class BlipDispatch {
             handleError(error);
         }
     }
+    /**
+     * Sends a message with selectable buttons to an active user. Up to 3 buttons are shown immediately; more are presented as a list.
+     */
     async sendMessageWithButtons({ identity, message, buttons, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
@@ -485,6 +515,9 @@ class BlipEvent {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Tracks an analytics event under the given category and action. Optionally associates it with a contact identity.
+     */
     async createTrackEvent({ category, action, identity }) {
         try {
             const body = {
@@ -513,6 +546,9 @@ class BlipInteraction {
     constructor(context) {
         this.blipContext = context.blipContext;
     }
+    /**
+     * Moves a user to the specified subbot and state by setting the corresponding context variables.
+     */
     async moveUser({ identity, botIdentity, botFlowId, botStateId, }) {
         await Promise.all([
             this.blipContext.setContextVariable({ identity, variableName: 'master-state', value: botIdentity }),
@@ -526,6 +562,9 @@ class BlipTicket {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Searches tickets. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         try {
             const params = {
@@ -547,6 +586,9 @@ class BlipTicket {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a ticket by id.
+     */
     async getTicket(ticketId) {
         try {
             const body = {
@@ -570,6 +612,9 @@ class BlipWhatsapp {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns all approved WhatsApp message templates for the channel.
+     */
     async getTemplates() {
         try {
             const response = await this.api.post('/commands', {
@@ -585,6 +630,9 @@ class BlipWhatsapp {
             throw handleError(error);
         }
     }
+    /**
+     * Returns the WhatsApp Blip identity associated with the given phone number.
+     */
     async getIdentity(phone) {
         try {
             const response = await this.api.post('/commands', {
@@ -607,6 +655,9 @@ class BlipCampaign {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Searches campaigns. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         try {
             const params = {
@@ -628,6 +679,9 @@ class BlipCampaign {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a campaign by id.
+     */
     async get(campaignId) {
         try {
             const body = {
@@ -644,6 +698,9 @@ class BlipCampaign {
             throw handleError(error);
         }
     }
+    /**
+     * Deletes a campaign by id.
+     */
     async deleteCampaign(campaignId) {
         try {
             const body = {
@@ -661,8 +718,81 @@ class BlipCampaign {
     }
 }
 
+class BlipApplication {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns the application.
+     */
+    async getApplication() {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: 'postmaster@configurations.msging.net',
+                method: 'get',
+                uri: 'lime://enterprise.master.hosting@msging.net/configuration',
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return JSON.parse(response.data.resource.Application);
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+const BUILDER_RECIPIENT = 'postmaster@builder.msging.net';
+class BlipFlow {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns the flow id. When `shortName` is provided, returns the flow id of the matching subbot.
+     */
+    async getFlowId(shortName) {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: BUILDER_RECIPIENT,
+                method: 'get',
+                uri: createUri('/flow-id', { shortName }),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    /**
+     * Returns the states of a flow using the flow name.
+     */
+    async getFlowStates(flowShortName) {
+        try {
+            const body = {
+                id: crypto.randomUUID(),
+                to: BUILDER_RECIPIENT,
+                method: 'get',
+                uri: createUri('/flow/states', { shortName: flowShortName }),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
 var index$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    BlipApplication: BlipApplication,
     BlipAttendance: BlipAttendance,
     BlipBucket: BlipBucket,
     BlipCampaign: BlipCampaign,
@@ -670,6 +800,7 @@ var index$1 = /*#__PURE__*/Object.freeze({
     BlipContext: BlipContext,
     BlipDispatch: BlipDispatch,
     BlipEvent: BlipEvent,
+    BlipFlow: BlipFlow,
     BlipInteraction: BlipInteraction,
     BlipMedia: BlipMedia,
     BlipTicket: BlipTicket,
@@ -690,6 +821,9 @@ class BlipMonitoring {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns currently monitored tickets.
+     */
     async getTickets() {
         try {
             const response = await this.api.post('/commands', {
@@ -705,6 +839,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns aggregated ticket metrics for the desk.
+     */
     async getTicketMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -720,6 +857,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns aggregated metrics about attendant status.
+     */
     async getAttendantStatusMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -735,6 +875,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns metrics for tickets currently waiting to be served.
+     */
     async getWaitingTicketsMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -833,6 +976,9 @@ class BlipThreads {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the message thread for the given identity. Supports pagination, filtering by message id or storage date, and refreshing expired media URIs.
+     */
     async getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }) {
         const params = {
             refreshExpiredMedia: refreshExpiredMedia ? 'true' : 'false',
@@ -874,6 +1020,8 @@ class Blip {
     analytics;
     campaign;
     threads;
+    application;
+    flow;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -897,6 +1045,8 @@ class Blip {
         this.analytics = new BlipAnalytics({ api: this.api });
         this.campaign = new BlipCampaign({ api: this.api });
         this.threads = new BlipThreads({ api: this.api });
+        this.application = new BlipApplication({ api: this.api });
+        this.flow = new BlipFlow({ api: this.api });
     }
 }
 

package/dist/index.mjs

@@ -91,6 +91,9 @@ class BlipBucket {
             throw handleError(error);
         }
     }
+    /**
+     * Returns all document ids stored in the Blip bucket.
+     */
     async getAllContentIdsFromBucket() {
         try {
             const body = {
@@ -183,6 +186,9 @@ class BlipAttendance {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the attendance hour container for the given id.
+     */
     async getAttendanceHourContainer({ attendanceContainerId }) {
         try {
             const body = {
@@ -214,6 +220,9 @@ class BlipContact {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Merges the provided fields into the contact identified by `identity`.
+     */
     async update({ identity, contactData }) {
         try {
             const response = await this.api.post('/commands', {
@@ -233,6 +242,9 @@ class BlipContact {
             handleError(error);
         }
     }
+    /**
+     * Returns the contact for the given identity.
+     */
     async get({ identity }) {
         try {
             const response = await this.api.post('/commands', {
@@ -248,6 +260,9 @@ class BlipContact {
             throw handleError(error);
         }
     }
+    /**
+     * Searches contacts. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         const params = {
             $filter: filter,
@@ -275,6 +290,9 @@ class BlipContext {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the value of a context variable for the given identity.
+     */
     async getContextVariable({ identity, variableName }) {
         try {
             const response = await this.api.post('/commands', {
@@ -290,6 +308,9 @@ class BlipContext {
             throw handleError(error);
         }
     }
+    /**
+     * Returns all available context variables for the given identity.
+     */
     async getAvailableContextVariables({ identity }) {
         try {
             const response = await this.api.post('/commands', {
@@ -305,6 +326,9 @@ class BlipContext {
             throw handleError(error);
         }
     }
+    /**
+     * Sets a context variable for the given identity. Object values are stored as JSON, primitive values as plain text.
+     */
     async setContextVariable({ value, variableName, identity, }) {
         try {
             const resourceType = typeof value === 'object' ? 'application/vnd.lime.contact+json' : 'text/plain';
@@ -377,6 +401,9 @@ class BlipDispatch {
             throw handleError(error);
         }
     }
+    /**
+     * Returns the delivery status entries of a campaign notification by id.
+     */
     async getCampaignNotificationStatus({ campaignNotificationId }) {
         try {
             const response = await this.api.post('/commands', {
@@ -457,6 +484,9 @@ class BlipDispatch {
             handleError(error);
         }
     }
+    /**
+     * Sends a message with selectable buttons to an active user. Up to 3 buttons are shown immediately; more are presented as a list.
+     */
     async sendMessageWithButtons({ identity, message, buttons, metadata, }) {
         try {
             const response = await this.api.post('/messages', {
@@ -483,6 +513,9 @@ class BlipEvent {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Tracks an analytics event under the given category and action. Optionally associates it with a contact identity.
+     */
     async createTrackEvent({ category, action, identity }) {
         try {
             const body = {
@@ -511,6 +544,9 @@ class BlipInteraction {
     constructor(context) {
         this.blipContext = context.blipContext;
     }
+    /**
+     * Moves a user to the specified subbot and state by setting the corresponding context variables.
+     */
     async moveUser({ identity, botIdentity, botFlowId, botStateId, }) {
         await Promise.all([
             this.blipContext.setContextVariable({ identity, variableName: 'master-state', value: botIdentity }),
@@ -524,6 +560,9 @@ class BlipTicket {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Searches tickets. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         try {
             const params = {
@@ -545,6 +584,9 @@ class BlipTicket {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a ticket by id.
+     */
     async getTicket(ticketId) {
         try {
             const body = {
@@ -568,6 +610,9 @@ class BlipWhatsapp {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns all approved WhatsApp message templates for the channel.
+     */
     async getTemplates() {
         try {
             const response = await this.api.post('/commands', {
@@ -583,6 +628,9 @@ class BlipWhatsapp {
             throw handleError(error);
         }
     }
+    /**
+     * Returns the WhatsApp Blip identity associated with the given phone number.
+     */
     async getIdentity(phone) {
         try {
             const response = await this.api.post('/commands', {
@@ -605,6 +653,9 @@ class BlipCampaign {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Searches campaigns. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     async search({ filter, skip, take } = {}) {
         try {
             const params = {
@@ -626,6 +677,9 @@ class BlipCampaign {
             throw handleError(error);
         }
     }
+    /**
+     * Returns a campaign by id.
+     */
     async get(campaignId) {
         try {
             const body = {
@@ -642,6 +696,9 @@ class BlipCampaign {
             throw handleError(error);
         }
     }
+    /**
+     * Deletes a campaign by id.
+     */
     async deleteCampaign(campaignId) {
         try {
             const body = {
@@ -659,8 +716,81 @@ class BlipCampaign {
     }
 }
 
+class BlipApplication {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns the application.
+     */
+    async getApplication() {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: 'postmaster@configurations.msging.net',
+                method: 'get',
+                uri: 'lime://enterprise.master.hosting@msging.net/configuration',
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return JSON.parse(response.data.resource.Application);
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
+const BUILDER_RECIPIENT = 'postmaster@builder.msging.net';
+class BlipFlow {
+    api;
+    constructor(context) {
+        this.api = context.api;
+    }
+    /**
+     * Returns the flow id. When `shortName` is provided, returns the flow id of the matching subbot.
+     */
+    async getFlowId(shortName) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: BUILDER_RECIPIENT,
+                method: 'get',
+                uri: createUri('/flow-id', { shortName }),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+    /**
+     * Returns the states of a flow using the flow name.
+     */
+    async getFlowStates(flowShortName) {
+        try {
+            const body = {
+                id: randomUUID(),
+                to: BUILDER_RECIPIENT,
+                method: 'get',
+                uri: createUri('/flow/states', { shortName: flowShortName }),
+            };
+            const response = await this.api.post('/commands', body);
+            validateResponse(response);
+            return response.data.resource.items;
+        }
+        catch (error) {
+            throw handleError(error);
+        }
+    }
+}
+
 var index$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    BlipApplication: BlipApplication,
     BlipAttendance: BlipAttendance,
     BlipBucket: BlipBucket,
     BlipCampaign: BlipCampaign,
@@ -668,6 +798,7 @@ var index$1 = /*#__PURE__*/Object.freeze({
     BlipContext: BlipContext,
     BlipDispatch: BlipDispatch,
     BlipEvent: BlipEvent,
+    BlipFlow: BlipFlow,
     BlipInteraction: BlipInteraction,
     BlipMedia: BlipMedia,
     BlipTicket: BlipTicket,
@@ -688,6 +819,9 @@ class BlipMonitoring {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns currently monitored tickets.
+     */
     async getTickets() {
         try {
             const response = await this.api.post('/commands', {
@@ -703,6 +837,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns aggregated ticket metrics for the desk.
+     */
     async getTicketMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -718,6 +855,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns aggregated metrics about attendant status.
+     */
     async getAttendantStatusMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -733,6 +873,9 @@ class BlipMonitoring {
             throw handleError(error);
         }
     }
+    /**
+     * Returns metrics for tickets currently waiting to be served.
+     */
     async getWaitingTicketsMetrics() {
         try {
             const response = await this.api.post('/commands', {
@@ -831,6 +974,9 @@ class BlipThreads {
     constructor(context) {
         this.api = context.api;
     }
+    /**
+     * Returns the message thread for the given identity. Supports pagination, filtering by message id or storage date, and refreshing expired media URIs.
+     */
     async getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }) {
         const params = {
             refreshExpiredMedia: refreshExpiredMedia ? 'true' : 'false',
@@ -872,6 +1018,8 @@ class Blip {
     analytics;
     campaign;
     threads;
+    application;
+    flow;
     constructor(params) {
         validateInstance(params);
         this.api = axios.create({
@@ -895,6 +1043,8 @@ class Blip {
         this.analytics = new BlipAnalytics({ api: this.api });
         this.campaign = new BlipCampaign({ api: this.api });
         this.threads = new BlipThreads({ api: this.api });
+        this.application = new BlipApplication({ api: this.api });
+        this.flow = new BlipFlow({ api: this.api });
     }
 }
 

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

@@ -0,0 +1,12 @@
+import { AxiosInstance } from 'axios';
+import { BlipRouterConfig } from '../types/application';
+export default class BlipApplication {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    /**
+     * Returns the application.
+     */
+    getApplication(): Promise<BlipRouterConfig>;
+}

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

@@ -5,6 +5,9 @@ export default class BlipAttendance {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Returns the attendance hour container for the given id.
+     */
     getAttendanceHourContainer({ attendanceContainerId }: {
         attendanceContainerId: string;
     }): Promise<AttendanceHourContainer>;

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

@@ -15,6 +15,9 @@ export default class BlipBucket {
         Retrieves a document from the Blip bucket.
     */
     getContentFromBucket<T>(id: string): Promise<T>;
+    /**
+     * Returns all document ids stored in the Blip bucket.
+     */
     getAllContentIdsFromBucket(): Promise<string[]>;
     /**
         Deletes a JSON document from the Blip bucket.

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

@@ -5,11 +5,20 @@ export default class BlipCampaign {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Searches campaigns. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     search({ filter, skip, take }?: {
         filter?: string;
         skip?: number;
         take?: number;
     }): Promise<Campaign[]>;
+    /**
+     * Returns a campaign by id.
+     */
     get(campaignId: string): Promise<Campaign>;
+    /**
+     * Deletes a campaign by id.
+     */
     deleteCampaign(campaignId: string): Promise<void>;
 }

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

@@ -5,13 +5,22 @@ export default class BlipContact {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Merges the provided fields into the contact identified by `identity`.
+     */
     update({ identity, contactData }: {
         identity: string;
         contactData: Record<string, unknown>;
     }): Promise<void>;
+    /**
+     * Returns the contact for the given identity.
+     */
     get({ identity }: {
         identity: string;
     }): Promise<Contact>;
+    /**
+     * Searches contacts. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     search({ filter, skip, take }?: {
         filter?: string;
         skip?: number;

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

@@ -4,13 +4,22 @@ export default class BlipContext {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Returns the value of a context variable for the given identity.
+     */
     getContextVariable({ identity, variableName }: {
         identity: string;
         variableName: string;
     }): Promise<unknown>;
+    /**
+     * Returns all available context variables for the given identity.
+     */
     getAvailableContextVariables({ identity }: {
         identity: string;
     }): Promise<Record<string, unknown>>;
+    /**
+     * Sets a context variable for the given identity. Object values are stored as JSON, primitive values as plain text.
+     */
     setContextVariable({ value, variableName, identity, }: {
         variableName: string;
         value: unknown;

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

@@ -21,6 +21,9 @@ export default class BlipDispatch {
         params?: string[];
         scheduled?: Date;
     }): Promise<CampaignNotification>;
+    /**
+     * Returns the delivery status entries of a campaign notification by id.
+     */
     getCampaignNotificationStatus({ campaignNotificationId }: {
         campaignNotificationId: string;
     }): Promise<CampaignNotificationStatus[]>;
@@ -55,6 +58,9 @@ export default class BlipDispatch {
         previewUri?: string;
         previewType?: string;
     }): Promise<void>;
+    /**
+     * Sends a message with selectable buttons to an active user. Up to 3 buttons are shown immediately; more are presented as a list.
+     */
     sendMessageWithButtons({ identity, message, buttons, metadata, }: {
         identity: string;
         message: string;

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

@@ -4,6 +4,9 @@ export default class BlipEvent {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Tracks an analytics event under the given category and action. Optionally associates it with a contact identity.
+     */
     createTrackEvent({ category, action, identity }: {
         category: string;
         action: string;

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

@@ -0,0 +1,16 @@
+import { AxiosInstance } from 'axios';
+import { FlowState } from '../types/flow';
+export default class BlipFlow {
+    private api;
+    constructor(context: {
+        api: AxiosInstance;
+    });
+    /**
+     * Returns the flow id. When `shortName` is provided, returns the flow id of the matching subbot.
+     */
+    getFlowId(shortName?: string): Promise<string>;
+    /**
+     * Returns the states of a flow using the flow name.
+     */
+    getFlowStates(flowShortName: string): Promise<FlowState[]>;
+}

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

@@ -4,6 +4,9 @@ export default class BlipInteraction {
     constructor(context: {
         blipContext: BlipContext;
     });
+    /**
+     * Moves a user to the specified subbot and state by setting the corresponding context variables.
+     */
     moveUser({ identity, botIdentity, botFlowId, botStateId, }: {
         identity: string;
         botIdentity: string;

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

@@ -13,6 +13,8 @@ import BlipMonitoring from './blip-monitoring';
 import BlipAnalytics from './blip-analytics';
 import BlipCampaign from './blip-campaign';
 import BlipThreads from './blip-threads';
+import BlipApplication from './blip-application';
+import BlipFlow from './blip-flow';
 export declare class Blip {
     private api;
     bucket: BlipBucket;
@@ -29,5 +31,7 @@ export declare class Blip {
     analytics: BlipAnalytics;
     campaign: BlipCampaign;
     threads: BlipThreads;
+    application: BlipApplication;
+    flow: BlipFlow;
     constructor(params: BlipConstructor);
 }

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

@@ -5,8 +5,20 @@ export default class BlipMonitoring {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Returns currently monitored tickets.
+     */
     getTickets(): Promise<MonitoredTickets>;
+    /**
+     * Returns aggregated ticket metrics for the desk.
+     */
     getTicketMetrics(): Promise<MonitoredTicketMetrics>;
+    /**
+     * Returns aggregated metrics about attendant status.
+     */
     getAttendantStatusMetrics(): Promise<MonitoredAttendantStatusMetrics>;
+    /**
+     * Returns metrics for tickets currently waiting to be served.
+     */
     getWaitingTicketsMetrics(): Promise<MonitoredWaitingTicketsMetrics[]>;
 }

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

@@ -5,6 +5,9 @@ export default class BlipThreads {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Returns the message thread for the given identity. Supports pagination, filtering by message id or storage date, and refreshing expired media URIs.
+     */
     getThread({ identity, refreshExpiredMedia, skip, take, messageId, storageDate, direction, getFromOriginator, }: {
         identity: string;
         refreshExpiredMedia?: boolean;

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

@@ -5,10 +5,16 @@ export default class BlipTicket {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Searches tickets. Supports OData-style `$filter`, `$skip` and `$take` parameters.
+     */
     search({ filter, skip, take }?: {
         filter?: string;
         skip?: number;
         take?: number;
     }): Promise<Ticket[]>;
+    /**
+     * Returns a ticket by id.
+     */
     getTicket(ticketId: string): Promise<Ticket>;
 }

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

@@ -5,6 +5,12 @@ export default class BlipWhatsapp {
     constructor(context: {
         api: AxiosInstance;
     });
+    /**
+     * Returns all approved WhatsApp message templates for the channel.
+     */
     getTemplates(): Promise<Template[]>;
+    /**
+     * Returns the WhatsApp Blip identity associated with the given phone number.
+     */
     getIdentity(phone: string): Promise<string>;
 }

package/dist/modules/index.d.ts

@@ -9,4 +9,6 @@ import BlipInteraction from './blip-interaction';
 import BlipTicket from './blip-ticket';
 import BlipWhatsapp from './blip-whatsapp';
 import BlipCampaign from './blip-campaign';
-export { BlipMedia, BlipBucket, BlipAttendance, BlipContact, BlipContext, BlipDispatch, BlipEvent, BlipInteraction, BlipTicket, BlipWhatsapp, BlipCampaign, };
+import BlipApplication from './blip-application';
+import BlipFlow from './blip-flow';
+export { BlipMedia, BlipBucket, BlipAttendance, BlipContact, BlipContext, BlipDispatch, BlipEvent, BlipInteraction, BlipTicket, BlipWhatsapp, BlipCampaign, BlipApplication, BlipFlow, };

package/dist/types/application.d.ts

@@ -0,0 +1,37 @@
+export interface BlipRouterConfig {
+    identifier: string;
+    messageReceivers: MessageReceiver[];
+    notificationReceivers: NotificationReceiver[];
+    startupType: string;
+    serviceProviderType: string;
+    disableNotify: boolean;
+    receiptEvents: string[];
+    settings: Settings;
+    settingsType: string;
+}
+export interface MessageReceiver {
+    type: string;
+    mediaType?: string;
+    sender?: string;
+    priority?: number;
+}
+export interface NotificationReceiver {
+    type: string;
+    sender?: string;
+    priority?: number;
+}
+export interface Settings {
+    children: ChildService[];
+}
+export interface ChildService {
+    isDefault: boolean;
+    identity: string;
+    longName: string;
+    shortName: string;
+    service: string;
+    $id: number;
+    isOnline: boolean;
+    isPersistent?: boolean;
+    tenantNotFound?: boolean;
+    redirectTimeoutInSeconds?: string;
+}

package/dist/types/flow.d.ts

@@ -0,0 +1,6 @@
+export interface FlowState {
+    id: string;
+    name?: string;
+    root?: boolean;
+    [key: string]: unknown;
+}

package/dist/types/index.d.ts

@@ -7,4 +7,5 @@ import { MonitoredTickets, MonitoredTicketMetrics, MonitoredAttendantStatusMetri
 import { TicketAnalyticsReport, TicketAnalyticsTimings } from './analytics';
 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, };
+import { FlowState } from './flow';
+export { AttendanceHourContainer, BlipConstructor, BlipRequestBody, BlipResponse, BlipArrayBody, Parameter, Component, Template, TicketAnalyticsReport, MonitoredTickets, MonitoredTicketMetrics, MonitoredAttendantStatusMetrics, TicketAnalyticsTimings, Ticket, Campaign, Contact, FlowState, };

package/package.json

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