bkper-js 1.26.0 → 1.28.0

package/lib/index.d.ts

@@ -367,9 +367,13 @@ export declare class App {
      */
     getName(): string | undefined;
     /**
-     * @return The type of this App
+     * @return True if this App has events bound to it
      */
-    getType(): AppType | undefined;
+    hasEvents(): boolean;
+    /**
+     * @return The events bound to this App
+     */
+    getEvents(): EventType[] | undefined;
     /**
      * @return The logo url of this App
      */
@@ -418,28 +422,6 @@ export declare class App {
     update(): Promise<App>;
 }
 
-/**
- * Enum that represents the type of an App.
- *
- * @public
- */
-export declare enum AppType {
-    /**
-     * Interactive solutions that can run independently and integrate with third-party services.
-     * Apps can range from simple URL openers to complex add-ons with business logic.
-     *
-     * Learn more on [Bkper Apps](https://bkper.com/docs/#apps).
-     */
-    APP = "APP",
-    /**
-     * Specialized type of App that react to events from Books.
-     * Bots can perform automated tasks like calculating taxes, converting currencies, or posting notifications when specific events occur.
-     *
-     * Learn more on [Bkper Bots](https://bkper.com/docs/#bots).
-     */
-    BOT = "BOT"
-}
-
 /**
  * The container of balances of an [[Account]] or [[Group]]
  *
@@ -940,6 +922,10 @@ export declare class Book {
      * Trash [[Transactions]] on the Book, in batch.
      */
     batchTrashTransactions(transactions: Transaction[]): Promise<void>;
+    /**
+     * Replay [[Events]] on the Book, in batch.
+     */
+    batchReplayEvents(events: Event[], errorOnly?: boolean): Promise<void>;
     /**
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */
@@ -1079,7 +1065,8 @@ export declare class Book {
  */
 export declare class BotResponse {
     payload: bkper.BotResponse;
-    constructor(payload?: bkper.BotResponse);
+
+    constructor(event: Event, payload?: bkper.BotResponse);
     /**
      * @return The type of this Bot Response
      */
@@ -1096,6 +1083,19 @@ export declare class BotResponse {
      * @returns The date this Bot Response was created
      */
     getCreatedAt(): Date | undefined;
+    /**
+     * Replay this Bot Response.
+     *
+     * @returns The updated Bot Response
+     */
+    replay(): Promise<this>;
+    /**
+     * Delete this Bot Response.
+     *
+     * @returns The deleted Bot Response
+     */
+    remove(): Promise<this>;
+
 }
 
 /**
@@ -1437,11 +1437,20 @@ export declare enum DecimalSeparator {
 export declare class Event {
     payload: bkper.Event;
 
-    constructor(payload?: bkper.Event);
+
+    constructor(book: Book, payload?: bkper.Event);
     /**
      * @returns The wrapped plain json object
      */
     json(): bkper.Event;
+    /**
+     * @returns The book in which the Event was created
+     */
+    getBook(): Book;
+    /**
+     * @returns The id of the Event
+     */
+    getId(): string | undefined;
     /**
      * @returns The user who performed the Event
      */

package/lib/index.js

@@ -24,5 +24,5 @@ export { Event } from './model/Event.js';
 export { BotResponse } from './model/BotResponse.js';
 export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
-export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, AppType, BotResponseType } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, BotResponseType } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/App.js

@@ -8,7 +8,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { createApp, patchApp, updateApp } from "../service/app-service.js";
-import { AppType } from "./Enums.js";
 /**
  * Defines an App on Bkper.
  *
@@ -55,11 +54,17 @@ export class App {
         return this.payload.name;
     }
     /**
-     * @return The type of this App
+     * @return True if this App has events bound to it
      */
-    getType() {
-        const events = this.payload.events;
-        return events && events.length > 0 ? AppType.BOT : AppType.APP;
+    hasEvents() {
+        const events = this.getEvents() || [];
+        return events.length > 0;
+    }
+    /**
+     * @return The events bound to this App
+     */
+    getEvents() {
+        return this.payload.events;
     }
     /**
      * @return The logo url of this App

package/lib/model/Book.js

@@ -425,6 +425,16 @@ export class Book {
             yield TransactionService.trashTransactionsBatch(this.getId(), transactionPayloads);
         });
     }
+    /**
+     * Replay [[Events]] on the Book, in batch.
+     */
+    batchReplayEvents(events, errorOnly) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventPayloads = events.map(event => event.json());
+            const eventList = { items: eventPayloads };
+            yield EventService.replayEventsBatch(this, eventList, errorOnly);
+        });
+    }
     /**
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */

package/lib/model/BotResponse.js

