bkper-js 2.39.0 → 2.40.1

package/lib/index.d.ts

@@ -2037,19 +2037,30 @@ export declare class Book extends ResourceProperty<bkper.Book> {
      * @returns The number of matching transactions
      */
     countTransactions(query?: string): Promise<number | undefined>;
+    /**
+     * Lists events in the Book based on the provided options.
+     *
+     * @param options - The event list options
+     *
+     * @returns An [[EventList]] object containing the list of events
+     */
+    listEvents(options: ListEventsOptions): Promise<EventList>;
     /**
      * 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 - Filter by error state: `true` = only errors, `false` = only non-errors, `null` = all. Ignored when `resourceId` is set.
-     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null. When set, `onError` is ignored.
-     * @param limit - The maximum number of events to return
-     * @param cursor - The cursor for pagination. Can be null
+     * @deprecated Use `listEvents(options)` instead.
+     *
+     * @param afterDate - The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+     * @param beforeDate - The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+     * @param onError - Whether to filter events by error responses. `true` returns events with at least one error response. `false` returns events with no error responses. `null` or `undefined` includes events regardless of error responses. Ignored when `resourceId` is set.
+     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). When set, `onError` is ignored.
+     * @param limit - The maximum number of events to return. Defaults to `50`, maximum is `200`.
+     * @param cursor - The cursor for pagination.
      *
      * @returns An [[EventList]] object containing the list of events
      */
     listEvents(afterDate: string | null, beforeDate: string | null, onError: boolean | null, resourceId: string | null, limit: number, cursor?: string): Promise<EventList>;
+
     /**
      * Retrieve a transaction by id.
      *
@@ -3281,6 +3292,54 @@ export declare class Integration extends ResourceProperty<bkper.Integration> {
     remove(): Promise<Integration>;
 }
 
+/**
+ * Options for listing events in a Book.
+ *
+ * @public
+ */
+export declare interface ListEventsOptions {
+    /**
+     * The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+     */
+    afterDate?: string;
+    /**
+     * The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+     */
+    beforeDate?: string;
+    /**
+     * The ID of the event's resource (Transaction, Account, or Group).
+     *
+     * When set, `onError` and `type` are ignored.
+     */
+    resourceId?: string;
+    /**
+     * Whether to filter events by error responses.
+     *
+     * `true` returns events with at least one error response.
+     * `false` returns events with no error responses.
+     * `null` or `undefined` includes events regardless of error responses.
+     *
+     * Ignored when `resourceId` is set. When set, `type` is ignored.
+     */
+    onError?: boolean;
+    /**
+     * The event type to filter by.
+     *
+     * Ignored when `resourceId` or `onError` is set.
+     */
+    type?: EventType;
+    /**
+     * The maximum number of events to return.
+     *
+     * Defaults to `50`, maximum is `200`.
+     */
+    limit: number;
+    /**
+     * The cursor for pagination.
+     */
+    cursor?: string;
+}
+
 /**
  * Enum that represents how an App menu opens.
  *

package/lib/model/Book.js

@@ -558,15 +558,19 @@ export class Book extends ResourceProperty {
      */
     mergeTransactions(transaction1, transaction2) {
         return __awaiter(this, void 0, void 0, function* () {
-            const transactionId1 = typeof transaction1 === 'string' ? transaction1 :
-                transaction1 instanceof Transaction ? transaction1.getId() :
-                    transaction1.id;
+            const transactionId1 = typeof transaction1 === 'string'
+                ? transaction1
+                : transaction1 instanceof Transaction
+                    ? transaction1.getId()
+                    : transaction1.id;
             if (transactionId1 == null || transactionId1.trim() === '') {
                 throw new Error('The first transaction must provide an id for merge.');
             }
-            const transactionId2 = typeof transaction2 === 'string' ? transaction2 :
-                transaction2 instanceof Transaction ? transaction2.getId() :
-                    transaction2.id;
+            const transactionId2 = typeof transaction2 === 'string'
+                ? transaction2
+                : transaction2 instanceof Transaction
+                    ? transaction2.getId()
+                    : transaction2.id;
             if (transactionId2 == null || transactionId2.trim() === '') {
                 throw new Error('The second transaction must provide an id for merge.');
             }
@@ -1178,22 +1182,29 @@ export class Book extends ResourceProperty {
             return count.total;
         });
     }
-    /**
-     * 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 - Filter by error state: `true` = only errors, `false` = only non-errors, `null` = all. Ignored when `resourceId` is set.
-     * @param resourceId - The ID of the event's resource (Transaction, Account, or Group). Can be null. When set, `onError` is ignored.
-     * @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) {
+    listEvents(optionsOrAfterDate, beforeDate, onError, resourceId, limit, cursor) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const isOptions = typeof optionsOrAfterDate === 'object' && optionsOrAfterDate !== null;
+            if (isOptions) {
+                return this.listEventsWithOptions(optionsOrAfterDate);
+            }
+            const options = {
+                afterDate: optionsOrAfterDate !== null && optionsOrAfterDate !== void 0 ? optionsOrAfterDate : undefined,
+                beforeDate: beforeDate !== null && beforeDate !== void 0 ? beforeDate : undefined,
+                resourceId: resourceId !== null && resourceId !== void 0 ? resourceId : undefined,
+                onError: onError !== null && onError !== void 0 ? onError : undefined,
+                type: undefined,
+                limit: limit !== null && limit !== void 0 ? limit : 50,
+                cursor,
+            };
+            return this.listEventsWithOptions(options);
+        });
+    }
+    /** @internal */
+    listEventsWithOptions(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const eventsList = yield EventService.listEvents(this, afterDate, beforeDate, onError, resourceId, limit, cursor, this.getConfig());
-            return new EventList(this, eventsList);
+            const eventList = yield EventService.listEvents(this, options.afterDate, options.beforeDate, options.onError, options.resourceId, options.type, options.limit, options.cursor, this.getConfig());
+            return new EventList(this, eventList);
         });
     }
     /**

package/lib/model/ListEventsOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ListEventsOptions.js.map

package/lib/service/event-service.js

@@ -8,13 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import { HttpBooksApiV5Request } from "./http-api-request.js";
-export function listEvents(book, afterDate, beforeDate, onError, resourceId, limit, cursor, config) {
+export function listEvents(book, afterDate, beforeDate, onError, resourceId, eventType, limit, cursor, config) {
     return __awaiter(this, void 0, void 0, function* () {
         let request = new HttpBooksApiV5Request(`${book.getId()}/events`, config);
         request.addParam('after', afterDate);
         request.addParam('before', beforeDate);
         request.addParam('error', onError);
         request.addParam('resoureId', resourceId);
+        request.addParam('type', eventType);
         request.addParam('limit', limit);
         if (cursor != null) {
             request.setHeader('cursor', cursor);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bkper-js",
-    "version": "2.39.0",
+    "version": "2.40.1",
     "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.42.0",
+        "@bkper/bkper-api-types": "^5.43.0",
         "big.js": "^6.0.3",
         "dayjs": "^1.10.3",
         "luxon": "^1.25.0",