bkper-js 1.47.2 → 1.47.3

package/lib/model/Book.js

@@ -30,8 +30,7 @@ import { BalancesReport } from './BalancesReport.js';
 import { App } from './App.js';
 import { Query } from './Query.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
+ * A Book represents a [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
  *
  * It contains all [[Accounts]] where [[Transactions]] are recorded/posted;
  *
@@ -48,114 +47,144 @@ export class Book {
         this.mapAccounts(this.payload.accounts);
     }
     /**
-     * @returns An immutable copy of the json payload
+     * Gets an immutable copy of the JSON payload for this Book.
+     *
+     * @returns An immutable copy of the JSON payload
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
-     * Same as bookId param
+     * Gets the unique identifier of this Book.
+     *
+     * @returns This Book's unique identifier
      */
     getId() {
         return this.payload.id || '';
     }
     /**
+     * Gets the name of this Book.
+     *
      * @returns The name of this Book
      */
     getName() {
         return this.payload.name;
     }
     /**
-     *
      * Sets the name of the Book.
      *
-     * @returns This Book, for chainning.
+     * @param name - The name to set
+     *
+     * @returns This Book, for chaining
      */
     setName(name) {
         this.payload.name = name;
         return this;
     }
     /**
+     * Gets the number of fraction digits supported by this Book.
+     *
      * @returns The number of fraction digits supported by this Book. Same as getDecimalPlaces
      */
     getFractionDigits() {
         return this.payload.fractionDigits;
     }
     /**
+     * Gets the number of decimal places supported by this Book.
+     *
      * @returns The number of decimal places supported by this Book. Same as getFractionDigits
      */
     getDecimalPlaces() {
         return this.getFractionDigits();
     }
     /**
+     * Sets the number of fraction digits (decimal places) supported by this Book.
      *
-     * Sets the number of fraction digits (decimal places) supported by this Book
+     * @param fractionDigits - The number of fraction digits to set (0 to 8)
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setFractionDigits(fractionDigits) {
         this.payload.fractionDigits = fractionDigits;
         return this;
     }
     /**
+     * Gets the period slice for balances visualization.
+     *
      * @returns The period slice for balances visualization
      */
     getPeriod() {
         return this.payload.period;
     }
     /**
-     * Sets the period slice for balances visualization
+     * Sets the period slice for balances visualization.
+     *
+     * @param period - The period to set
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setPeriod(period) {
         this.payload.period = period;
         return this;
     }
     /**
-     * @returns The start month when YEAR period set
+     * Gets the start month when YEAR period is set.
+     *
+     * @returns The start month when YEAR period is set
      */
     getPeriodStartMonth() {
         return this.payload.periodStartMonth;
     }
     /**
-     * Sets the start month when YEAR period set
+     * Sets the start month when YEAR period is set.
+     *
+     * @param month - The start month to set
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setPeriodStartMonth(month) {
         this.payload.periodStartMonth = month;
         return this;
     }
     /**
+     * Gets the transactions pagination page size.
+     *
      * @returns The transactions pagination page size
      */
     getPageSize() {
         return this.payload.pageSize;
     }
     /**
-     * Sets the transactions pagination page size
+     * Sets the transactions pagination page size.
+     *
+     * @param pageSize - The page size to set
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setPageSize(pageSize) {
         this.payload.pageSize = pageSize;
         return this;
     }
     /**
+     * Gets the name of the owner of the Book.
+     *
      * @returns The name of the owner of the Book
      */
     getOwnerName() {
         return this.payload.ownerName;
     }
     /**
-     * @returns The permission for the current user
+     * Gets the permission for the current user in this Book.
+     *
+     * @returns The permission for the current user in this Book
      */
     getPermission() {
         return this.payload.permission;
     }
     /**
-     * @returns The collection of this book
+     * Gets the collection of this Book, if any.
+     *
+     * @returns The collection of this Book, if any
      */
     getCollection() {
         if (this.payload.collection != null && this.collection == null) {
@@ -164,32 +193,34 @@ export class Book {
         return this.collection;
     }
     /**
+     * Gets the date pattern of the Book.
+     *
      * @returns The date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
      */
     getDatePattern() {
         return this.payload.datePattern;
     }
     /**
-     *
      * Sets the date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setDatePattern(datePattern) {
         this.payload.datePattern = datePattern;
         return this;
     }
     /**
+     * Gets the lock date of the Book in ISO format yyyy-MM-dd.
+     *
      * @returns The lock date of the Book in ISO format yyyy-MM-dd
      */
     getLockDate() {
         return this.payload.lockDate;
     }
     /**
-     *
      * Sets the lock date of the Book in ISO format yyyy-MM-dd.
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setLockDate(lockDate) {
         if (lockDate == null) {
@@ -199,16 +230,17 @@ export class Book {
         return this;
     }
     /**
+     * Gets the closing date of the Book in ISO format yyyy-MM-dd.
+     *
      * @returns The closing date of the Book in ISO format yyyy-MM-dd
      */
     getClosingDate() {
         return this.payload.closingDate;
     }
     /**
-     *
      * Sets the closing date of the Book in ISO format yyyy-MM-dd.
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setClosingDate(closingDate) {
         if (closingDate == null) {
@@ -218,99 +250,118 @@ export class Book {
         return this;
     }
     /**
+     * Gets the decimal separator of the Book.
+     *
      * @returns The decimal separator of the Book
      */
     getDecimalSeparator() {
         return this.payload.decimalSeparator;
     }
     /**
-     *
      * Sets the decimal separator of the Book
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setDecimalSeparator(decimalSeparator) {
         this.payload.decimalSeparator = decimalSeparator;
         return this;
     }
     /**
+     * Gets the time zone of the Book.
+     *
      * @returns The time zone of the Book
      */
     getTimeZone() {
         return this.payload.timeZone;
     }
     /**
+     * Sets the time zone of the Book.
      *
-     * Sets the time zone of the Book
-     *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setTimeZone(timeZone) {
         this.payload.timeZone = timeZone;
         return this;
     }
     /**
+     * Gets the time zone offset of the book, in minutes.
+     *
      * @returns The time zone offset of the book, in minutes
      */
     getTimeZoneOffset() {
         return this.payload.timeZoneOffset;
     }
     /**
+     * Gets the auto post status of the Book.
+     *
      * @returns The auto post status of the Book
      */
     getAutoPost() {
         return this.payload.autoPost;
     }
     /**
+     * Sets the auto post status of the Book.
      *
-     * Sets the auto post status of the Book
-     *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setAutoPost(autoPost) {
         this.payload.autoPost = autoPost;
         return this;
     }
     /**
-     * @returns The last update date of the book, in in milliseconds
+     * Gets the last update date of the book, in milliseconds.
+     *
+     * @returns The last update date of the book, in milliseconds
      */
     getLastUpdateMs() {
         return this.payload.lastUpdateMs ? +this.payload.lastUpdateMs : undefined;
     }
     /**
+     * Gets the total number of posted transactions.
+     *
      * @returns The total number of posted transactions
      */
     getTotalTransactions() {
         return this.payload.totalTransactions ? +(this.payload.totalTransactions) : 0;
     }
     /**
+     * Gets the total number of posted transactions on current month.
+     *
      * @returns The total number of posted transactions on current month
      */
     getTotalTransactionsCurrentMonth() {
         return this.payload.totalTransactionsCurrentMonth ? +(this.payload.totalTransactionsCurrentMonth) : 0;
     }
     /**
+     * Gets the total number of posted transactions on current year.
+     *
      * @returns The total number of posted transactions on current year
      */
     getTotalTransactionsCurrentYear() {
         return this.payload.totalTransactionsCurrentYear ? +(this.payload.totalTransactionsCurrentYear) : 0;
     }
     /**
+     * Gets the visibility of the book.
+     *
      * @returns The visibility of the book
      */
     getVisibility() {
         return this.payload.visibility;
     }
     /**
-     * Gets the custom properties stored in this Book
+     * Gets the custom properties stored in this Book.
+     *
+     * @returns The custom properties object
      */
     getProperties() {
         return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
     }
     /**
-     * Gets the property value for given keys. First property found will be retrieved
+     * Gets the property value for given keys. First property found will be retrieved.
+     *
+     * @param keys - The property keys to search for
      *
-     * @param keys - The property key
+     * @returns The property value or undefined if not found
      */
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
@@ -323,11 +374,11 @@ export class Book {
         return undefined;
     }
     /**
-     * Sets the custom properties of the Book
+     * Sets the custom properties of the Book.
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
@@ -339,7 +390,7 @@ export class Book {
      * @param key - The property key
      * @param value - The property value
      *
-     * @returns This Book, for chainning.
+     * @returns This Book, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -360,7 +411,7 @@ export class Book {
      * @param date - The date to format as string.
      * @param timeZone - The output timezone of the result. Default to script's timeZone
      *
-     * @returns The date formated
+     * @returns The formatted date
      */
     formatDate(date, timeZone) {
         if (timeZone == null || timeZone.trim() == "") {
@@ -369,9 +420,11 @@ export class Book {
         return Utils.formatDate(date, this.getDatePattern(), timeZone);
     }
     /**
-     * Parse a date string according to date pattern and timezone of the Book.
+     * Parse a date string according to date pattern and timezone of the Book. Also parse ISO yyyy-mm-dd format.
      *
-     * Also parse ISO yyyy-mm-dd format.
+     * @param date - The date string to parse
+     *
+     * @returns The parsed Date object
      */
     parseDate(date) {
         return Utils.parseDate(date, this.getDatePattern(), this.getTimeZone());
@@ -381,7 +434,7 @@ export class Book {
      *
      * @param value - The value to be formatted.
      *
-     * @returns The value formated
+     * @returns The formatted value
      */
     formatValue(value) {
         if (!value) {
@@ -391,16 +444,20 @@ export class Book {
     }
     /**
      * Parse a value string according to [[DecimalSeparator]] and fraction digits of the Book.
+     *
+     * @param value - The value string to parse
+     *
+     * @returns The parsed Amount or undefined if parsing fails
      */
     parseValue(value) {
         return Utils.parseValue(value, this.getDecimalSeparator());
     }
     /**
-     * Rounds a value according to the number of fraction digits of the Book
+     * Rounds a value according to the number of fraction digits of the Book.
      *
      * @param value - The value to be rounded
      *
-     * @returns The value rounded
+     * @returns The rounded value
      */
     round(value) {
         return Utils.round(value, this.getFractionDigits());
@@ -408,7 +465,7 @@ export class Book {
     /**
      * Batch create [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be created
+     * @param transactions - The transactions to be created
      *
      * @returns The created Transactions
      */
@@ -424,8 +481,7 @@ export class Book {
     /**
      * Batch post [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be posted
-     *
+     * @param transactions - The transactions to be posted
      */
     batchPostTransactions(transactions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -437,12 +493,11 @@ export class Book {
     /**
      * Batch update [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be updated
+     * @param transactions - The transactions to be updated
      *
-     * @param updateChecked True to also update checked transactions
+     * @param updateChecked - True to also update checked transactions
      *
      * @returns The updated draft Transactions
-     *
      */
     batchUpdateTransactions(transactions, updateChecked) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -456,8 +511,7 @@ export class Book {
     /**
      * Batch check [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be checked
-     *
+     * @param transactions - The transactions to be checked
      */
     batchCheckTransactions(transactions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -469,8 +523,7 @@ export class Book {
     /**
      * Batch uncheck [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be unchecked
-     *
+     * @param transactions - The transactions to be unchecked
      */
     batchUncheckTransactions(transactions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -482,10 +535,8 @@ export class Book {
     /**
      * Batch trash [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be trashed
-     *
-     * @param trashChecked True to also trash checked transactions
-     *
+     * @param transactions - The transactions to be trashed
+     * @param trashChecked - True to also trash checked transactions
      */
     batchTrashTransactions(transactions, trashChecked) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -497,8 +548,7 @@ export class Book {
     /**
      * Batch untrash [[Transactions]] on the Book.
      *
-     * @param transactions The transactions to be untrashed
-     *
+     * @param transactions - The transactions to be untrashed
      */
     batchUntrashTransactions(transactions) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -509,6 +559,9 @@ export class Book {
     }
     /**
      * Replay [[Events]] on the Book, in batch.
+     *
+     * @param events - The events to be replayed
+     * @param errorOnly - True to only replay events with errors
      */
     batchReplayEvents(events, errorOnly) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -521,7 +574,9 @@ export class Book {
     /**
      * Create [[Accounts]] on the Book, in batch.
      *
-     * @return The created Accounts
+     * @param accounts - The accounts to be created
+     *
+     * @returns The created Accounts
      */
     batchCreateAccounts(accounts) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -543,7 +598,9 @@ export class Book {
     /**
      * Create [[Groups]] on the Book, in batch.
      *
-     * @return The created Groups
+     * @param groups - The groups to be created
+     *
+     * @returns The created Groups
      */
     batchCreateGroups(groups) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -569,9 +626,9 @@ export class Book {
         BookService.audit(this.getId());
     }
     /**
-     * Retrieve installed [[Apps]] for this Book
+     * Retrieve installed [[Apps]] for this Book.
      *
-     * @returns The Apps objects
+     * @returns The retrieved Apps objects
      */
     getApps() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -586,7 +643,7 @@ export class Book {
     /**
      * Gets the existing [[Integrations]] in the Book.
      *
-     * @returns The existing Integration objects
+     * @returns The retrieved Integration objects
      */
     getIntegrations() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -598,9 +655,9 @@ export class Book {
     /**
      * Creates a new [[Integration]] in the Book.
      *
-     * @param integration - The Integration object or wrapped plain json
+     * @param integration - The [[Integration]] object or wrapped plain json
      *
-     * @returns The created Integration object
+     * @returns The created [[Integration]] object
      */
     createIntegration(integration) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -616,9 +673,9 @@ export class Book {
     /**
      * Updates an existing [[Integration]] in the Book.
      *
-     * @param integration - The Integration wrapped plain json
+     * @param integration - The [[Integration]] wrapped plain json
      *
-     * @returns The updated Integration object
+     * @returns The updated [[Integration]] object
      */
     updateIntegration(integration) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -632,7 +689,7 @@ export class Book {
         });
     }
     /**
-     * Gets an [[Account]] object
+     * Gets an [[Account]] object.
      *
      * @param idOrName - The id or name of the Account
      *
@@ -746,7 +803,7 @@ export class Book {
         }
     }
     /**
-     * Gets a [[Group]] object
+     * Gets a [[Group]] object.
      *
      * @param idOrName - The id or name of the Group
      *
@@ -777,9 +834,9 @@ export class Book {
         });
     }
     /**
-     * Gets all [[Groups]] of this Book
+     * Gets all [[Groups]] of this Book.
      *
-     * @returns The retrieved Group objects
+     * @returns The retrieved [[Group]] objects
      */
     getGroups() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -807,9 +864,9 @@ export class Book {
         return groupsObj;
     }
     /**
-     * Gets all [[Accounts]] of this Book
+     * Gets all [[Accounts]] of this Book.
      *
-     * @returns The retrieved Account objects
+     * @returns The retrieved [[Account]] objects
      */
     getAccounts() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -895,10 +952,10 @@ export class Book {
      * Lists transactions in the Book based on the provided query, limit, and cursor, for pagination.
      *
      * @param query - The query string to filter transactions
-     * @param limit - The maximum number of transactions to return. Default to 100, max to 1000;
+     * @param limit - The maximum number of transactions to return. Default to 100, max to 1000
      * @param cursor - The cursor for pagination
      *
-     * @returns A TransactionPage object containing the list of transactions
+     * @returns A [[TransactionList]] object containing the list of transactions
      */
     listTransactions(query, limit, cursor) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -909,14 +966,14 @@ export class Book {
     /**
      * Lists events in the Book based on the provided parameters.
      *
-     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
-     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
-     * @param onError - True to search only for events on error.
-     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null.
-     * @param limit - The maximum number of events to return.
-     * @param cursor - The cursor for pagination. Can be null.
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null
+     * @param onError - True to search only for events on error
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null
+     * @param limit - The maximum number of events to return
+     * @param cursor - The cursor for pagination. Can be null
      *
-     * @returns An EventList object containing the list of events.
+     * @returns An [[EventList]] object containing the list of events
      */
     listEvents(afterDate, beforeDate, onError, resourceId, limit, cursor) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -925,7 +982,11 @@ export class Book {
         });
     }
     /**
-     * Retrieve a transaction by id
+     * Retrieve a transaction by id.
+     *
+     * @param id - The transaction ID
+     *
+     * @returns The [[Transaction]] object
      */
     getTransaction(id) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -938,7 +999,11 @@ export class Book {
         });
     }
     /**
-     * Retrieve a file by id
+     * Retrieve a file by id.
+     *
+     * @param id - The file ID
+     *
+     * @returns The [[File]] object
      */
     getFile(id) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -961,9 +1026,9 @@ export class Book {
     /**
      * Creates a copy of this Book
      *
-     * @param name The name for the copied book
-     * @param copyTransactions True to copy transactions from the source book (user must be the Book owner)
-     * @param fromDate Start date to consider if copying transactions (numeric value in YYYYMMDD format)
+     * @param name - The name for the copied book
+     * @param copyTransactions - True to copy transactions from the source book (user must be the Book owner)
+     * @param fromDate - Start date to consider if copying transactions (numeric value in YYYYMMDD format)
      *
      * @returns The copied Book object
      */
@@ -975,6 +1040,8 @@ export class Book {
     }
     /**
      * Perform update Book, applying pending changes.
+     *
+     * @returns The updated Book object
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -983,12 +1050,11 @@ export class Book {
         });
     }
     /**
+     * Create a [[BalancesReport]] based on query.
      *
-     * Create a [[BalancesReport]] based on query
+     * @param query - The balances report query
      *
-     * @param query The balances report query
-     *
-     * @return The balances report
+     * @returns The balances report
      *
      * Example:
      *
@@ -999,6 +1065,8 @@ export class Book {
      *
      * var accountBalance = balancesReport.getBalancesContainer("Bank Account").getCumulativeBalance();
      * ```
+     *
+     * @returns The retrieved [[BalancesReport]] object
      */
     getBalancesReport(query) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1007,7 +1075,9 @@ export class Book {
         });
     }
     /**
-     * @return The saved queries from this book
+     * Gets the saved queries from this book.
+     *
+     * @returns The saved queries from this book
      */
     getSavedQueries() {
         return __awaiter(this, void 0, void 0, function* () {