bkper-js 1.47.2 → 1.47.3

package/lib/model/Transaction.js

@@ -28,51 +28,65 @@ export class Transaction {
         };
     }
     /**
+     * Gets the JSON representation of the transaction.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {
         return Object.assign({}, this.payload);
     }
     /**
-     * @returns The book of the Transaction.
+     * Gets the book associated with this transaction.
+     *
+     * @returns The book of the Transaction
      */
     getBook() {
         return this.book;
     }
     /**
-     * @returns The id of the Transaction.
+     * Gets the unique identifier of the transaction.
+     *
+     * @returns The id of the Transaction
      */
     getId() {
         return this.payload.id;
     }
     /**
+     * Gets the unique identifier of the agent that created this transaction.
+     *
      * @returns The id of the agent that created this transaction
      */
     getAgentId() {
         return this.payload.agentId;
     }
     /**
+     * Gets the name of the agent that created this transaction.
+     *
      * @returns The name of the agent that created this transaction
      */
     getAgentName() {
         return this.payload.agentName;
     }
     /**
+     * Gets the logo URL of the agent that created this transaction.
+     *
      * @returns The logo of the agent that created this transaction
      */
     getAgentLogoUrl() {
         return this.payload.agentLogo;
     }
     /**
+     * Gets the dark mode logo URL of the agent that created this transaction.
+     *
      * @returns The logo of the agent that created this transaction in dark mode
      */
     getAgentLogoUrlDark() {
         return this.payload.agentLogoDark;
     }
     /**
-     * Remote ids are used to avoid duplication.
+     * Gets the remote IDs associated with this transaction. Remote ids are used to avoid duplication.
      *
-     * @returns The remote ids of the Transaction.
+     * @returns The remote ids of the Transaction
      */
     getRemoteIds() {
         return this.payload.remoteIds || [];
@@ -80,9 +94,9 @@ export class Transaction {
     /**
      * Add a remote id to the Transaction.
      *
-     * @param remoteId - The remote id to add.
+     * @param remoteId - The remote id to add
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     addRemoteId(remoteId) {
         if (this.payload.remoteIds == null) {
@@ -94,13 +108,17 @@ export class Transaction {
         return this;
     }
     /**
-     * @returns True if transaction was already posted to the accounts. False if is still a Draft.
+     * Checks if the transaction has been posted to the accounts.
+     *
+     * @returns True if transaction was already posted to the accounts. False if is still a Draft
      */
     isPosted() {
         return this.payload.posted;
     }
     /**
-     * @returns True if transaction is checked.
+     * Checks if the transaction is marked as checked.
+     *
+     * @returns True if transaction is checked
      */
     isChecked() {
         return this.payload.checked;
@@ -108,21 +126,25 @@ export class Transaction {
     /**
       * Set the check state of the Transaction.
       *
-      * @param checked - The check state.
+      * @param checked - The check state
       *
-      * @returns This Transaction, for chainning.
+      * @returns This Transaction, for chaining
     */
     setChecked(checked) {
         this.payload.checked = checked;
         return this;
     }
     /**
-     * @returns True if transaction is in trash.
+     * Checks if the transaction is in the trash.
+     *
+     * @returns True if transaction is in trash
      */
     isTrashed() {
         return this.payload.trashed;
     }
     /**
+     * Checks if the transaction is locked by the book's lock or closing date.
+     *
      * @returns True if a transaction is locked by the book lock/closing date
      */
     isLocked() {
@@ -131,13 +153,17 @@ export class Transaction {
         return lockOrClosingDate != null && (Utils.getIsoDateValue(lockOrClosingDate) >= Utils.getIsoDateValue(date));
     }
     /**
-     * @returns All #hashtags used on the transaction.
+     * Gets all hashtags used in the transaction.
+     *
+     * @returns All #hashtags used on the transaction
      */
     getTags() {
         return this.payload.tags || [];
     }
     /**
-     * @returns All urls of the transaction.
+     * Gets all URLs associated with the transaction.
+     *
+     * @returns All urls of the transaction
      */
     getUrls() {
         return this.payload.urls || [];
@@ -145,9 +171,9 @@ export class Transaction {
     /**
      * Sets the Transaction urls. Url starts with https://
      *
-     * @param urls - The urls array.
+     * @param urls - The urls array
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setUrls(urls) {
         this.payload.urls = undefined;
@@ -161,9 +187,9 @@ export class Transaction {
     /**
      * Add a url to the Transaction. Url starts with https://
      *
-     * @param url - The url to add.
+     * @param url - The url to add
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     addUrl(url) {
         if (this.payload.urls == null) {
@@ -175,7 +201,9 @@ export class Transaction {
         return this;
     }
     /**
-     * @returns The files attached to the transaction.
+     * Gets all files attached to the transaction.
+     *
+     * @returns The files attached to the transaction
      */
     getFiles() {
         if (this.payload.files && this.payload.files.length > 0) {
@@ -187,14 +215,13 @@ export class Transaction {
         }
     }
     /**
-     *
      * Adds a file attachment to the Transaction.
      *
      * Files MUST be previously created in the Book.
      *
      * @param file - The file to add
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     addFile(file) {
         if (this.payload.files == null) {
@@ -205,6 +232,10 @@ export class Transaction {
     }
     /**
      * Check if the transaction has the specified tag.
+     *
+     * @param tag - The tag to check for
+     *
+     * @returns True if the transaction has the specified tag
      */
     hasTag(tag) {
         var tags = this.getTags();
@@ -217,6 +248,8 @@ export class Transaction {
     }
     /**
      * Gets the custom properties stored in this Transaction.
+     *
+     * @returns Object with key/value pair properties
      */
     getProperties() {
         return this.payload.properties != null ? Object.assign({}, this.payload.properties) : {};
@@ -226,7 +259,7 @@ export class Transaction {
      *
      * @param properties - Object with key/value pair properties
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setProperties(properties) {
         this.payload.properties = Object.assign({}, properties);
@@ -236,6 +269,8 @@ export class Transaction {
      * Gets the property value for given keys. First property found will be retrieved
      *
      * @param keys - The property key
+     *
+     * @returns The property value or undefined if not found
      */
     getProperty(...keys) {
         for (let index = 0; index < keys.length; index++) {
@@ -248,8 +283,10 @@ export class Transaction {
         return undefined;
     }
     /**
-    * Gets the custom properties keys stored in this Transaction.
-    */
+     * Gets the custom properties keys stored in this Transaction.
+     *
+     * @returns Array of property keys
+     */
     getPropertyKeys() {
         let properties = this.getProperties();
         let propertyKeys = [];
@@ -269,7 +306,7 @@ export class Transaction {
      * @param key - The property key
      * @param value - The property value
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setProperty(key, value) {
         if (key == null || key.trim() == '') {
@@ -289,15 +326,16 @@ export class Transaction {
      *
      * @param key - The property key
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     deleteProperty(key) {
         this.setProperty(key, null);
         return this;
     }
-    //ORIGIN ACCOUNT
     /**
-     * @returns The credit account. The same as origin account.
+     * Gets the credit account associated with this Transaction. Same as origin account
+     *
+     * @returns The credit (origin) account
      */
     getCreditAccount() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -308,7 +346,9 @@ export class Transaction {
         });
     }
     /**
-     * @returns The credit account name.
+     * Gets the name of this Transaction's credit account.
+     *
+     * @returns The credit account name
      */
     getCreditAccountName() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -322,12 +362,11 @@ export class Transaction {
         });
     }
     /**
+     * Sets the credit/origin [[Account]] of this Transaction. Same as from()
      *
-     * Sets the credit/origin Account of the Transaction. Same as from().
-     *
-     * @param account - Account id, name or object.
+     * @param account - The Account object
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setCreditAccount(account) {
         if (account instanceof Account) {
@@ -343,20 +382,19 @@ export class Transaction {
         return this;
     }
     /**
+     * Sets the credit/origin [[Account]] of this Transaction. Same as setCreditAccount()
      *
-     * Sets the credit/origin Account of the Transaction. Same as setCreditAccount().
+     * @param account - The Account object
      *
-     * @param account - Account id, name or object.
-     *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     from(account) {
         return this.setCreditAccount(account);
     }
-    //DESTINATION ACCOUNT
     /**
-     * @returns The debit account. The same as destination account.
+     * Gets the debit account associated with this Transaction. Same as destination account
      *
+     * @returns The debit (destination) account
      */
     getDebitAccount() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -367,7 +405,9 @@ export class Transaction {
         });
     }
     /**
-     * @returns The debit account name.
+     * Gets the name of this Transaction's debit account.
+     *
+     * @returns The debit account name
      */
     getDebitAccountName() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -381,12 +421,11 @@ export class Transaction {
         });
     }
     /**
+     * Sets the debit/destination [[Account]] of this Transaction. Same as to()
      *
-     * Sets the debit/destination Account of the Transaction. Same as to().
-     *
-     * @param account - Account id, name or object.
+     * @param account - The Account object
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setDebitAccount(account) {
         if (account instanceof Account) {
@@ -402,25 +441,27 @@ export class Transaction {
         return this;
     }
     /**
+     * Sets the debit/destination [[Account]] of this Transaction. Same as setDebitAccount()
      *
-     * Sets the debit/destination Account of the Transaction. Same as setDebitAccount().
+     * @param account - The Account object
      *
-     * @param account - Account id, name or object.
-     *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     to(account) {
         return this.setDebitAccount(account);
     }
-    //AMOUNT
     /**
-     * @returns The amount of the transaction.
+     * Gets the amount of this Transaction.
+     *
+     * @returns The amount of this Transaction
      */
     getAmount() {
         return this.payload.amount != null && this.payload.amount.trim() != '' ? new Amount(this.payload.amount) : undefined;
     }
     /**
-     * @returns The amount of the transaction, formatted according to the Book format.
+     * Gets the formatted amount of this Transaction according to the Book format.
+     *
+     * @returns The amount of this Transaction, formatted according to the Book format
      */
     getAmountFormatted() {
         const amount = this.getAmount();
@@ -430,10 +471,11 @@ export class Transaction {
         return undefined;
     }
     /**
+     * Sets the amount of this Transaction.
      *
-     * Sets the amount of the Transaction.
+     * @param amount - The amount to set
      *
-     * @returns This Transaction, for chainning.
+     * @returns This Transaction, for chaining
      */
     setAmount(amount) {
         if (typeof amount == "string") {
@@ -450,9 +492,11 @@ export class Transaction {
         return this;
     }
     /**
-     * Get the absolute amount of this transaction if the given account is at the credit side, else null.
+     * Get the absolute amount of this Transaction if the given account is at the credit side.
+     *
+     * @param account - The account object, id or name
      *
-     * @param account - The account object, id or name.
+     * @returns The credit amount or undefined
      */
     getCreditAmount(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -464,9 +508,11 @@ export class Transaction {
         });
     }
     /**
-     * Gets the absolute amount of this transaction if the given account is at the debit side, else null.
+     * Gets the absolute amount of this Transaction if the given account is at the debit side.
      *
-     * @param account - The account object, id or name.
+     * @param account - The account object, id or name
+     *
+     * @returns The debit amount or undefined
      */
     getDebitAmount(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -480,7 +526,9 @@ export class Transaction {
     /**
      * Gets the [[Account]] at the other side of the transaction given the one in one side.
      *
-     * @param account - The account object, id or name.
+     * @param account - The account object, id or name
+     *
+     * @returns The account at the other side of the transaction
      */
     getOtherAccount(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -495,10 +543,11 @@ export class Transaction {
         });
     }
     /**
+     * The Account name at the other side of this Transaction given the one in one side.
      *
-     * The account name at the other side of the transaction given the one in one side.
+     * @param account - The Account object, id or name
      *
-     * @param account - The account object, id or name.
+     * @returns The name of the Account at the other side
      */
     getOtherAccountName(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -512,10 +561,11 @@ export class Transaction {
         });
     }
     /**
+     * Tell if the given account is credit on this Transaction
      *
-     * Tell if the given account is credit on the transaction
+     * @param account - The Account object
      *
-     * @param account - The account object
+     * @returns True if the account is the credit account
      */
     isCredit(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -524,10 +574,11 @@ export class Transaction {
         });
     }
     /**
+     * Tell if the given account is debit on the Transaction
      *
-     * Tell if the given account is debit on the transaction
+     * @param account - The [[Account]] object
      *
-     * @param account - The account object
+     * @returns True if the Account is the debit account
      */
     isDebit(account) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -544,9 +595,10 @@ export class Transaction {
             return yield this.book.getAccount(account);
         });
     }
-    //DESCRIPTION
     /**
-     * @returns The description of this transaction.
+     * Gets the description of this Transaction.
+     *
+     * @returns The description of this Transaction
      */
     getDescription() {
         if (this.payload.description == null) {
@@ -555,27 +607,30 @@ export class Transaction {
         return this.payload.description;
     }
     /**
-     *
      * Sets the description of the Transaction.
      *
-     * @returns This Transaction, for chainning.
+     * @param description - The description to set
+     *
+     * @returns This Transaction, for chaining
      */
     setDescription(description) {
         this.payload.description = description;
         return this;
     }
-    //DATE
     /**
-     * @returns The Transaction date, in ISO format yyyy-MM-dd.
+     * Gets the transaction date in ISO format.
+     *
+     * @returns The Transaction date, in ISO format yyyy-MM-dd
      */
     getDate() {
         return this.payload.date;
     }
     /**
-     *
      * Sets the date of the Transaction.
      *
-     * @returns This Transaction, for chainning
+     * @param date - The date to set as string or Date object
+     *
+     * @returns This Transaction, for chaining
      */
     setDate(date) {
         if (typeof date == "string") {
@@ -593,48 +648,61 @@ export class Transaction {
         return this;
     }
     /**
-     * @returns The Transaction Date object, on the time zone of the [[Book]].
+     * Gets the transaction date as a Date object in the book's timezone.
+     *
+     * @returns The Transaction Date object, on the time zone of the [[Book]]
      */
     getDateObject() {
         return Utils.convertValueToDate(this.getDateValue(), this.book.getTimeZoneOffset());
     }
     /**
-     * @returns The Transaction date number, in format YYYYMMDD.
+     * Gets the transaction date as a numeric value.
+     *
+     * @returns The Transaction date number, in format YYYYMMDD
      */
     getDateValue() {
         return this.payload.dateValue;
     }
     /**
-     * @returns The Transaction date, formatted on the date pattern of the [[Book]].
+     * Gets the transaction date formatted according to the book's date pattern.
+     *
+     * @returns The Transaction date, formatted on the date pattern of the [[Book]]
      */
     getDateFormatted() {
         return this.payload.dateFormatted;
     }
     /**
-     * @returns The date the transaction was created.
+     * Gets the date when the transaction was created.
+     *
+     * @returns The date the transaction was created
      */
     getCreatedAt() {
         return new Date(new Number(this.payload.createdAt).valueOf());
     }
     /**
-     * @returns The date the transaction was created, formatted according to the date pattern of the [[Book]].
+     * Gets the formatted creation date of the transaction.
+     *
+     * @returns The date the transaction was created, formatted according to the date pattern of the [[Book]]
      */
     getCreatedAtFormatted() {
         return Utils.formatDate(this.getCreatedAt(), this.book.getDatePattern() + " HH:mm:ss", this.book.getTimeZone());
     }
     /**
-     * @returns The date the transaction was last updated.
+     * Gets the date when the transaction was last updated.
+     *
+     * @returns The date the transaction was last updated
      */
     getUpdatedAt() {
         return new Date(new Number(this.payload.updatedAt).valueOf());
     }
     /**
-     * @returns The date the transaction was last updated, formatted according to the date pattern of the [[Book]].
+     * Gets the formatted last update date of the transaction.
+     *
+     * @returns The date the transaction was last updated, formatted according to the date pattern of the [[Book]]
      */
     getUpdatedAtFormatted() {
         return Utils.formatDate(this.getUpdatedAt(), this.book.getDatePattern() + " HH:mm:ss", this.book.getTimeZone());
     }
-    //EVOLVED BALANCES
     /** @internal */
     getCaEvolvedBalance_() {
         return this.payload.creditAccount != null && this.payload.creditAccount.balance != null ? new Amount(this.payload.creditAccount.balance) : undefined;
@@ -650,7 +718,9 @@ export class Transaction {
      *
      * Only comes with the last posted transaction of the day.
      *
-     * @param raw - True to get the raw balance, no matter the credit nature of the [[Account]].
+     * @param raw - True to get the raw balance, no matter the credit nature of the [[Account]]
+     *
+     * @returns The account balance at the transaction date
      */
     getAccountBalance(raw) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -674,6 +744,8 @@ export class Transaction {
     }
     /**
      * Perform create new draft transaction.
+     *
+     * @returns This Transaction, for chaining
      */
     create() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -683,7 +755,9 @@ export class Transaction {
         });
     }
     /**
-     * Upddate transaction, applying pending changes.
+     * Update transaction, applying pending changes.
+     *
+     * @returns This Transaction, for chaining
      */
     update() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -694,6 +768,8 @@ export class Transaction {
     }
     /**
      * Perform check transaction.
+     *
+     * @returns This Transaction, for chaining
      */
     check() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -705,6 +781,8 @@ export class Transaction {
     }
     /**
      * Perform uncheck transaction.
+     *
+     * @returns This Transaction, for chaining
      */
     uncheck() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -716,6 +794,8 @@ export class Transaction {
     }
     /**
      * Perform post transaction, changing credit and debit [[Account]] balances.
+     *
+     * @returns This Transaction, for chaining
      */
     post() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -726,6 +806,8 @@ export class Transaction {
     }
     /**
      * Trash the transaction.
+     *
+     * @returns This Transaction, for chaining
      */
     trash() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -737,6 +819,8 @@ export class Transaction {
     }
     /**
      * Untrash the transaction.
+     *
+     * @returns This Transaction, for chaining
      */
     untrash() {
         return __awaiter(this, void 0, void 0, function* () {