bkper-js 1.22.0 → 1.23.0

package/lib/index.d.ts

@@ -362,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
      *
@@ -660,6 +672,7 @@ export declare class Book {
 
 
 
+
     constructor(payload?: bkper.Book);
     /**
      * @returns An immutable copy of the json payload
@@ -905,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.
      *

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