bkper-js 2.35.2 → 2.36.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.
      *
@@ -2849,6 +2858,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]].
  *

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/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/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.36.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",