bkper-js 1.17.0 → 1.18.0

package/lib/index.d.ts

@@ -789,6 +789,19 @@ export declare class Book {
      * @returns A TransactionPage object containing the list of transactions
      */
     listTransactions(query?: string, limit?: number, cursor?: string): Promise<TransactionList>;
+    /**
+     * Lists events in the Book based on the provided parameters.
+     *
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param onError - True to search only for events on error.
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null.
+     * @param limit - The maximum number of events to return.
+     * @param cursor - The cursor for pagination. Can be null.
+     *
+     * @returns An EventList object containing the list of events.
+     */
+    listEvents(afterDate: string | null, beforeDate: string | null, onError: boolean, resourceId: string | null, limit: number, cursor?: string): Promise<EventList>;
     /**
      * Retrieve a transaction by id
      */
@@ -1117,6 +1130,50 @@ export declare enum DecimalSeparator {
     DOT = "DOT"
 }
 
+/**
+ * Represents an Event in the system.
+ *
+ * @public
+ */
+export declare class Event {
+    payload: bkper.Event;
+    constructor(payload?: bkper.Event);
+    /**
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Event;
+}
+
+/**
+ * A list associated with an event query.
+ */
+export declare class EventList {
+    private payload;
+
+    constructor(book: Book, payload: bkper.EventList);
+    /**
+     * @returns The cursor associated with the query for pagination.
+     */
+    getCursor(): string | undefined;
+    /**
+     * @returns The first Event in the list.
+     */
+    getFirst(): Event | undefined;
+    /**
+     *
+     * Get the total number of events in the list.
+     *
+     * @returns The total number of events.
+     */
+    size(): number;
+    /**
+     * Get the events in the list.
+     *
+     * @returns An array of Event objects.
+     */
+    getItems(): Event[];
+}
+
 /**
  *
  * This class defines a File uploaded to a [[Book]].

package/lib/index.js

@@ -18,6 +18,8 @@ export { Integration } from './model/Integration.js';
 export { Template } from './model/Template.js';
 export { Transaction } from './model/Transaction.js';
 export { TransactionList } from './model/TransactionList.js';
+export { Event } from './model/Event.js';
+export { EventList } from './model/EventList.js';
 export { User } from './model/User.js';
 export { Periodicity, DecimalSeparator, Permission, Visibility, AccountType, Period, Month } from './model/Enums.js';
 //# sourceMappingURL=index.js.map

package/lib/model/Book.js

@@ -13,9 +13,11 @@ import * as FileService from '../service/file-service.js';
 import * as GroupService from '../service/group-service.js';
 import * as IntegrationService from '../service/integration-service.js';
 import * as TransactionService from '../service/transaction-service.js';
+import * as EventService from '../service/event-service.js';
 import * as Utils from '../utils.js';
 import { Account } from './Account.js';
 import { Collection } from './Collection.js';
+import { EventList } from './EventList.js';
 import { File } from './File.js';
 import { Group } from './Group.js';
 import { Integration } from './Integration.js';
@@ -639,6 +641,24 @@ export class Book {
             return new TransactionList(this, transactionsList);
         });
     }
+    /**
+     * Lists events in the Book based on the provided parameters.
+     *
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format. Can be null.
+     * @param onError - True to search only for events on error.
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null.
+     * @param limit - The maximum number of events to return.
+     * @param cursor - The cursor for pagination. Can be null.
+     *
+     * @returns An EventList object containing the list of events.
+     */
+    listEvents(afterDate, beforeDate, onError, resourceId, limit, cursor) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const eventsList = yield EventService.listEvents(this, afterDate, beforeDate, onError, resourceId, limit, cursor);
+            return new EventList(this, eventsList);
+        });
+    }
     /**
      * Retrieve a transaction by id
      */

package/lib/model/Event.js

@@ -0,0 +1,17 @@
+/**
+ * Represents an Event in the system.
+ *
+ * @public
+ */
+export class Event {
+    constructor(payload) {
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The wrapped plain json object
+     */
+    json() {
+        return Object.assign({}, this.payload);
+    }
+}
+//# sourceMappingURL=Event.js.map

package/lib/model/EventList.js

@@ -0,0 +1,43 @@
+import { Event } from "./Event.js";
+/**
+ * A list associated with an event query.
+ */
+export class EventList {
+    constructor(book, payload) {
+        this.book = book;
+        this.payload = payload || {};
+    }
+    /**
+     * @returns The cursor associated with the query for pagination.
+     */
+    getCursor() {
+        return this.payload.cursor;
+    }
+    /**
+     * @returns The first Event in the list.
+     */
+    getFirst() {
+        const events = this.getItems();
+        return events.length > 0 ? events[0] : undefined;
+    }
+    /**
+     *
+     * Get the total number of events in the list.
+     *
+     * @returns The total number of events.
+     */
+    size() {
+        var _a;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.length) || 0;
+    }
+    /**
+     * Get the events in the list.
+     *
+     * @returns An array of Event objects.
+     */
+    getItems() {
+        var _a;
+        return ((_a = this.payload.items) === null || _a === void 0 ? void 0 : _a.map(event => new Event(event))) || [];
+    }
+}
+//# sourceMappingURL=EventList.js.map

package/lib/service/event-service.js

@@ -0,0 +1,26 @@
+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 { HttpBooksApiV5Request } from "./http-api-request.js";
+export function listEvents(book, afterDate, beforeDate, onError, resourceId, limit, cursor) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let request = new HttpBooksApiV5Request(`${book.getId()}/events`);
+        request.addParam('after', afterDate);
+        request.addParam('before', beforeDate);
+        request.addParam('error', onError);
+        request.addParam('resoureId', resourceId);
+        request.addParam('limit', limit);
+        if (cursor != null) {
+            request.setHeader('cursor', cursor);
+        }
+        var response = yield request.fetch();
+        return response.data;
+    });
+}
+//# sourceMappingURL=event-service.js.map

package/package.json

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