bkper-js 1.3.0 → 1.5.0

package/lib/index.d.ts

@@ -387,6 +387,19 @@ export declare class App {
  * @public
  */
 export declare class Bkper {
+    /**
+     * Instantiate a new [[Book]]
+     *
+     * Example:
+     * ```js
+     * var book = Bkper.newBook()
+     *  .setName('My New Book')
+     *  .setFractionDigits(2)
+     *  .setDecimalSeparator('DOT')
+     *  .create();
+     * ```
+     */
+    static newBook(): Book;
     /**
      * Gets the [[Book]] with the specified bookId from url param.
      *
@@ -828,6 +841,12 @@ export declare class Book {
      * Retrieve a file by id
      */
     getFile(id: string): Promise<File>;
+    /**
+     * Performs create new Book.
+     *
+     * @returns The created Book object
+     */
+    create(): Promise<Book>;
     /**
      * Perform update Book, applying pending changes.
      */
@@ -1824,6 +1843,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.
      *
@@ -1842,6 +1865,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.
      *

package/lib/model/Bkper.js

@@ -32,6 +32,21 @@ import { User } from "./User.js";
  * @public
  */
 export class Bkper {
+    /**
+     * Instantiate a new [[Book]]
+     *
+     * Example:
+     * ```js
+     * var book = Bkper.newBook()
+     *  .setName('My New Book')
+     *  .setFractionDigits(2)
+     *  .setDecimalSeparator('DOT')
+     *  .create();
+     * ```
+     */
+    static newBook() {
+        return new Book();
+    }
     /**
      * Gets the [[Book]] with the specified bookId from url param.
      *

package/lib/model/Book.js

@@ -689,6 +689,17 @@ export class Book {
             return file;
         });
     }
+    /**
+     * Performs create new Book.
+     *
+     * @returns The created Book object
+     */
+    create() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.wrapped = yield BookService.createBook(this.wrapped);
+            return this;
+        });
+    }
     /**
      * Perform update Book, applying pending changes.
      */

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

@@ -31,6 +31,12 @@ export function loadBook(bookId) {
         return response.data;
     });
 }
+export function createBook(book) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let response = yield new HttpBooksApiV5Request('').setMethod('POST').setPayload(book).fetch();
+        return response.data;
+    });
+}
 export function updateBook(bookId, book) {
     return __awaiter(this, void 0, void 0, function* () {
         var response = yield new HttpBooksApiV5Request(`${bookId}`).setMethod('PUT').setPayload(book).fetch();

package/package.json

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