bkper-js 2.21.0 → 2.23.0

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 See what's new and what has changed in bkper-js
 
+## 2026
+
+**January 2026**
+- Added `App.setUsers`
+- Added `App.getUsers`
+- Added `App.setDevelopers`
+- Added `App.getDevelopers`
+- Added `Config.agentIdProvider`
+- Added `Billing`
+- Added `Billing.getAdminEmail`
+- Added `Billing.getDaysLeftInTrial`
+- Added `Billing.getPlan`
+- Added `Billing.getTotalTransactionsThisMonth`
+- Added `Billing.getTotalTransactionsThisYear`
+- Added `Billing.hasStartedTrial`
+- Added `Billing.isEnabled`
+- Added `Billing.isPlanOverdue`
+- Added `User.getBilling`
+- Added `User.getUsername`
+- Removed `App.setUserEmails` from `App`. Use `App.setUsers` instead
+- Removed `App.setDeveloperEmail` from `App`. Use `App.setDevelopers` instead
+- Removed `User.getDaysLeftInTrial` from `User`. Use `Billing.getDaysLeftInTrial` instead
+- Removed `User.getPlan` from `User`. Use `Billing.getPlan` instead
+- Removed `User.hasBillingEnabled` from `User`. Use `Billing.isEnabled` instead
+- Removed `User.hasStartedTrial` from `User`. Use `Billing.hasStartedTrial` instead
+- Removed `User.isFree` from `User`. Use `Billing.getPlan` instead
+
 ## 2025
 
 **December 2025**

package/lib/index.d.ts

@@ -1165,6 +1165,81 @@ export declare enum BalanceType {
     CUMULATIVE = "CUMULATIVE"
 }
 
+/**
+ * This class defines the Billing information for a [[User]].
+ *
+ * The Billing information includes the plan, the admin email, and the billing portal URL.
+ *
+ * @public
+ */
+export declare class Billing extends Resource<bkper.Billing> {
+    private config?;
+    constructor(json?: bkper.Billing, config?: Config);
+
+    /**
+     * Tells if billing is enabled for the User.
+     *
+     * @returns True if billing is enabled for the User
+     */
+    isEnabled(): boolean | undefined;
+    /**
+     * Gets the current plan of the User.
+     *
+     * @returns The User's plan
+     */
+    getPlan(): string | undefined;
+    /**
+     * Tells if the User's current plan payment is overdue.
+     *
+     * @returns True if the plan payment is overdue
+     */
+    isPlanOverdue(): boolean | undefined;
+    /**
+     * Gets the admin email for this User's billing account.
+     *
+     * @returns The billing admin email
+     */
+    getAdminEmail(): string | undefined;
+    /**
+     * Tells if the User has started the trial period.
+     *
+     * @returns True if the User has started the trial period
+     */
+    hasStartedTrial(): boolean | undefined;
+    /**
+     * Gets the number of days left in User's trial period.
+     *
+     * @returns The number of days left in trial period
+     */
+    getDaysLeftInTrial(): number | undefined;
+    /**
+     * Gets the number of total transactions this month for the User's billing account.
+     *
+     * @returns The number of total transactions this month
+     */
+    getTotalTransactionsThisMonth(): number | undefined;
+    /**
+     * Gets the number of total transactions this year for the User's billing account.
+     *
+     * @returns The number of total transactions this year
+     */
+    getTotalTransactionsThisYear(): number | undefined;
+    /**
+     * Gets the transaction counts associated to the User's billing account.
+     *
+     * @returns The transaction counts associated to the User's billing account
+     */
+    getCounts(): Promise<bkper.Counts>;
+    /**
+     * Gets the URL to redirect the User to the billing portal.
+     *
+     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
+     *
+     * @returns The URL to redirect the User to the billing portal
+     */
+    getPortalUrl(returnUrl: string): Promise<string | undefined>;
+}
+
 /**
  * This is the main entry point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
@@ -1266,14 +1341,6 @@ export declare class Bkper {
      * @returns The retrieved User
      */
     getUser(): Promise<User>;
-    /**
-     * Gets the URL to redirect the User to the billing portal.
-     *
-     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
-     *
-     * @returns The URL to redirect the User to the billing portal
-     */
-    getBillingPortalUrl(returnUrl: string): Promise<string | undefined>;
 }
 
 /**
@@ -3688,65 +3755,17 @@ export declare class User extends Resource<bkper.User> {
      */
     getUsername(): string | undefined;
     /**
-     * Tells if the User is in the free plan.
-     *
-     * @returns True if the User is in the free plan
-     */
-    isFree(): boolean | undefined;
-    /**
-     * Gets the plan of the User.
-     *
-     * @returns The User's plan
-     */
-    getPlan(): string | undefined;
-    /**
-     * Tells if the User's subscription payment is overdue.
+     * Gets the billing information for this User.
      *
-     * @returns True if the subscription payment is overdue
+     * @returns The User's billing information
      */
