bkper-js 1.21.0 → 1.23.0

package/lib/index.d.ts

@@ -220,6 +220,37 @@ export declare enum AccountType {
     OUTGOING = "OUTGOING"
 }
 
+/**
+ * Defines an Agent on Bkper.
+ *
+ * An Agent represents an entity (such as an App or Bot) that interacts with Bkper, executing actions on behalf of users.
+ *
+ * @public
+ */
+export declare class Agent {
+    payload: bkper.Agent;
+    constructor(payload?: bkper.Agent);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Agent;
+    /**
+     *
+     * @returns The Agent universal identifier
+     */
+    getId(): string | undefined;
+    /**
+     *
+     * @returns The Agent name
+     */
+    getName(): string | undefined;
+    /**
+     *
+     * @returns The Agent logo url
+     */
+    getLogoUrl(): string | undefined;
+}
+
 /**
  * This class defines an Amount for arbitrary-precision decimal arithmetic.
  *
@@ -331,6 +362,18 @@ export declare class App {
      * @returns The App universal identifier
      */
     getId(): string | undefined;
+    /**
+     * @return The name of this App
+     */
+    getName(): string | undefined;
+    /**
+     * @return The logo url of this App
+     */
+    getLogoUrl(): string | undefined;
+    /**
+     * @return The description of this App
+     */
+    getDescription(): string | undefined;
     /**
      * Sets the whitelabeled user emails
      *
@@ -629,6 +672,7 @@ export declare class Book {
 
 
 
+
     constructor(payload?: bkper.Book);
     /**
      * @returns An immutable copy of the json payload
@@ -874,6 +918,12 @@ export declare class Book {
      * Trigger [Balances Audit](https://help.bkper.com/en/articles/4412038-balances-audit) async process.
      */
     audit(): void;
+    /**
+     * Retrieve installed [[Apps]] for this Book
+     *
+     * @returns The Apps objects
+     */
+    getApps(): Promise<App[]>;
     /**
      * Gets the existing [[Integrations]] in the Book.
      *
@@ -1304,7 +1354,10 @@ export declare enum DecimalSeparator {
 }
 
 /**
- * Represents an Event in the system.
+ *
+ * This class defines an Event from a [[Book]].
+ *
+ * An event is an object that represents an action (such as posting or deleting a [[Transaction]]) made by an actor (such as a user or a [Bot](https://bkper.com/apps) acting on behalf of a user).
  *
  * @public
  */
@@ -1315,6 +1368,22 @@ export declare class Event {
      * @returns The wrapped plain json object
      */
     json(): bkper.Event;
+    /**
+     * @returns The user who performed the event
+     */
+    getUser(): User | undefined;
+    /**
+     * @returns The user who performed the event
+     */
+    getAgent(): Agent | undefined;
+    /**
+     * @returns The date the event was created
+     */
+    getCreatedAt(): Date | undefined;
+    /**
+     * @returns The type of the event
+     */
+    getType(): EventType | undefined;
 }
 
 /**
@@ -1347,6 +1416,41 @@ export declare class EventList {
     getItems(): Event[];
 }
 
+/**
+ * Enum that represents event types.
+ *
+ * @public
+ */
+export declare enum EventType {
+    FILE_CREATED = "FILE_CREATED",
+    TRANSACTION_CREATED = "TRANSACTION_CREATED",
+    TRANSACTION_UPDATED = "TRANSACTION_UPDATED",
+    TRANSACTION_DELETED = "TRANSACTION_DELETED",
+    TRANSACTION_POSTED = "TRANSACTION_POSTED",
+    TRANSACTION_CHECKED = "TRANSACTION_CHECKED",
+    TRANSACTION_UNCHECKED = "TRANSACTION_UNCHECKED",
+    TRANSACTION_RESTORED = "TRANSACTION_RESTORED",
+    ACCOUNT_CREATED = "ACCOUNT_CREATED",
+    ACCOUNT_UPDATED = "ACCOUNT_UPDATED",
+    ACCOUNT_DELETED = "ACCOUNT_DELETED",
+    QUERY_CREATED = "QUERY_CREATED",
+    QUERY_UPDATED = "QUERY_UPDATED",
+    QUERY_DELETED = "QUERY_DELETED",
+    GROUP_CREATED = "GROUP_CREATED",
+    GROUP_UPDATED = "GROUP_UPDATED",
+    GROUP_DELETED = "GROUP_DELETED",
+    COMMENT_CREATED = "COMMENT_CREATED",
+    COMMENT_DELETED = "COMMENT_DELETED",
+    COLLABORATOR_ADDED = "COLLABORATOR_ADDED",
+    COLLABORATOR_UPDATED = "COLLABORATOR_UPDATED",
+    COLLABORATOR_REMOVED = "COLLABORATOR_REMOVED",
+    INTEGRATION_CREATED = "INTEGRATION_CREATED",
+    INTEGRATION_UPDATED = "INTEGRATION_UPDATED",
+    INTEGRATION_DELETED = "INTEGRATION_DELETED",
+    BOOK_UPDATED = "BOOK_UPDATED",
+    BOOK_DELETED = "BOOK_DELETED"
+}
+
 /**
  *
  * This class defines a File uploaded to a [[Book]].
@@ -2285,6 +2389,12 @@ export declare class User {
      * @returns The User's name
      */
     getName(): string | undefined;
