bkper-js 1.2.5 → 1.4.0

package/lib/index.d.ts

@@ -395,6 +395,12 @@ export declare class Bkper {
      * @returns The retrieved Book, for chaining
      */
     static getBook(id: string): Promise<Book>;
+    /**
+     * Gets all [[Books]] the user has access to.
+     *
+     * @returns The retrieved list of Books
+     */
+    static getBooks(): Promise<Book[]>;
     /**
      * Gets the current logged [[User]].
      *
@@ -578,6 +584,22 @@ export declare class Book {
      * @returns The last update date of the book, in in milliseconds
      */
     getLastUpdateMs(): number | undefined;
+    /**
+     * @returns The total number of posted transactions
+     */
+    getTotalTransactions(): number;
+    /**
+     * @returns The total number of posted transactions on current month
+     */
+    getTotalTransactionsCurrentMonth(): number;
+    /**
+     * @returns The total number of posted transactions on current year
+     */
+    getTotalTransactionsCurrentYear(): number;
+    /**
+     * @returns The visibility of the book
+     */
+    getVisibility(): Visibility;
     /**
      * Gets the custom properties stored in this Book
      */
@@ -832,6 +854,10 @@ export declare class Collection {
      * @returns All Books of this collection.
      */
     getBooks(): Book[];
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Collection;
 }
 
 /**
@@ -1798,6 +1824,10 @@ export declare class TransactionIterator {
 export declare class User {
 
     constructor(json?: bkper.User);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.User;
     /**
      * Gets the id of the User.
      *
@@ -1816,6 +1846,42 @@ export declare class User {
      * @returns The User's full name
      */
     getFullName(): string | undefined;
+    /**
+     * Gets the email of the User.
+     *
+     * @returns The User's email
+     */
+    getEmail(): string | undefined;
+    /**
+     * Gets the hosted domain of the User.
+     *
+     * @returns The User's hosted domain
+     */
+    getHostedDomain(): string | undefined;
+    /**
+     * Tells if the User is in the free plan.
+     *
+     * @returns True if the User is in the free plan
+     */
+    isFree(): boolean | undefined;
+    /**
+     * Tells if the User has started the trial.
+     *
+     * @returns True if the User has started the trial
+     */
+    hasStartedTrial(): boolean | undefined;
+    /**
+     * Gets the days left in User's trial.
+     *
+     * @returns The User's days left in trial
+     */
+    getDaysLeftInTrial(): number | undefined;
+    /**
+     * Tells if the User has already used [[Connections]].
+     *
+     * @returns True if the User has already used Connections
+     */
+    hasUsedConnections(): boolean | undefined;
     /**
      * Gets the [[Connections]] of the User.
      *
@@ -1832,4 +1898,20 @@ export declare class User {
     getConnection(id: string): Promise<Connection>;
 }
 
+/**
+ * Enum representing the visibility of a Book
+ *
+ * @public
+ */
+declare enum Visibility {
+    /**
+     * The book can be accessed by anyone with the link
+     */
+    PUBLIC = "PUBLIC",
+    /**
+     * The book can be accessed by the owner and collaborators
+     */
+    PRIVATE = "PRIVATE"
+}
+
 export { }

package/lib/model/Bkper.js

@@ -45,6 +45,17 @@ export class Bkper {
             return new Book(book);
         });
     }
+    /**
+     * Gets all [[Books]] the user has access to.
+     *
+     * @returns The retrieved list of Books
+     */
+    static getBooks() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let books = yield BookService.loadBooks();
+            return books.map(book => new Book(book));
+        });
+    }
     /**
      * Gets the current logged [[User]].
      *

package/lib/model/Book.js

@@ -248,6 +248,30 @@ export class Book {
     getLastUpdateMs() {
         return this.wrapped.lastUpdateMs ? +this.wrapped.lastUpdateMs : undefined;
     }
+    /**
+     * @returns The total number of posted transactions
+     */
+    getTotalTransactions() {
+        return this.wrapped.totalTransactions ? +(this.wrapped.totalTransactions) : 0;
+    }
+    /**
+     * @returns The total number of posted transactions on current month
+     */
+    getTotalTransactionsCurrentMonth() {
+        return this.wrapped.totalTransactionsCurrentMonth ? +(this.wrapped.totalTransactionsCurrentMonth) : 0;
+    }
+    /**
+     * @returns The total number of posted transactions on current year
+     */
+    getTotalTransactionsCurrentYear() {
+        return this.wrapped.totalTransactionsCurrentYear ? +(this.wrapped.totalTransactionsCurrentYear) : 0;
+    }
+    /**
+     * @returns The visibility of the book
+     */
+    getVisibility() {
+        return this.wrapped.visibility;
+    }
     /**
      * Gets the custom properties stored in this Book
      */