-    isPlanOverdue(): boolean | undefined;
-    /**
-     * Tells if billing is enabled for the User.
-     *
-     * @returns True if billing is enabled for the User
-     */
-    hasBillingEnabled(): boolean | undefined;
-    /**
-     * Gets the billing admin email for this User's billing account.
-     *
-     * @returns The billing admin email
-     */
-    getBillingAdminEmail(): string | 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;
+    getBilling(): Promise<Billing>;
     /**
      * Tells if the User has already used [[Connections]].
      *
      * @returns True if the User has already used Connections
      */
     hasUsedConnections(): boolean | undefined;
-    /**
-     * Gets the User's total transactions this month.
-     *
-     * @returns The total transactions this month
-     */
-    getTotalTransactionsThisMonth(): number | undefined;
-    /**
-     * Gets the User's total transactions this year.
-     *
-     * @returns The total transactions this year
-     */
-    getTotalTransactionsThisYear(): number | undefined;
     /**
      * Gets the [[Connections]] of the User.
      *

package/lib/index.js

@@ -13,6 +13,7 @@ export { Backlog } from "./model/Backlog.js";
 export { Balance } from "./model/Balance.js";
 export { BalancesDataTableBuilder } from "./model/BalancesDataTableBuilder.js";
 export { BalancesReport } from "./model/BalancesReport.js";
+export { Billing } from "./model/Billing.js";
 export { Bkper } from "./model/Bkper.js";
 export { Book } from "./model/Book.js";
 export { Collaborator } from "./model/Collaborator.js";

package/lib/model/Billing.js

@@ -0,0 +1,118 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { Resource } from "./Resource.js";
+import { Bkper } from "./Bkper.js";
+import * as UserService from "../service/user-service.js";
+/**
+ * This class defines the Billing information for a [[User]].
+ *
+ * The Billing information includes the plan, the admin email, and the billing portal URL.
+ *
+ * @public
+ */
+export class Billing extends Resource {
+    constructor(json, config) {
+        super(json);
+        this.config = config;
+    }
+    /** @internal */
+    getConfig() {
+        return this.config || Bkper.globalConfig;
+    }
+    /**
+     * Tells if billing is enabled for the User.
+     *
+     * @returns True if billing is enabled for the User
+     */
+    isEnabled() {
+        return this.payload.enabled;
+    }
+    /**
+     * Gets the current plan of the User.
+     *
+     * @returns The User's plan
+     */
+    getPlan() {
+        return this.payload.plan;
+    }
+    /**
+     * Tells if the User's current plan payment is overdue.
+     *
+     * @returns True if the plan payment is overdue
+     */
+    isPlanOverdue() {
+        return this.payload.planOverdue;
+    }
+    /**
+     * Gets the admin email for this User's billing account.
+     *
+     * @returns The billing admin email
+     */
+    getAdminEmail() {
+        return this.payload.adminEmail;
+    }
+    /**
+     * Tells if the User has started the trial period.
+     *
+     * @returns True if the User has started the trial period
+     */
+    hasStartedTrial() {
+        return this.payload.startedTrial;
+    }
+    /**
+     * Gets the number of days left in User's trial period.
+     *
+     * @returns The number of days left in trial period
+     */
+    getDaysLeftInTrial() {
+        return this.payload.daysLeftInTrial;
+    }
+    /**
+     * Gets the number of total transactions this month for the User's billing account.
+     *
+     * @returns The number of total transactions this month
+     */
+    getTotalTransactionsThisMonth() {
+        return this.payload.totalTransactionsThisMonth;
+    }
+    /**
+     * Gets the number of total transactions this year for the User's billing account.
+     *
+     * @returns The number of total transactions this year
+     */
+    getTotalTransactionsThisYear() {
+        return this.payload.totalTransactionsThisYear;
+    }
+    /**
+     * Gets the transaction counts associated to the User's billing account.
+     *
+     * @returns The transaction counts associated to the User's billing account
+     */
+    getCounts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const countsPayload = yield UserService.getBillingCounts(this.getConfig());
+            return countsPayload;
+        });
+    }
+    /**
+     * Gets the URL to redirect the User to the billing portal.
+     *
+     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
+     *
+     * @returns The URL to redirect the User to the billing portal
+     */
+    getPortalUrl(returnUrl) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const urlPayload = yield UserService.getBillingPortalUrl(returnUrl, this.getConfig());
+            return urlPayload.url;
+        });
+    }
+}
+//# sourceMappingURL=Billing.js.map