+    /**
+     * Gets the avatar url of the User.
+     *
+     * @returns The User's avatar url
+     */
+    getAvatarUrl(): string | undefined;
     /**
      * Gets the full name of the User.
      *

package/lib/index.js

@@ -6,6 +6,7 @@
  * @packageDocumentation
  */
 export { Account } from './model/Account.js';
+export { Agent } from './model/Agent.js';
 export { Amount } from "./model/Amount.js";
 export { App } from './model/App.js';
 export { BalancesReport } from './model/BalancesReport.js';
@@ -22,5 +23,5 @@ export { TransactionList } from './model/TransactionList.js';
 export { Event } from './model/Event.js';
 export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
-export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/Agent.js

@@ -0,0 +1,40 @@
+/**
+ * Defines an Agent on Bkper.
+ *
+ * An Agent represents an entity (such as an App or Bot) that interacts with Bkper, executing actions on behalf of users.
+ *
+ * @public
+ */
+export class Agent {
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+    /**
+     *
+     * @returns The Agent universal identifier
+     */
+    getId() {
+        return this.payload.id;
+    }
+    /**
+     *
+     * @returns The Agent name
+     */
+    getName() {
+        return this.payload.name;
+    }
+    /**
+     *
+     * @returns The Agent logo url
+     */
+    getLogoUrl() {
+        return this.payload.logo;
+    }
+}
+//# sourceMappingURL=Agent.js.map

package/lib/model/App.js

