bkper-js 2.8.1 → 2.9.1

package/CHANGELOG.md

@@ -12,12 +12,14 @@ See what's new and what has changed in bkper-js
     * Enhanced type safety with explicit Config type usage throughout
     * Standardized `json()` method across resources for consistent JSON serialization
     * Maintained full backward compatibility - no breaking changes to existing APIs
+* Added `Account.isBalanceVerified`
 * Added `App.getOwnerWebsiteUrl`
 * Added `App.getReadme`
 * Added `App.getRepositoryUrl`
 * Added `App.getWebsiteUrl`
 * Added `App.isInstallable`
 * Added `App.isRepositoryPrivate`
+* Added `Book.getCollaborators`
 * Added `Collaborator`
 * Added `Collaborator.json`
 * Added `Collaborator.getId`
@@ -28,7 +30,7 @@ See what's new and what has changed in bkper-js
 * Added `Collaborator.create`
 * Added `Collaborator.update`
 * Added `Collaborator.remove`
-* Added `Book.getCollaborators`
+* Added `Group.isBalanceVerified`
 * Replaced axios with native Fetch API for better compatibility with multiple environments
 
 **August 2025**

package/lib/index.d.ts

@@ -18,12 +18,7 @@
 export declare class Account extends Resource<bkper.Account> {
 
     constructor(book: Book, payload?: bkper.Account);
-    /**
-     * Gets the configuration object for this Account.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the Account internal id.
      *
@@ -44,6 +39,12 @@ export declare class Account extends Resource<bkper.Account> {
      * @returns This Account, for chaining
      */
     setName(name: string): Account;
+    /**
+     * Tells if the balance of this Account has been verified/audited.
+     *
+     * @returns True if the balance of this Account has been verified/audited
+     */
+    isBalanceVerified(): boolean | undefined;
     /**
      * Gets the normalized name of this Account without spaces or special characters.
      *
@@ -444,12 +445,7 @@ export declare class Amount {
 export declare class App extends Resource<bkper.App> {
     private config?;
     constructor(payload?: bkper.App, config?: Config);
-    /**
-     * Gets the configuration object for this App.
-     *
-     * @returns The Config object for this App or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Sets the webhook url for development.
      *
@@ -1321,12 +1317,7 @@ export declare class Book extends Resource<bkper.Book> {
 
 
     constructor(payload?: bkper.Book, config?: Config);
-    /**
-     * Gets the configuration object for this Book.
-     *
-     * @returns The Config object for this Book or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the unique identifier of this Book.
      *
@@ -1960,12 +1951,7 @@ export declare enum BotResponseType {
 export declare class Collaborator extends Resource<bkper.Collaborator> {
 
     constructor(book: Book, payload?: bkper.Collaborator);
-    /**
-     * Gets the configuration object for this Collaborator.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the Collaborator internal id.
      *
@@ -2028,12 +2014,7 @@ export declare class Collaborator extends Resource<bkper.Collaborator> {
 export declare class Collection extends Resource<bkper.Collection> {
     private config?;
     constructor(payload?: bkper.Collection, config?: Config);
-    /**
-     * Gets the configuration object for this Collection.
-     *
-     * @returns The Config object for this Collection or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the unique identifier of this Collection.
      *
@@ -2169,12 +2150,7 @@ export declare interface Config {
 export declare class Connection extends Resource<bkper.Connection> {
     private config?;
     constructor(payload?: bkper.Connection, config?: Config);
-    /**
-     * Gets the configuration object for this Connection.
-     *
-     * @returns The Config object for this Connection or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the id of the Connection.
      *
@@ -2340,12 +2316,7 @@ export declare class Conversation extends Resource<bkper.Conversation> {
 
     private config?;
     constructor(agent: Agent, payload?: bkper.Conversation, config?: Config);
-    /**
-     * Gets the configuration object for this Conversation.
-     *
-     * @returns The Config object for this Conversation or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the Agent associated to this Conversation.
      *
@@ -2558,12 +2529,7 @@ export declare enum EventType {
 export declare class File extends Resource<bkper.File> {
 
     constructor(book: Book, payload?: bkper.File);
-    /**
-     * Gets the configuration object for this File.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the File id.
      *
@@ -2692,12 +2658,7 @@ export declare class Group extends Resource<bkper.Group> {
 
 
     constructor(book: Book, payload?: bkper.Group);
-    /**
-     * Gets the configuration object for this Group.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the id of this Group.
      *
@@ -2718,6 +2679,12 @@ export declare class Group extends Resource<bkper.Group> {
      * @returns This Group, for chaining
      */
     setName(name: string): Group;
+    /**
+     * Tells if the balance of this Group has been verified/audited.
+     *
+     * @returns True if the balance of this Group has been verified/audited
+     */
+    isBalanceVerified(): Promise<boolean | undefined>;
     /**
      * Tells if the Group is locked by the Book owner.
      *
@@ -2938,12 +2905,7 @@ export declare class Group extends Resource<bkper.Group> {
 export declare class Integration extends Resource<bkper.Integration> {
     private config?;
     constructor(payload?: bkper.Integration, config?: Config);
-    /**
-     * Gets the configuration object for this Integration.
-     *
-     * @returns The Config object for this Integration or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the [[Book]] id of the Integration.
      *
@@ -3054,12 +3016,7 @@ export declare class Message extends Resource<bkper.Message> {
 
 
     constructor(conversation: Conversation, payload?: bkper.Message, config?: Config);
-    /**
-     * Gets the configuration object for this Message.
-     *
-     * @returns The Config object from the parent Conversation
-     */
-    getConfig(): Config;
+
     /**
      * Gets the Message universal identifier.
      *
@@ -3265,12 +3222,7 @@ export declare enum Permission {
 export declare class Query extends Resource<bkper.Query> {
 
     constructor(book: Book, payload?: bkper.Query);
-    /**
-     * Gets the configuration object for this Query.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the Query universal identifier.
      *
@@ -3347,14 +3299,7 @@ declare abstract class Resource<T = any> {
      * @returns An immutable copy of the json payload
      */
     json(): T;
-    /**
-     * Gets the effective configuration for this resource.
-     * Each resource must implement this to either:
-     * - Return its own config (for root containers like Book, Collection)
-     * - Delegate to its container (for contained resources like Account, Transaction)
-     * @returns The resolved configuration
-     */
-    abstract getConfig(): Config;
+
 }
 
 /**
@@ -3367,12 +3312,7 @@ declare abstract class Resource<T = any> {
 export declare class Template extends Resource<bkper.Template> {
     private config?;
     constructor(json?: bkper.Template, config?: Config);
-    /**
-     * Gets the configuration object for this Template.
-     *
-     * @returns The Config object for this Template or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the name of the Template.
      *
@@ -3434,12 +3374,7 @@ export declare class Template extends Resource<bkper.Template> {
 export declare class Transaction extends Resource<bkper.Transaction> {
 
     constructor(book: Book, payload?: bkper.Transaction);
-    /**
-     * Gets the configuration object for this Transaction.
-     *
-     * @returns The Config object from the parent Book
-     */
-    getConfig(): Config;
+
     /**
      * Gets the book associated with this transaction.
      *
@@ -3937,12 +3872,7 @@ export declare class TransactionList {
 export declare class User extends Resource<bkper.User> {
     private config?;
     constructor(payload?: bkper.User, config?: Config);
-    /**
-     * Gets the configuration object for this User.
-     *
-     * @returns The Config object for this User or the global config
-     */
-    getConfig(): Config;
+
     /**
      * Gets the id of the User.
      *

package/lib/model/Account.js

@@ -26,11 +26,7 @@ export class Account extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this Account.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }
@@ -61,6 +57,14 @@ export class Account extends Resource {
         this.payload.name = name;
         return this;
     }
+    /**
+     * Tells if the balance of this Account has been verified/audited.
+     *
+     * @returns True if the balance of this Account has been verified/audited
+     */
+    isBalanceVerified() {
+        return this.payload.balanceVerified;
+    }
     /**
      * Gets the normalized name of this Account without spaces or special characters.
      *

package/lib/model/App.js

@@ -22,11 +22,7 @@ export class App extends Resource {
         super(payload);
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this App.
-     *
-     * @returns The Config object for this App or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Book.js

@@ -51,11 +51,7 @@ export class Book extends Resource {
         this.mapGroups(this.payload.groups);
         this.mapAccounts(this.payload.accounts);
     }
-    /**
-     * Gets the configuration object for this Book.
-     *
-     * @returns The Config object for this Book or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Collaborator.js

@@ -21,11 +21,7 @@ export class Collaborator extends Resource {
         super(payload);
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this Collaborator.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Collection.js

@@ -21,11 +21,7 @@ export class Collection extends Resource {
         super(payload);
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this Collection.
-     *
-     * @returns The Config object for this Collection or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Connection.js

@@ -21,11 +21,7 @@ export class Connection extends Resource {
         super(payload);
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this Connection.
-     *
-     * @returns The Config object for this Connection or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Conversation.js

@@ -25,11 +25,7 @@ export class Conversation extends Resource {
         this.agent = agent;
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this Conversation.
-     *
-     * @returns The Config object for this Conversation or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/File.js

@@ -22,11 +22,7 @@ export class File extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this File.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Group.js

@@ -27,11 +27,7 @@ export class Group extends Resource {
         this.children = new Map();
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this Group.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }
@@ -62,6 +58,22 @@ export class Group extends Resource {
         this.payload.name = name;
         return this;
     }
+    /**
+     * Tells if the balance of this Group has been verified/audited.
+     *
+     * @returns True if the balance of this Group has been verified/audited
+     */
+    isBalanceVerified() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const accounts = yield this.getAccounts();
+            for (const account of accounts) {
+                if (!account.isBalanceVerified()) {
+                    return false;
+                }
+            }
+            return true;
+        });
+    }
     /**
      * Tells if the Group is locked by the Book owner.
      *

package/lib/model/Integration.js

@@ -20,11 +20,7 @@ export class Integration extends Resource {
         super(payload || {});
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this Integration.
-     *
-     * @returns The Config object for this Integration or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Message.js

@@ -23,11 +23,7 @@ export class Message extends Resource {
         super(payload || {});
         this.conversation = conversation;
     }
-    /**
-     * Gets the configuration object for this Message.
-     *
-     * @returns The Config object from the parent Conversation
-     */
+    /** @internal */
     getConfig() {
         return this.conversation.getConfig();
     }