@@ -1,3 +1,13 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as EventService from '../service/event-service.js';
 /**
  *
  * This class defines a Bot Response associated to an [[Event]].
@@ -5,7 +15,8 @@
  * @public
  */
 export class BotResponse {
-    constructor(payload) {
+    constructor(event, payload) {
+        this.event = event;
         this.payload = payload || {};
     }
     /**
@@ -32,5 +43,56 @@ export class BotResponse {
     getCreatedAt() {
         return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
     }
+    /**
+     * Replay this Bot Response.
+     *
+     * @returns The updated Bot Response
+     */
+    replay() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventId = this.event.getId();
+            if (eventId == null) {
+                throw new Error("Event id null!");
+            }
+            const agentId = this.getAgentId();
+            if (agentId == null) {
+                throw new Error("Agent id null!");
+            }
+            const updatedEventPayload = yield EventService.replayBotResponse(this.event.getBook(), eventId, agentId);
+            this.event.payload = updatedEventPayload;
+            this.findAndUpdateBotResponsePayload(updatedEventPayload);
+            return this;
+        });
+    }
+    /**
+     * Delete this Bot Response.
+     *
+     * @returns The deleted Bot Response
+     */
+    remove() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventId = this.event.getId();
+            if (eventId == null) {
+                throw new Error("Event id null!");
+            }
+            const agentId = this.getAgentId();
+            if (agentId == null) {
+                throw new Error("Agent id null!");
+            }
+            const updatedEventPayload = yield EventService.deleteBotResponse(this.event.getBook(), eventId, agentId);
+            this.event.payload = updatedEventPayload;
+            this.findAndUpdateBotResponsePayload(updatedEventPayload);
+            return this;
+        });
+    }
+    /** @internal */
+    findAndUpdateBotResponsePayload(event) {
+        if (event && event.botResponses) {
+            const updatedPayload = event.botResponses.find(r => r.agentId && r.agentId === this.getAgentId());
+            if (updatedPayload) {
+                this.payload = updatedPayload;
+            }
+        }
+    }
 }
 //# sourceMappingURL=BotResponse.js.map

package/lib/model/Enums.js

@@ -148,28 +148,6 @@ export var Month;
     Month["NOVEMBER"] = "NOVEMBER";
     Month["DECEMBER"] = "DECEMBER";
 })(Month || (Month = {}));
-/**
- * Enum that represents the type of an App.
- *
- * @public
- */
-export var AppType;
-(function (AppType) {
-    /**
-     * Interactive solutions that can run independently and integrate with third-party services.
-     * Apps can range from simple URL openers to complex add-ons with business logic.
-     *
-     * Learn more on [Bkper Apps](https://bkper.com/docs/#apps).
-     */
-    AppType["APP"] = "APP";
-    /**
-     * Specialized type of App that react to events from Books.
-     * Bots can perform automated tasks like calculating taxes, converting currencies, or posting notifications when specific events occur.
-     *
-     * Learn more on [Bkper Bots](https://bkper.com/docs/#bots).
-     */
-    AppType["BOT"] = "BOT";
-})(AppType || (AppType = {}));
 /**
  * Enum that represents the type of a Bot Response
  *

package/lib/model/Event.js

@@ -11,7 +11,8 @@ import { User } from "./User.js";
  * @public
  */
 export class Event {
-    constructor(payload) {
+    constructor(book, payload) {
+        this.book = book;
         this.payload = payload || {};
     }
     /**
@@ -20,6 +21,18 @@ export class Event {
     json() {
         return Object.assign({}, this.payload);
     }
+    /**
+     * @returns The book in which the Event was created
+     */
+    getBook() {
+        return this.book;
+    }
+    /**
+     * @returns The id of the Event
+     */
+    getId() {
+        return this.payload.id;
+    }
     /**
      * @returns The user who performed the Event
      */
@@ -54,7 +67,7 @@ export class Event {
         let botResponses = [];
         if (this.payload.botResponses) {
             for (const botResponse of this.payload.botResponses) {
-                botResponses.push(new BotResponse(botResponse));
+                botResponses.push(new BotResponse(this, botResponse));
             }
         }
         this.botResponses = botResponses;

package/lib/model/EventList.js

@@ -37,7 +37,7 @@ export class EventList {
      */
     getItems() {
         var _a;
-        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.map(event => new Event(event))) || [];
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.map(event => new Event(this.book, event))) || [];
     }
 }
 //# sourceMappingURL=EventList.js.map

package/lib/service/event-service.js

@@ -23,4 +23,25 @@ export function listEvents(book, afterDate, beforeDate, onError, resourceId, lim
         return response.data;
     });
 }
+export function replayBotResponse(book, eventId, agentId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpBooksApiV5Request(`${book.getId()}/events/${eventId}/responses/${agentId}`).setMethod('PUT').fetch();
+        return response.data;
+    });
+}
+export function deleteBotResponse(book, eventId, agentId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const response = yield new HttpBooksApiV5Request(`${book.getId()}/events/${eventId}/responses/${agentId}`).setMethod('DELETE').fetch();
+        return response.data;
+    });
+}
+export function replayEventsBatch(book, eventList, errorsOnly) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let request = new HttpBooksApiV5Request(`${book.getId()}/events/replay/batch`).setMethod('PATCH').setPayload(eventList);
+        if (errorsOnly) {
+            request.addParam('errorsOnly', errorsOnly);
+        }
+        yield request.fetch();
+    });
+}
 //# sourceMappingURL=event-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.26.0",
+  "version": "1.28.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.13.0"
+    "@bkper/bkper-api-types": "^5.14.0"
   },
   "dependencies": {
     "@google-cloud/local-auth": "^3.0.1",