bkper-js 1.8.0 → 1.8.2

package/lib/model/Book.js

@@ -8,18 +8,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as AccountService from '../service/account-service.js';
-import * as GroupService from '../service/group-service.js';
 import * as BookService from '../service/book-service.js';
 import * as FileService from '../service/file-service.js';
-import * as TransactionService from '../service/transaction-service.js';
+import * as GroupService from '../service/group-service.js';
 import * as IntegrationService from '../service/integration-service.js';
+import * as TransactionService from '../service/transaction-service.js';
 import * as Utils from '../utils.js';
 import { Account } from './Account.js';
 import { Collection } from './Collection.js';
 import { File } from './File.js';
 import { Group } from './Group.js';
-import { Transaction } from './Transaction.js';
 import { Integration } from './Integration.js';
+import { Transaction } from './Transaction.js';
 import { TransactionList } from './TransactionList.js';
 /**
  *
@@ -30,28 +30,28 @@ import { TransactionList } from './TransactionList.js';
  * @public
  */
 export class Book {
-    constructor(json) {
-        this.wrapped = json || {};
+    constructor(payload) {
+        this.payload = payload || {};
         this.mapGroups();
         this.mapAccounts();
     }
     /**
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json() {
-        return this.wrapped;
+        return Object.assign({}, this.payload);
     }
     /**
      * Same as bookId param
      */
     getId() {
-        return this.wrapped.id || '';
+        return this.payload.id || '';
     }
     /**
      * @returns The name of this Book
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      *
@@ -60,14 +60,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setName(name) {
-        this.wrapped.name = name;
+        this.payload.name = name;
         return this;
     }
     /**
      * @returns The number of fraction digits supported by this Book. Same as getDecimalPlaces
      */
     getFractionDigits() {
-        return this.wrapped.fractionDigits;
+        return this.payload.fractionDigits;
     }
     /**
      * @returns The number of decimal places supported by this Book. Same as getFractionDigits
@@ -82,14 +82,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setFractionDigits(fractionDigits) {
-        this.wrapped.fractionDigits = fractionDigits;
+        this.payload.fractionDigits = fractionDigits;
         return this;
     }
     /**
      * @returns The period slice for balances visualization
      */
     getPeriod() {
-        return this.wrapped.period;
+        return this.payload.period;
     }
     /**
      * Sets the period slice for balances visualization
@@ -97,14 +97,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setPeriod(period) {
-        this.wrapped.period = period;
+        this.payload.period = period;
         return this;
     }
     /**
      * @returns The start month when YEAR period set
      */
     getPeriodStartMonth() {
-        return this.wrapped.periodStartMonth;
+        return this.payload.periodStartMonth;
     }
     /**
      * Sets the start month when YEAR period set
@@ -112,14 +112,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setPeriodStartMonth(month) {
-        this.wrapped.periodStartMonth = month;
+        this.payload.periodStartMonth = month;
         return this;
     }
     /**
      * @returns The transactions pagination page size
      */
     getPageSize() {
-        return this.wrapped.pageSize;
+        return this.payload.pageSize;
     }
     /**
      * Sets the transactions pagination page size
@@ -127,27 +127,27 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setPageSize(pageSize) {
-        this.wrapped.pageSize = pageSize;
+        this.payload.pageSize = pageSize;
         return this;
     }
     /**
      * @returns The name of the owner of the Book
      */
     getOwnerName() {
-        return this.wrapped.ownerName;
+        return this.payload.ownerName;
     }
     /**
      * @returns The permission for the current user
      */
     getPermission() {
-        return this.wrapped.permission;
+        return this.payload.permission;
     }
     /**
      * @returns The collection of this book
      */
     getCollection() {
-        if (this.wrapped.collection != null && this.collection == null) {
-            this.collection = new Collection(this.wrapped.collection);
+        if (this.payload.collection != null && this.collection == null) {
+            this.collection = new Collection(this.payload.collection);
         }
         return this.collection;
     }
@@ -155,7 +155,7 @@ export class Book {
      * @returns The date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
      */
     getDatePattern() {
-        return this.wrapped.datePattern;
+        return this.payload.datePattern;
     }
     /**
      *
@@ -164,14 +164,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setDatePattern(datePattern) {
-        this.wrapped.datePattern = datePattern;
+        this.payload.datePattern = datePattern;
         return this;
     }
     /**
      * @returns The lock date of the Book in ISO format yyyy-MM-dd
      */
     getLockDate() {
-        return this.wrapped.lockDate;
+        return this.payload.lockDate;
     }
     /**
      *
@@ -183,14 +183,14 @@ export class Book {
         if (lockDate == null) {
             lockDate = "1900-00-00";
         }
-        this.wrapped.lockDate = lockDate;
+        this.payload.lockDate = lockDate;
         return this;
     }
     /**
      * @returns The closing date of the Book in ISO format yyyy-MM-dd
      */
     getClosingDate() {
-        return this.wrapped.closingDate;
+        return this.payload.closingDate;
     }
     /**
      *
@@ -202,14 +202,14 @@ export class Book {
         if (closingDate == null) {
             closingDate = "1900-00-00";
         }
-        this.wrapped.closingDate = closingDate;
+        this.payload.closingDate = closingDate;
         return this;
     }
     /**
      * @returns The decimal separator of the Book
      */
     getDecimalSeparator() {
-        return this.wrapped.decimalSeparator;
+        return this.payload.decimalSeparator;
     }
     /**
      *
@@ -218,14 +218,14 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setDecimalSeparator(decimalSeparator) {
-        this.wrapped.decimalSeparator = decimalSeparator;
+        this.payload.decimalSeparator = decimalSeparator;
         return this;
     }
     /**
      * @returns The time zone of the Book
      */
     getTimeZone() {
-        return this.wrapped.timeZone;
+        return this.payload.timeZone;
     }
     /**
      *
@@ -234,50 +234,50 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setTimeZone(timeZone) {
-        this.wrapped.timeZone = timeZone;
+        this.payload.timeZone = timeZone;
         return this;
     }
     /**
      * @returns The time zone offset of the book, in minutes
      */
     getTimeZoneOffset() {
-        return this.wrapped.timeZoneOffset;
+        return this.payload.timeZoneOffset;
     }
     /**
      * @returns The last update date of the book, in in milliseconds
      */
     getLastUpdateMs() {
-        return this.wrapped.lastUpdateMs ? +this.wrapped.lastUpdateMs : undefined;
+        return this.payload.lastUpdateMs ? +this.payload.lastUpdateMs : undefined;
     }
     /**
      * @returns The total number of posted transactions
      */
     getTotalTransactions() {
-        return this.wrapped.totalTransactions ? +(this.wrapped.totalTransactions) : 0;
+        return this.payload.totalTransactions ? +(this.payload.totalTransactions) : 0;
     }
     /**
      * @returns The total number of posted transactions on current month
      */
     getTotalTransactionsCurrentMonth() {
-        return this.wrapped.totalTransactionsCurrentMonth ? +(this.wrapped.totalTransactionsCurrentMonth) : 0;
+        return this.payload.totalTransactionsCurrentMonth ? +(this.payload.totalTransactionsCurrentMonth) : 0;
     }
     /**
      * @returns The total number of posted transactions on current year
      */
     getTotalTransactionsCurrentYear() {
-        return this.wrapped.totalTransactionsCurrentYear ? +(this.wrapped.totalTransactionsCurrentYear) : 0;
+        return this.payload.totalTransactionsCurrentYear ? +(this.payload.totalTransactionsCurrentYear) : 0;
     }
     /**
      * @returns The visibility of the book
      */
     getVisibility() {
-        return this.wrapped.visibility;
+        return this.payload.visibility;
     }
     /**
      * Gets the custom properties stored in this Book
      */
     getProperties() {
-        return this.wrapped.properties != null ? Object.assign({}, this.wrapped.properties) : {};
+        return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
     }
     /**
      * Gets the property value for given keys. First property found will be retrieved
@@ -287,7 +287,7 @@ export class Book {
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
             const key = keys[index];
-            let value = this.wrapped.properties != null ? this.wrapped.properties[key] : null;
+            let value = this.payload.properties != null ? this.payload.properties[key] : null;
             if (value != null && value.trim() != '') {
                 return value;
             }
@@ -302,7 +302,7 @@ export class Book {
      * @returns This Book, for chainning.
      */
     setProperties(properties) {
-        this.wrapped.properties = Object.assign({}, properties);
+        this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
@@ -317,13 +317,13 @@ export class Book {
         if (key == null || key.trim() == '') {
             return this;
         }
-        if (this.wrapped.properties == null) {
-            this.wrapped.properties = {};
+        if (this.payload.properties == null) {
+            this.payload.properties = {};
         }
         if (!value) {
             value = '';
         }
-        this.wrapped.properties[key] = value;
+        this.payload.properties[key] = value;
         return this;
     }
     /**
@@ -702,7 +702,7 @@ export class Book {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield BookService.createBook(this.wrapped);
+            this.payload = yield BookService.createBook(this.payload);
             return this;
         });
     }
@@ -711,7 +711,7 @@ export class Book {
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield BookService.updateBook(this.getId(), this.wrapped);
+            this.payload = yield BookService.updateBook(this.getId(), this.payload);
             return this;
         });
     }

package/lib/model/Collection.js

@@ -5,41 +5,40 @@ import { Book } from "./Book.js";
  * @public
  */
 export class Collection {
-    /** @internal */
-    constructor(json) {
-        this.wrapped = json || {};
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
     }
     /**
      * @returns The id of this Collection
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * @returns The name of this Collection
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      * @returns All Books of this collection.
      */
     getBooks() {
         let books = [];
-        if (this.wrapped.books == null) {
+        if (this.payload.books == null) {
             return books;
         }
-        for (const bookPayload of this.wrapped.books) {
+        for (const bookPayload of this.payload.books) {
             let book = new Book(bookPayload);
             books.push(book);
         }
         return books;
     }
-    /**
-     * @returns The wrapped plain json object
-     */
-    json() {
-        return this.wrapped;
-    }
 }
 //# sourceMappingURL=Collection.js.map

package/lib/model/Connection.js

@@ -15,16 +15,14 @@ import { Integration } from './Integration.js';
  * @public
  */
 export class Connection {
-    constructor(json) {
-        this.wrapped = json || {};
+    constructor(payload) {
+        this.payload = payload || {};
     }
     /**
-     * Gets the wrapped plain json object of the Connection.
-     *
-     * @returns The Connection wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json() {
-        return this.wrapped;
+        return Object.assign({}, this.payload);
     }
     /**
      * Gets the id of the Connection.
@@ -32,7 +30,7 @@ export class Connection {
      * @returns The Connection's id
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * Gets the agentId of the Connection.
@@ -40,7 +38,7 @@ export class Connection {
      * @returns The Connection's agentId
      */
     getAgentId() {
-        return this.wrapped.agentId;
+        return this.payload.agentId;
     }
     /**
      * Sets the Connection agentId.
@@ -50,7 +48,7 @@ export class Connection {
      * @returns The Connection, for chainning
      */
     setAgentId(agentId) {
-        this.wrapped.agentId = agentId;
+        this.payload.agentId = agentId;
         return this;
     }
     /**
@@ -59,7 +57,7 @@ export class Connection {
      * @returns The Connection name
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      * Gets the email of the owner of the Connection.
@@ -67,7 +65,7 @@ export class Connection {
      * @returns The Connection owner's email
      */
     getEmail() {
-        return this.wrapped.email;
+        return this.payload.email;
     }
     /**
      * Sets the name of the Connection.
@@ -77,7 +75,7 @@ export class Connection {
      * @returns The Connection, for chainning
      */
     setName(name) {
-        this.wrapped.name = name;
+        this.payload.name = name;
         return this;
     }
     /**
@@ -88,7 +86,7 @@ export class Connection {
      * @returns The Connection, for chainning
      */
     setUUID(uuid) {
-        this.wrapped.uuid = uuid;
+        this.payload.uuid = uuid;
         return this;
     }
     /**
@@ -97,7 +95,7 @@ export class Connection {
      * @returns The Connection's universal unique identifier name
      */
     getUUID() {
-        return this.wrapped.uuid;
+        return this.payload.uuid;
     }
     /**
      * Gets the type of the Connection.
@@ -105,7 +103,7 @@ export class Connection {
      * @returns The Connection type
      */
     getType() {
-        return this.wrapped.type;
+        return this.payload.type;
     }
     /**
      * Sets the Connection type.
@@ -115,7 +113,7 @@ export class Connection {
      * @returns The Connection, for chainning
      */
     setType(type) {
-        this.wrapped.type = type;
+        this.payload.type = type;
         return this;
     }
     /**
@@ -124,7 +122,7 @@ export class Connection {
      * @returns Object with key/value pair properties
      */
     getProperties() {
-        return this.wrapped.properties != null ? Object.assign({}, this.wrapped.properties) : {};
+        return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
     }
     /**
      * Sets the custom properties of the Connection.
@@ -134,7 +132,7 @@ export class Connection {
      * @returns The Connection, for chainning
      */
     setProperties(properties) {
-        this.wrapped.properties = Object.assign({}, properties);
+        this.payload.properties = Object.assign({}, properties);
         return this;
     }
     /**
@@ -147,7 +145,7 @@ export class Connection {
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
             const key = keys[index];
-            let value = this.wrapped.properties != null ? this.wrapped.properties[key] : null;
+            let value = this.payload.properties != null ? this.payload.properties[key] : null;
             if (value != null && value.trim() != '') {
                 return value;
             }
@@ -166,13 +164,13 @@ export class Connection {
         if (key == null || key.trim() == '') {
             return this;
         }
-        if (this.wrapped.properties == null) {
-            this.wrapped.properties = {};
+        if (this.payload.properties == null) {
+            this.payload.properties = {};
         }
         if (!value) {
             value = '';
         }
-        this.wrapped.properties[key] = value;
+        this.payload.properties[key] = value;
         return this;
     }
     /**
@@ -229,7 +227,7 @@ export class Connection {
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
-            this.wrapped = yield ConnectionService.createConnection(this.wrapped);
+            this.payload = yield ConnectionService.createConnection(this.payload);
             return this;
         });
     }

package/lib/model/File.js

@@ -17,28 +17,27 @@ import * as FileService from '../service/file-service.js';
  * @public
  */
 export class File {
-    constructor(book, json) {
+    constructor(book, payload) {
         this.book = book;
-        this.wrapped = json || {};
+        this.payload = payload || {};
     }
     /**
-     *
-     * @returns The wrapped plain json object
+     * @returns An immutable copy of the json payload
      */
     json() {
-        return this.wrapped;
+        return Object.assign({}, this.payload);
     }
     /**
      * Gets the File id
      */
     getId() {
-        return this.wrapped.id;
+        return this.payload.id;
     }
     /**
      * Gets the File name
      */
     getName() {
-        return this.wrapped.name;
+        return this.payload.name;
     }
     /**
      *
@@ -47,14 +46,14 @@ export class File {
      * @returns This File, for chainning.
      */
     setName(name) {
-        this.wrapped.name = name;
+        this.payload.name = name;
         return this;
     }
     /**
      * Gets the File content type
      */
     getContentType() {
-        return this.wrapped.contentType;
+        return this.payload.contentType;
     }
     /**
      *
@@ -63,7 +62,7 @@ export class File {
      * @returns This File, for chainning.
      */
     setContentType(contentType) {
-        this.wrapped.contentType = contentType;
+        this.payload.contentType = contentType;
         return this;
     }
     /**
@@ -72,10 +71,10 @@ export class File {
     getContent() {
         return __awaiter(this, void 0, void 0, function* () {
             const id = this.getId();
-            if (this.getId() != null && (this.wrapped == null || this.wrapped.content == null) && this.book && id) {
-                this.wrapped = yield FileService.getFile(this.book.getId(), id);
+            if (this.getId() != null && (this.payload == null || this.payload.content == null) && this.book && id) {
+                this.payload = yield FileService.getFile(this.book.getId(), id);
             }
-            return this.wrapped.content;
+            return this.payload.content;
         });
     }
     /**
@@ -85,20 +84,20 @@ export class File {
      * @returns This File, for chainning.
      */
     setContent(content) {
-        this.wrapped.content = content;
+        this.payload.content = content;
         return this;
     }
     /**
      * Gets the file serving url for accessing via browser
      */
     getUrl() {
-        return this.wrapped.url;
+        return this.payload.url;
     }
     /**
      * Gets the file size in bytes
      */
     getSize() {
-        return this.wrapped.size;
+        return this.payload.size;
     }
     /**
      * Perform create new File.
@@ -106,7 +105,7 @@ export class File {
     create() {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.book) {
-                this.wrapped = yield FileService.createFile(this.book.getId(), this.wrapped);
+                this.payload = yield FileService.createFile(this.book.getId(), this.payload);
             }
             return this;
         });