package/lib/model/Query.js

@@ -21,11 +21,7 @@ export class Query extends Resource {
         super(payload);
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this Query.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/Template.js

@@ -12,11 +12,7 @@ export class Template extends Resource {
         super(json);
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this Template.
-     *
-     * @returns The Config object for this Template or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/model/Transaction.js

@@ -26,11 +26,7 @@ export class Transaction extends Resource {
         super(payload || { createdAt: `${Date.now()}` });
         this.book = book;
     }
-    /**
-     * Gets the configuration object for this Transaction.
-     *
-     * @returns The Config object from the parent Book
-     */
+    /** @internal */
     getConfig() {
         return this.book.getConfig();
     }

package/lib/model/User.js

@@ -25,11 +25,7 @@ export class User extends Resource {
         super(payload);
         this.config = config;
     }
-    /**
-     * Gets the configuration object for this User.
-     *
-     * @returns The Config object for this User or the global config
-     */
+    /** @internal */
     getConfig() {
         return this.config || Bkper.globalConfig;
     }

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.50.0"
+      "packageVersion": "7.52.12"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.8.1",
+  "version": "2.9.1",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -34,7 +34,7 @@
     "postversion": "git push --tags && yarn publish --new-version $npm_package_version && git push && echo \"Successfully released version $npm_package_version!\""
   },
   "peerDependencies": {
-    "@bkper/bkper-api-types": "^5.25.0"
+    "@bkper/bkper-api-types": "^5.26.0"
   },
   "dependencies": {
     "big.js": "^6.0.3",
@@ -42,7 +42,7 @@
     "luxon": "^1.25.0"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.12.1",
+    "@microsoft/api-extractor": "^7.52.12",
     "@types/big.js": "^6.0.2",
     "@types/chai": "^4.2.14",
     "@types/luxon": "^1.25.1",