bkper-js 1.30.0 → 1.32.0

package/lib/index.d.ts

@@ -381,6 +381,14 @@ export declare class App {
      * @return The events bound to this App
      */
     getEvents(): EventType[] | undefined;
+    /**
+     * @return True if this App is conversational
+     */
+    isConversational(): boolean;
+    /**
+     * @return The conversation url of this App
+     */
+    chat(conversation: Conversation): Promise<Conversation | undefined>;
     /**
      * @return The logo url of this App
      */
@@ -634,6 +642,12 @@ export declare class Bkper {
      * @returns The retrieved list of Apps
      */
     static getApps(): Promise<App[]>;
+    /**
+     * Gets all [[Conversations]] available for the user.
+     *
+     * @returns The retrieved list of Conversations
+     */
+    static getConversations(): Promise<Conversation[]>;
     /**
      * Gets all [[Templates]] available for the user.
      *
@@ -1425,6 +1439,53 @@ export declare class Connection {
     remove(): Promise<Connection>;
 }
 
+/**
+ * Defines a Conversation on Bkper.
+ *
+ * A Conversation represents an interaction between [[Users]] and [[Apps]].
+ *
+ * @public
+ */
+export declare class Conversation {
+    payload: bkper.Conversation;
+
+    constructor(payload?: bkper.Conversation);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Conversation;
+    /**
+     *
+     * @returns The Conversation universal identifier
+     */
+    getId(): string | undefined;
+    /**
+     *
+     * @returns The title of the Conversation
+     */
+    getTitle(): string | undefined;
+    /**
+     *
+     * @returns The Agent associated to this Conversation
+     */
+    getAgent(): Agent | undefined;
+    /**
+     *
+     * @returns The Date the Conversation was created
+     */
+    getCreatedAt(): Date | undefined;
+    /**
+     *
+     * @returns The Date the Conversation was last updated
+     */
+    getUpdatedAt(): Date | undefined;
+    /**
+     *
+     * @returns The Messages associated to this Conversation
+     */
+    getMessages(): Message[];
+}
+
 /**
  * Decimal separator of numbers on book
  *
@@ -1471,7 +1532,7 @@ export declare class Event {
      */
     getUser(): User | undefined;
     /**
-     * @returns The user who performed the Event
+     * @returns The Agent who performed the Event
      */
     getAgent(): Agent | undefined;
     /**
@@ -1931,6 +1992,48 @@ export declare class Integration {
     remove(): Promise<Integration>;
 }
 
+/**
+ * Defines a Message on Bkper.
+ *
+ * A Message is a building block of a [[Conversation]].
+ *
+ * @public
+ */
+export declare class Message {
+    payload: bkper.Message;
+
+    constructor(conversation: Conversation, payload?: bkper.Message);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Message;
+    /**
+     *
+     * @returns The Message universal identifier
+     */
+    getId(): string | undefined;
+    /**
+     *
+     * @returns The Agent who created the Message, if any
+     */
+    getAgent(): Agent | undefined;
+    /**
+     *
+     * @returns The User who created the Message, if any
+     */
+    getUser(): User | undefined;
+    /**
+     *
+     * @returns The Date the Message was created
+     */
+    getCreatedAt(): Date | undefined;
+    /**
+     *
+     * @returns The content text of the Message
+     */
+    getContent(): string | undefined;
+}
+
 /**
  * Enum that represents a Month.
  *

package/lib/index.js

@@ -14,9 +14,11 @@ export { Bkper } from './model/Bkper.js';
 export { Book } from './model/Book.js';
 export { Collection } from './model/Collection.js';
 export { Connection } from './model/Connection.js';
+export { Conversation } from './model/Conversation.js';
 export { File } from './model/File.js';
 export { Group } from './model/Group.js';
 export { Integration } from './model/Integration.js';
+export { Message } from './model/Message.js';
 export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
 export { TransactionList } from './model/TransactionList.js';

package/lib/model/App.js

@@ -7,7 +7,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { createApp, patchApp, updateApp } from "../service/app-service.js";
+import * as AppService from '../service/app-service.js';
+import { Conversation } from "./Conversation.js";
 /**
  * Defines an App on Bkper.
  *
@@ -71,6 +72,30 @@ export class App {
     getEvents() {
         return this.payload.events;
     }
+    /**
+     * @return True if this App is conversational
+     */
+    isConversational() {
+        return this.payload.conversational || false;
+    }
+    /**
+     * @return The conversation url of this App
+     */
+    chat(conversation) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.isConversational()) {
+                throw new Error(`App ${this.getName()} is not conversational`);
+            }
+            const appId = this.getId();
+            if (appId) {
+                const response = yield AppService.chat(appId, conversation.json());
+                if (response) {
+                    return new Conversation(response);
+                }
+            }
+            return undefined;
+        });
+    }
     /**
      * @return The logo url of this App
      */
@@ -132,7 +157,7 @@ export class App {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield createApp(this.payload);
+            yield AppService.createApp(this.payload);
             return this;
         });
     }
@@ -141,7 +166,7 @@ export class App {
      */
     patch() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield patchApp(this.payload);
+            yield AppService.patchApp(this.payload);
             return this;
         });
     }
