bkper-js 1.22.0 → 1.24.0

package/lib/index.d.ts

@@ -362,6 +362,22 @@ export declare class App {
      * @returns The App universal identifier
      */
     getId(): string | undefined;
+    /**
+     * @return The name of this App
+     */
+    getName(): string | undefined;
+    /**
+     * @return The type of this App
+     */
+    getType(): AppType | 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
      *
@@ -402,6 +418,28 @@ 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]]
  *
@@ -660,6 +698,7 @@ export declare class Book {
 
 
 
+
     constructor(payload?: bkper.Book);
     /**
      * @returns An immutable copy of the json payload
@@ -905,6 +944,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.
      *

package/lib/index.js

@@ -23,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, EventType } from './model/Enums.js';
+export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month, EventType, AppType } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/App.js

@@ -8,6 +8,7 @@ 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.
  *
@@ -47,6 +48,31 @@ export class App {
     getId() {
         return this.payload.id;
     }
+    /**
+     * @return The name of this App
+     */
+    getName() {
+        return this.payload.name;
+    }
+    /**
+     * @return The type of this App
+     */
+    getType() {
+        const events = this.payload.events;
+        return events && events.length > 0 ? AppType.BOT : AppType.APP;
+    }
+    /**
+     * @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,6 +148,28 @@ 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 event types.
  *

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.22.0",
+  "version": "1.24.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",