bkper-js 2.35.2 → 2.37.0

package/lib/index.d.ts

@@ -2020,6 +2020,15 @@ export declare class Book extends ResourceProperty<bkper.Book> {
      * @returns A [[TransactionList]] object containing the list of transactions
      */
     listTransactions(query?: string, limit?: number, cursor?: string): Promise<TransactionList>;
+    /**
+     * Lists files in the Book, for pagination.
+     *
+     * @param limit - The maximum number of files to return. Default to 100
+     * @param cursor - The cursor for pagination
+     *
+     * @returns A [[FileList]] object containing the list of files
+     */
+    listFiles(limit?: number, cursor?: string): Promise<FileList>;
     /**
      * Retrieve the number of transactions based on a query.
      *
@@ -2565,7 +2574,7 @@ export declare class Connection extends ResourceProperty<bkper.Connection> {
      *
      * @returns The Connection type
      */
-    getType(): "APP" | "BANK" | undefined;
+    getType(): 'APP' | 'BANK' | undefined;
     /**
      * Sets the Connection type.
      *
@@ -2573,7 +2582,7 @@ export declare class Connection extends ResourceProperty<bkper.Connection> {
      *
      * @returns The Connection, for chaining
      */
-    setType(type: "APP" | "BANK"): Connection;
+    setType(type: 'APP' | 'BANK'): Connection;
     /**
      * Cleans any token property stored in the Connection.
      */
@@ -2590,6 +2599,12 @@ export declare class Connection extends ResourceProperty<bkper.Connection> {
      * @returns The created Connection, for chaining
      */
     create(): Promise<Connection>;
+    /**
+     * Performs update Connection.
+     *
+     * @returns The updated Connection object
+     */
+    update(): Promise<Connection>;
     /**
      * Performs remove Connection.
      *
@@ -2849,6 +2864,41 @@ export declare class File extends ResourceProperty<bkper.File> {
     update(): Promise<File>;
 }
 
+/**
+ * A list associated with a file query.
+ *
+ * @public
+ */
+export declare class FileList {
+    private payload;
+
+    constructor(book: Book, payload: bkper.FileList);
+    /**
+     * Gets the cursor associated with the query for pagination.
+     *
+     * @returns The cursor associated with the query for pagination
+     */
+    getCursor(): string | undefined;
+    /**
+     * Gets the first File in the list.
+     *
+     * @returns The first File in the list
+     */
+    getFirst(): File | undefined;
+    /**
+     * Gets the total number of files in the list.
+     *
+     * @returns The total number of files
+     */
+    size(): number;
+    /**
+     * Gets the files in the list.
+     *
+     * @returns An array of File objects
+     */
+    getItems(): File[];
+}
+
 /**
  * This class defines a Group of [[Accounts]].
  *
@@ -3153,6 +3203,14 @@ export declare class Integration extends ResourceProperty<bkper.Integration> {
      * @returns The Integration's name
      */
     getName(): string | undefined;
+    /**
+     * Sets the name of the Integration.
+     *
+     * @param name - The name of the Integration
+     *
+     * @returns The Integration, for chaining
+     */
+    setName(name: string): Integration;
     /**
      * Gets the name of the user who added the Integration.
      *
@@ -3197,6 +3255,12 @@ export declare class Integration extends ResourceProperty<bkper.Integration> {
      * @returns The Integration last update date in milliseconds
      */
     getLastUpdateMs(): string | undefined;
+    /**
+     * Performs update Integration.
+     *
+     * @returns The updated Integration object
+     */
+    update(): Promise<Integration>;
     /**
      * Performs remove Integration.
      *
@@ -3413,6 +3477,16 @@ declare abstract class Resource<T = any> {
  * Extends Resource<T> and adds property management methods for entities
  * that have a properties field in their payload.
  *
+ * Custom property keys are normalized and validated by the Bkper API when
+ * resources are persisted:
+ *
+ * - Keys can have up to 30 characters after normalization.
+ * - Keys are normalized to lowercase, spaces become underscores, and unsupported
+ *   punctuation is removed.
+ * - Keys ending with an underscore (`_`) are treated as hidden/internal by SDK
+ *   visible-property helpers.
+ * - Empty, null, or undefined values clear the property when saved.
+ *
  * @public
  */
 declare abstract class ResourceProperty<T extends {
@@ -3450,6 +3524,10 @@ declare abstract class ResourceProperty<T extends {
     /**
      * Sets a custom property in this resource.
      *
+     * Property keys are normalized and validated by the API when saved. Keep keys
+     * to 30 characters or fewer after normalization. Use a trailing underscore
+     * (`_`) for hidden/internal properties.
+     *
      * @param key - The property key
      * @param value - The property value, or null/undefined to clean it
      *

package/lib/index.js

@@ -22,6 +22,7 @@ export { Collaborator } from './model/Collaborator.js';
 export { Collection } from './model/Collection.js';
 export { Connection } from './model/Connection.js';
 export { File } from './model/File.js';
+export { FileList } from './model/FileList.js';
 export { Group } from './model/Group.js';
 export { GroupsDataTableBuilder } from './builders/GroupsDataTableBuilder.js';
 export { Integration } from './model/Integration.js';

package/lib/model/Book.js

@@ -25,6 +25,7 @@ import { Collection } from './Collection.js';
 import { Permission } from './Enums.js';
 import { EventList } from './EventList.js';
 import { File } from './File.js';
+import { FileList } from './FileList.js';
 import { Group } from './Group.js';
 import { Integration } from './Integration.js';
 import { Transaction } from './Transaction.js';
@@ -1150,6 +1151,20 @@ export class Book extends ResourceProperty {
             return new TransactionList(this, transactionsList);
         });
     }
+    /**
+     * Lists files in the Book, for pagination.
+     *
+     * @param limit - The maximum number of files to return. Default to 100
+     * @param cursor - The cursor for pagination
+     *
+     * @returns A [[FileList]] object containing the list of files
+     */
+    listFiles(limit, cursor) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fileList = yield FileService.listFiles(this.getId(), limit, cursor, this.getConfig());
+            return new FileList(this, fileList);
+        });
+    }
     /**
      * Retrieve the number of transactions based on a query.
      *

package/lib/model/Connection.js

@@ -7,10 +7,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { ResourceProperty } from "./ResourceProperty.js";
-import { Bkper } from "./Bkper.js";
-import * as ConnectionService from "../service/connection-service.js";
-import { Integration } from "./Integration.js";
+import { ResourceProperty } from './ResourceProperty.js';
+import { Bkper } from './Bkper.js';
+import * as ConnectionService from '../service/connection-service.js';
+import { Integration } from './Integration.js';
 /**
  * This class defines a Connection from an [[User]] to an external service.
  *
@@ -138,8 +138,8 @@ export class Connection extends ResourceProperty {
      */
     clearTokenProperties() {
         this.getPropertyKeys()
-            .filter((key) => key.includes("token"))
-            .forEach((key) => this.deleteProperty(key));
+            .filter(key => key.includes('token'))
+            .forEach(key => this.deleteProperty(key));
     }
     /**
      * Gets the existing [[Integrations]] on the Connection.
@@ -153,7 +153,7 @@ export class Connection extends ResourceProperty {
                 return [];
             }
             const integrationsPlain = yield ConnectionService.listIntegrations(id, this.getConfig());
-            const integrations = integrationsPlain.map((i) => new Integration(i, this.config));
+            const integrations = integrationsPlain.map(i => new Integration(i, this.config));
             return integrations;
         });
     }
@@ -168,6 +168,17 @@ export class Connection extends ResourceProperty {
             return this;
         });
     }
+    /**
+     * Performs update Connection.
+     *
+     * @returns The updated Connection object
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.payload = yield ConnectionService.updateConnection(this.payload, this.getConfig());
+            return this;
+        });
+    }
     /**
      * Performs remove Connection.
      *

package/lib/model/FileList.js

@@ -0,0 +1,52 @@
+import { File } from './File.js';
+/**
+ * A list associated with a file query.
+ *
+ * @public
+ */
+export class FileList {
+    constructor(book, payload) {
+        this.book = book;
+        this.payload = payload || {};
+    }
+    /**
+     * Gets the cursor associated with the query for pagination.
+     *
+     * @returns The cursor associated with the query for pagination
+     */
+    getCursor() {
+        return this.payload.cursor;
+    }
+    /**
+     * Gets the first File in the list.
+     *
+     * @returns The first File in the list
+     */
+    getFirst() {
+        const files = this.getItems();
+        return files.length > 0 ? files[0] : undefined;
+    }
+    /**
+     * Gets the total number of files in the list.
+     *
+     * @returns The total number of files
+     */
+    size() {
+        var _a;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
+    }
+    /**
+     * Gets the files in the list.
+     *
+     * @returns An array of File objects
+     */
+    getItems() {
+        var _a;
+        const files = [];
+        for (const file of (_a = this.payload.items) !== null && _a !== void 0 ? _a : []) {
+            files.push(new File(this.book, file));
+        }
+        return files;
+    }
+}
+//# sourceMappingURL=FileList.js.map

package/lib/model/Integration.js

@@ -7,9 +7,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import * as IntegrationService from "../service/integration-service.js";
-import { ResourceProperty } from "./ResourceProperty.js";
-import { Bkper } from "./Bkper.js";
+import * as IntegrationService from '../service/integration-service.js';
+import { ResourceProperty } from './ResourceProperty.js';
+import { Bkper } from './Bkper.js';
 /**
  * This class defines a Integration from an [[User]] to an external service.
  *
@@ -48,6 +48,17 @@ export class Integration extends ResourceProperty {
     getName() {
         return this.payload.name;
     }
+    /**
+     * Sets the name of the Integration.
+     *
+     * @param name - The name of the Integration
+     *
+     * @returns The Integration, for chaining
+     */
+    setName(name) {
+        this.payload.name = name;
+        return this;
+    }
     /**
      * Gets the name of the user who added the Integration.
      *
@@ -106,6 +117,20 @@ export class Integration extends ResourceProperty {
     getLastUpdateMs() {
         return this.payload.lastUpdateMs;
     }
+    /**
+     * Performs update Integration.
+     *
+     * @returns The updated Integration object
+     */
+    update() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const bookId = this.getBookId();
+            if (bookId) {
+                this.payload = yield IntegrationService.updateIntegration(bookId, this.payload, this.getConfig());
+            }
+            return this;
+        });
+    }
     /**
      * Performs remove Integration.
      *

package/lib/model/ResourceProperty.js

@@ -5,6 +5,16 @@ import { Resource } from "./Resource.js";
  * Extends Resource<T> and adds property management methods for entities
  * that have a properties field in their payload.
  *
+ * Custom property keys are normalized and validated by the Bkper API when
+ * resources are persisted:
+ *
+ * - Keys can have up to 30 characters after normalization.
+ * - Keys are normalized to lowercase, spaces become underscores, and unsupported
+ *   punctuation is removed.
+ * - Keys ending with an underscore (`_`) are treated as hidden/internal by SDK
+ *   visible-property helpers.
+ * - Empty, null, or undefined values clear the property when saved.
+ *
  * @public
  */
 export class ResourceProperty extends Resource {
@@ -62,6 +72,10 @@ export class ResourceProperty extends Resource {
     /**
      * Sets a custom property in this resource.
      *
+     * Property keys are normalized and validated by the API when saved. Keep keys
+     * to 30 characters or fewer after normalization. Use a trailing underscore
+     * (`_`) for hidden/internal properties.
+     *
      * @param key - The property key
      * @param value - The property value, or null/undefined to clean it
      *

package/lib/service/file-service.js

@@ -20,6 +20,20 @@ export function getFile(bookId, id, config) {
         return response.data;
     });
 }
+export function listFiles(bookId, limit, cursor, config) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!limit) {
+            limit = 100;
+        }
+        const request = new HttpBooksApiV5Request(`${bookId}/files`, config);
+        request.addParam('limit', limit);
+        if (cursor != null) {
+            request.setHeader('cursor', cursor);
+        }
+        const response = yield request.fetch();
+        return response.data;
+    });
+}
 export function updateFile(bookId, file, config) {
     return __awaiter(this, void 0, void 0, function* () {
         let response = yield new HttpBooksApiV5Request(`${bookId}/files`, config).setMethod('PUT').setPayload(file).fetch();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bkper-js",
-    "version": "2.35.2",
+    "version": "2.37.0",
     "description": "Javascript client for Bkper REST API",
     "main": "./lib/index.js",
     "module": "./lib/index.js",
@@ -38,7 +38,7 @@
         "release:major": "npm version major -m \"chore(release): v%s\""
     },
     "dependencies": {
-        "@bkper/bkper-api-types": "^5.40.2",
+        "@bkper/bkper-api-types": "^5.41.0",
         "big.js": "^6.0.3",
         "dayjs": "^1.10.3",
         "luxon": "^1.25.0",