@@ -150,7 +175,7 @@ export class App {
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield updateApp(this.payload);
+            yield AppService.updateApp(this.payload);
             return this;
         });
     }

package/lib/model/Bkper.js

@@ -18,6 +18,7 @@ import { HttpApiRequest } from '../service/http-api-request.js';
 import { User } from "./User.js";
 import { Template } from "./Template.js";
 import { Collection } from "./Collection.js";
+import { Conversation } from "./Conversation.js";
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
@@ -84,6 +85,17 @@ export class Bkper {
             return apps.map(app => new App(app));
         });
     }
+    /**
+     * Gets all [[Conversations]] available for the user.
+     *
+     * @returns The retrieved list of Conversations
+     */
+    static getConversations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let conversations = yield AppService.getConversations();
+            return conversations.map(c => new Conversation(c));
+        });
+    }
     /**
      * Gets all [[Templates]] available for the user.
      *

package/lib/model/Conversation.js

@@ -0,0 +1,73 @@
+import { Agent } from "./Agent.js";
+import { Message } from "./Message.js";
+/**
+ * Defines a Conversation on Bkper.
+ *
+ * A Conversation represents an interaction between [[Users]] and [[Apps]].
+ *
+ * @public
+ */
+export class Conversation {
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+    /**
+     *
+     * @returns The Conversation universal identifier
+     */
+    getId() {
+        return this.payload.id;
+    }
+    /**
+     *
+     * @returns The title of the Conversation
+     */
+    getTitle() {
+        return this.payload.title;
+    }
+    /**
+     *
+     * @returns The Agent associated to this Conversation
+     */
+    getAgent() {
+        return this.payload.agent ? new Agent(this.payload.agent) : undefined;
+    }
+    /**
+     *
+     * @returns The Date the Conversation was created
+     */
+    getCreatedAt() {
+        return this.payload.createdAt ? new Date(this.payload.createdAt) : undefined;
+    }
+    /**
+     *
+     * @returns The Date the Conversation was last updated
+     */
+    getUpdatedAt() {
+        return this.payload.updatedAt ? new Date(this.payload.updatedAt) : undefined;
+    }
+    /**
+     *
+     * @returns The Messages associated to this Conversation
+     */
+    getMessages() {
+        if (this.messages !== undefined) {
+            return this.messages;
+        }
+        let messages = [];
+        if (this.payload.messages) {
+            for (const message of this.payload.messages) {
+                messages.push(new Message(this, message));
+            }
+        }
+        this.messages = messages;
+        return this.messages;
+    }
+}
+//# sourceMappingURL=Conversation.js.map

package/lib/model/Event.js

@@ -40,7 +40,7 @@ export class Event {
         return this.payload.user ? new User(this.payload.user) : undefined;
     }
     /**
-     * @returns The user who performed the Event
+     * @returns The Agent who performed the Event
      */
     getAgent() {
         return this.payload.agent ? new Agent(this.payload.agent) : undefined;

package/lib/model/Message.js

@@ -0,0 +1,57 @@
+import { Agent } from "./Agent.js";
+import { User } from "./User.js";
+/**
+ * Defines a Message on Bkper.
+ *
+ * A Message is a building block of a [[Conversation]].
+ *
+ * @public
+ */
+export class Message {
+    constructor(conversation, payload) {
+        this.conversation = conversation;
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+    /**
+     *
+     * @returns The Message universal identifier
+     */
+    getId() {
+        return this.payload.id;
+    }
+    /**
+     *
+     * @returns The Agent who created the Message, if any
+     */
+    getAgent() {
+        return this.payload.agent ? new Agent(this.payload.agent) : undefined;
+    }
+    /**
+     *
+     * @returns The User who created the Message, if any
+     */
+    getUser() {
+        return this.payload.user ? new User(this.payload.user) : undefined;
+    }
+    /**
+     *
+     * @returns The Date the Message was created
+     */
+    getCreatedAt() {
+        return this.payload.createdAt ? new Date(this.payload.createdAt) : undefined;
+    }
+    /**
+     *
+     * @returns The content text of the Message
+     */
+    getContent() {
+        return this.payload.content;
+    }
+}
+//# sourceMappingURL=Message.js.map

package/lib/service/app-service.js

@@ -22,6 +22,19 @@ export function getApps() {
         return appsJson;
     });
 }
+export function getConversations() {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        const response = yield new HttpApiRequest(`v5/apps/conversations`).setMethod('GET').fetch();
+        return ((_a = response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
+export function chat(appId, conversation) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpApiRequest(`v5/apps/${appId}/conversations`).setMethod('POST').setPayload(conversation).fetch();
+        return response.data;
+    });
+}
 export function createApp(app) {
     return __awaiter(this, void 0, void 0, function* () {
         var response = yield new HttpApiRequest(`v5/apps`).setMethod('POST').setPayload(app).fetch();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.30.0",
+  "version": "1.32.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -34,7 +34,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "peerDependencies": {
-    "@bkper/bkper-api-types": "^5.15.1"
+    "@bkper/bkper-api-types": "^5.15.3"
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",