@@ -47,6 +47,24 @@ export class App {
     getId() {
         return this.payload.id;
     }
+    /**
+     * @return The name of this App
+     */
+    getName() {
+        return this.payload.name;
+    }
+    /**
+     * @return The logo url of this App
+     */
+    getLogoUrl() {
+        return this.payload.logoUrl;
+    }
+    /**
+     * @return The description of this App
+     */
+    getDescription() {
+        return this.payload.description;
+    }
     /**
      * Sets the whitelabeled user emails
      *

package/lib/model/Book.js

@@ -26,6 +26,7 @@ import { Integration } from './Integration.js';
 import { Transaction } from './Transaction.js';
 import { TransactionList } from './TransactionList.js';
 import { BalancesReport } from './BalancesReport.js';
+import { App } from './App.js';
 /**
  *
  * A Book represents [General Ledger](https://en.wikipedia.org/wiki/General_ledger) for a company or business, but can also represent a [Ledger](https://en.wikipedia.org/wiki/Ledger) for a project or department
@@ -430,6 +431,21 @@ export class Book {
     audit() {
         BookService.audit(this.getId());
     }
+    /**
+     * Retrieve installed [[Apps]] for this Book
+     *
+     * @returns The Apps objects
+     */
+    getApps() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.apps != null) {
+                return this.apps;
+            }
+            const appsPlain = yield BookService.getApps(this.getId());
+            this.apps = appsPlain.map(a => new App(a));
+            return this.apps;
+        });
+    }
     /**
      * Gets the existing [[Integrations]] in the Book.
      *

package/lib/model/Enums.js

@@ -148,4 +148,39 @@ export var Month;
     Month["NOVEMBER"] = "NOVEMBER";
     Month["DECEMBER"] = "DECEMBER";
 })(Month || (Month = {}));
+/**
+ * Enum that represents event types.
+ *
+ * @public
+ */
+export var EventType;
+(function (EventType) {
+    EventType["FILE_CREATED"] = "FILE_CREATED";
+    EventType["TRANSACTION_CREATED"] = "TRANSACTION_CREATED";
+    EventType["TRANSACTION_UPDATED"] = "TRANSACTION_UPDATED";
+    EventType["TRANSACTION_DELETED"] = "TRANSACTION_DELETED";
+    EventType["TRANSACTION_POSTED"] = "TRANSACTION_POSTED";
+    EventType["TRANSACTION_CHECKED"] = "TRANSACTION_CHECKED";
+    EventType["TRANSACTION_UNCHECKED"] = "TRANSACTION_UNCHECKED";
+    EventType["TRANSACTION_RESTORED"] = "TRANSACTION_RESTORED";
+    EventType["ACCOUNT_CREATED"] = "ACCOUNT_CREATED";
+    EventType["ACCOUNT_UPDATED"] = "ACCOUNT_UPDATED";
+    EventType["ACCOUNT_DELETED"] = "ACCOUNT_DELETED";
+    EventType["QUERY_CREATED"] = "QUERY_CREATED";
+    EventType["QUERY_UPDATED"] = "QUERY_UPDATED";
+    EventType["QUERY_DELETED"] = "QUERY_DELETED";
+    EventType["GROUP_CREATED"] = "GROUP_CREATED";
+    EventType["GROUP_UPDATED"] = "GROUP_UPDATED";
+    EventType["GROUP_DELETED"] = "GROUP_DELETED";
+    EventType["COMMENT_CREATED"] = "COMMENT_CREATED";
+    EventType["COMMENT_DELETED"] = "COMMENT_DELETED";
+    EventType["COLLABORATOR_ADDED"] = "COLLABORATOR_ADDED";
+    EventType["COLLABORATOR_UPDATED"] = "COLLABORATOR_UPDATED";
+    EventType["COLLABORATOR_REMOVED"] = "COLLABORATOR_REMOVED";
+    EventType["INTEGRATION_CREATED"] = "INTEGRATION_CREATED";
+    EventType["INTEGRATION_UPDATED"] = "INTEGRATION_UPDATED";
+    EventType["INTEGRATION_DELETED"] = "INTEGRATION_DELETED";
+    EventType["BOOK_UPDATED"] = "BOOK_UPDATED";
+    EventType["BOOK_DELETED"] = "BOOK_DELETED";
+})(EventType || (EventType = {}));
 //# sourceMappingURL=Enums.js.map

package/lib/model/Event.js

@@ -1,5 +1,10 @@
+import { Agent } from "./Agent";
+import { User } from "./User";
 /**
- * Represents an Event in the system.
+ *
+ * This class defines an Event from a [[Book]].
+ *
+ * An event is an object that represents an action (such as posting or deleting a [[Transaction]]) made by an actor (such as a user or a [Bot](https://bkper.com/apps) acting on behalf of a user).
  *
  * @public
  */
@@ -13,5 +18,29 @@ export class Event {
     json() {
         return Object.assign({}, this.payload);
     }
+    /**
+     * @returns The user who performed the event
+     */
+    getUser() {
+        return this.payload.user ? new User(this.payload.user) : undefined;
+    }
+    /**
+     * @returns The user who performed the event
+     */
+    getAgent() {
+        return this.payload.agent ? new Agent(this.payload.agent) : undefined;
+    }
+    /**
+     * @returns The date the event was created
+     */
+    getCreatedAt() {
+        return this.payload.createdAt ? new Date(new Number(this.payload.createdAt).valueOf()) : undefined;
+    }
+    /**
+     * @returns The type of the event
+     */
+    getType() {
+        return this.payload.type;
+    }
 }
 //# sourceMappingURL=Event.js.map

package/lib/model/User.js

@@ -41,6 +41,14 @@ export class User {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Gets the avatar url of the User.
+     *
+     * @returns The User's avatar url
+     */
+    getAvatarUrl() {
+        return this.payload.avatarUrl;
+    }
     /**
      * Gets the full name of the User.
      *

package/lib/service/book-service.js

@@ -49,4 +49,11 @@ export function audit(bookId) {
         new HttpBooksApiV5Request(`${bookId}/audit`).setMethod('PATCH').fetch();
     });
 }
+export function getApps(bookId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a;
+        let response = yield new HttpBooksApiV5Request(`${bookId}/apps`).setMethod('GET').fetch();
+        return ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.items) || [];
+    });
+}
 //# sourceMappingURL=book-service.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.21.0",
+  "version": "1.23.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",