package/lib/model/Bkper.js

@@ -152,19 +152,6 @@ export class Bkper {
             return new User(user, this.config);
         });
     }
-    /**
-     * Gets the URL to redirect the User to the billing portal.
-     *
-     * @param returnUrl - The URL to return to after the User has been redirected to the billing portal
-     *
-     * @returns The URL to redirect the User to the billing portal
-     */
-    getBillingPortalUrl(returnUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let url = yield UserService.getBillingPortalUrl(returnUrl, this.config);
-            return url.url;
-        });
-    }
 }
 /** @internal */
 Bkper.globalConfig = {};

package/lib/model/User.js

@@ -11,6 +11,8 @@ import { Connection } from "./Connection.js";
 import { Resource } from "./Resource.js";
 import { Bkper } from "./Bkper.js";
 import * as ConnectionService from "../service/connection-service.js";
+import * as UserService from "../service/user-service.js";
+import { Billing } from "./Billing.js";
 /**
  * This class defines a User on the Bkper platform.
  *
@@ -86,60 +88,15 @@ export class User extends Resource {
         return this.payload.username;
     }
     /**
-     * Tells if the User is in the free plan.
+     * Gets the billing information for this User.
      *
-     * @returns True if the User is in the free plan
+     * @returns The User's billing information
      */
-    isFree() {
-        return this.payload.free;
-    }
-    /**
-     * Gets the plan of the User.
-     *
-     * @returns The User's plan
-     */
-    getPlan() {
-        return this.payload.plan;
-    }
-    /**
-     * Tells if the User's subscription payment is overdue.
-     *
-     * @returns True if the subscription payment is overdue
-     */
-    isPlanOverdue() {
-        return this.payload.planOverdue;
-    }
-    /**
-     * Tells if billing is enabled for the User.
-     *
-     * @returns True if billing is enabled for the User
-     */
-    hasBillingEnabled() {
-        return this.payload.billingEnabled;
-    }
-    /**
-     * Gets the billing admin email for this User's billing account.
-     *
-     * @returns The billing admin email
-     */
-    getBillingAdminEmail() {
-        return this.payload.billingAdminEmail;
-    }
-    /**
-     * Tells if the User has started the trial.
-     *
-     * @returns True if the User has started the trial
-     */
-    hasStartedTrial() {
-        return this.payload.startedTrial;
-    }
-    /**
-     * Gets the days left in User's trial.
-     *
-     * @returns The User's days left in trial
-     */
-    getDaysLeftInTrial() {
-        return this.payload.daysLeftInTrial;
+    getBilling() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const payload = yield UserService.getBilling(this.getConfig());
+            return new Billing(payload, this.config);
+        });
     }
     /**
      * Tells if the User has already used [[Connections]].
@@ -149,22 +106,6 @@ export class User extends Resource {
     hasUsedConnections() {
         return this.payload.bankConnections;
     }
-    /**
-     * Gets the User's total transactions this month.
-     *
-     * @returns The total transactions this month
-     */
-    getTotalTransactionsThisMonth() {
-        return this.payload.totalTransactionsThisMonth;
-    }
-    /**
-     * Gets the User's total transactions this year.
-     *
-     * @returns The total transactions this year
-     */
-    getTotalTransactionsThisYear() {
-        return this.payload.totalTransactionsThisYear;
-    }
     /**
      * Gets the [[Connections]] of the User.
      *

package/lib/service/user-service.js

@@ -14,6 +14,18 @@ export function getUser(config) {
         return res.data;
     });
 }
+export function getBilling(config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield new HttpApiV5Request(`user/billing`, config).setMethod('GET').fetch();
+        return res.data;
+    });
+}
+export function getBillingCounts(config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const res = yield new HttpApiV5Request(`user/billing/counts`, config).setMethod('GET').fetch();
+        return res.data;
+    });
+}
 export function getBillingPortalUrl(returnUrl, config) {
     return __awaiter(this, void 0, void 0, function* () {
         const res = yield new HttpApiV5Request(`user/billing/portal`, config).addParam('returnUrl', returnUrl).fetch();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "2.21.0",
+  "version": "2.23.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",
@@ -35,7 +35,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.33.0"
+    "@bkper/bkper-api-types": "^5.34.0"
   },
   "dependencies": {
     "big.js": "^6.0.3",