bkper-js 1.47.2 → 2.0.0

package/lib/model/TransactionList.js

@@ -10,6 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Transaction } from "./Transaction.js";
 /**
  * A list associated with a transaction query.
+ *
+ * @public
  */
 export class TransactionList {
     constructor(book, payload) {
@@ -17,13 +19,17 @@ export class TransactionList {
         this.payload = payload || {};
     }
     /**
-     * @returns The cursor associated with the query for pagination.
+     * Gets the cursor associated with the query for pagination.
+     *
+     * @returns The cursor associated with the query for pagination
      */
     getCursor() {
         return this.payload.cursor;
     }
     /**
      * Retrieves the account associated with the query, when filtering by account.
+     *
+     * @returns The account associated with the query, or undefined if not set
      */
     getAccount() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -34,26 +40,27 @@ export class TransactionList {
         });
     }
     /**
-     * @returns The first Transaction in the list.
+     * Gets the first Transaction in the list.
+     *
+     * @returns The first Transaction in the list
      */
     getFirst() {
         const transactions = this.getItems();
         return transactions.length > 0 ? transactions[0] : undefined;
     }
     /**
+     * Gets the total number of transactions in the list.
      *
-     * Get the total number of transactions in the list.
-     *
-     * @returns The total number of transactions.
+     * @returns The total number of transactions
      */
     size() {
         var _a;
         return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
     }
     /**
-     * Get the transactions in the list.
+     * Gets the transactions in the list.
      *
-     * @returns An array of Transaction objects.
+     * @returns An array of Transaction objects
      */
     getItems() {
         var _a;

package/lib/model/User.js

@@ -10,7 +10,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import { Connection } from "./Connection.js";
 import * as ConnectionService from '../service/connection-service.js';
 /**
- * This class defines a User.
+ * This class defines a User on the Bkper platform.
+ *
+ * Users can own and collaborate on [[Books]], manage [[Collections]], and connect to external services through [[Connections]].
+ *
+ * Each User has a unique identity, subscription plan details, and access permissions across the platform.
  *
  * @public
  */
@@ -20,6 +24,8 @@ export class User {
         this.payload = payload || {};
     }
     /**
+     * Gets an immutable copy of the JSON payload for this User.
+     *
      * @returns An immutable copy of the json payload
      */
     json() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bkper-js",
-  "version": "1.47.2",
+  "version": "2.0.0",
   "description": "Javascript client for Bkper REST API",
   "main": "./lib/index.js",
   "module": "./lib/index.js",