package/lib/model/Collection.js

@@ -35,5 +35,11 @@ export class Collection {
         }
         return books;
     }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return this.wrapped;
+    }
 }
 //# sourceMappingURL=Collection.js.map

package/lib/model/Enums.js

@@ -68,6 +68,22 @@ export var Permission;
      */
     Permission["OWNER"] = "OWNER";
 })(Permission || (Permission = {}));
+/**
+ * Enum representing the visibility of a Book
+ *
+ * @public
+ */
+export var Visibility;
+(function (Visibility) {
+    /**
+     * The book can be accessed by anyone with the link
+     */
+    Visibility["PUBLIC"] = "PUBLIC";
+    /**
+     * The book can be accessed by the owner and collaborators
+     */
+    Visibility["PRIVATE"] = "PRIVATE";
+})(Visibility || (Visibility = {}));
 /**
  * Enum that represents account types.
  *

package/lib/model/User.js

@@ -20,6 +20,12 @@ export class User {
         this.wrapped = {};
         this.wrapped = json || {};
     }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return this.wrapped;
+    }
     /**
      * Gets the id of the User.
      *
@@ -44,6 +50,54 @@ export class User {
     getFullName() {
         return this.wrapped.fullName;
     }
+    /**
+     * Gets the email of the User.
+     *
+     * @returns The User's email
+     */
+    getEmail() {
+        return this.wrapped.email;
+    }
+    /**
+     * Gets the hosted domain of the User.
+     *
+     * @returns The User's hosted domain
+     */
+    getHostedDomain() {
+        return this.wrapped.hostedDomain;
+    }
+    /**
+     * Tells if the User is in the free plan.
+     *
+     * @returns True if the User is in the free plan
+     */
+    isFree() {
+        return this.wrapped.free;
+    }
+    /**
+     * Tells if the User has started the trial.
+     *
+     * @returns True if the User has started the trial
+     */
+    hasStartedTrial() {
+        return this.wrapped.startedTrial;
+    }
+    /**
+     * Gets the days left in User's trial.
+     *
+     * @returns The User's days left in trial
+     */
+    getDaysLeftInTrial() {
+        return this.wrapped.daysLeftInTrial;
+    }
+    /**
+     * Tells if the User has already used [[Connections]].
+     *
+     * @returns True if the User has already used Connections
+     */
+    hasUsedConnections() {
+        return this.wrapped.bankConnections;
+    }
     /**
      * Gets the [[Connections]] of the User.
      *

package/lib/service/book-service.js

@@ -8,6 +8,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HttpBooksApiV5Request } from "./http-api-request.js";
+export function loadBooks() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpBooksApiV5Request('').fetch();
+        if (response.data == null) {
+            return [];
+        }
+        let bookListPlain = response.data;
+        let booksJson = bookListPlain.items;
+        if (booksJson == null) {
+            return [];
+        }
+        return booksJson;
+    });
+}
 export function loadBook(bookId) {
     return __awaiter(this, void 0, void 0, function* () {
         if (bookId == null) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.2.5",
+  "version": "1.4.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -41,7 +41,7 @@
     "luxon": "^1.25.0"
   },
   "devDependencies": {
-    "@bkper/bkper-api-types": "^5.9.0",
+    "@bkper/bkper-api-types": "^5.10.0",
     "@microsoft/api-extractor": "^7.12.1",
     "@types/big.js": "^6.0.2",
     "@types/chai": "^4.2.14",