bkper 4.18.4 → 4.20.0

package/lib/docs/sdk/bkper-js.md

@@ -631,7 +631,7 @@ It contains all `Accounts` where `Transactions` are recorded/posted;
 - `getTransaction(id: string)` → `Promise<Transaction | undefined>` — Retrieve a transaction by id.
 - `getVisibility()` / `setVisibility(visibility: Visibility)` → `Visibility` — Gets the visibility of the book.
 - `json()` → `bkper.Book` — Gets an immutable copy of the JSON payload for this resource.
-- `listEvents(afterDate: string | null, beforeDate: string | null, onError: boolean | null, resourceId: string | null, limit: number, cursor?: string)` → `Promise<EventList>` — Lists events in the Book based on the provided parameters.
+- `listEvents(options: ListEventsOptions)` → `Promise<EventList>` — Lists events in the Book based on the provided options.
 - `listFiles(limit?: number, cursor?: string)` → `Promise<FileList>` — Lists files in the Book, for pagination.
 - `listTransactions(query?: string, limit?: number, cursor?: string)` → `Promise<TransactionList>` — Lists transactions in the Book based on the provided query, limit, and cursor, for pagination.
 - `mergeTransactions(transaction1: string | bkper.Transaction | Transaction, transaction2: string | bkper.Transaction | Transaction)` → `Promise<Transaction>` — Merge two `Transactions` into a single new canonical transaction.
@@ -786,6 +786,7 @@ A Collaborator represents a user that has been granted access to a Book with spe
 **Methods:**
 
 - `create(message?: string)` → `Promise<Collaborator>` — Performs create new Collaborator.
+- `getAvatarUrl()` → `string | undefined` — Gets the public avatar url of the Collaborator.
 - `getEmail()` / `setEmail(email: string)` → `string | undefined (set: string)` — Gets the Collaborator email address.
 - `getId()` → `string | undefined` — Gets the Collaborator internal id.
 - `getPermission()` / `setPermission(permission: Permission)` → `Permission | undefined (set: Permission)` — Gets the permission level of the Collaborator.
@@ -902,11 +903,13 @@ A File can be attached to a `Transaction` or used to import data.
 - `getBook()` → `Book` — Gets the Book this File belongs to.
 - `getContent()` / `setContent(content: string)` → `Promise<string | undefined> (set: string)` — Gets the file content Base64 encoded.
 - `getContentType()` / `setContentType(contentType: string)` → `string | undefined (set: string)` — Gets the File content type.
+- `getCreatedAt()` → `Date | undefined` — Gets the date the File was created.
 - `getId()` → `string | undefined` — Gets the File id.
 - `getName()` / `setName(name: string)` → `string | undefined (set: string)` — Gets the File name.
 - `getSize()` → `number | undefined` — Gets the file size in bytes.
 - `getUrl()` → `string | undefined` — Gets the file serving url for accessing via browser.
 - `json()` → `bkper.File` — Gets an immutable copy of the JSON payload for this resource.
+- `remove()` → `Promise<File>` — Perform delete File.
 - `update()` → `Promise<File>` — Perform update File, applying pending changes.
 
 *Standard property methods (deleteProperty, getProperties, getProperty, getPropertyKeys, getVisibleProperties, setProperties, setProperty, setVisibleProperties, setVisibleProperty) — see Account.*
@@ -1202,6 +1205,7 @@ Each User has a unique identity, subscription plan details, and access permissio
 - `getHostedDomain()` → `string | undefined` — Gets the hosted domain of the User.
 - `getId()` → `string | undefined` — Gets the id of the User.
 - `getName()` → `string | undefined` — Gets the name of the User.
+- `getPlanCycle()` → `"MONTHLY" | "YEARLY" | undefined` — Gets the billing cycle of the User's current plan.
 - `getUsername()` → `string | undefined` — Gets the username of the User.
 - `hasUsedConnections()` → `boolean | undefined` — Tells if the User has already used `Connections`.
 - `json()` → `bkper.User` — Gets an immutable copy of the JSON payload for this resource.
@@ -1311,6 +1315,40 @@ Bkper Platform outbound for server-side app routes.
 This function is called when a request fails and needs to be retried.
 It provides the HTTP status code, error message, and the number of retry attempts made so far.
 
+### ListEventsOptions
+
+Options for listing events in a Book.
+
+**Properties:**
+
+- `afterDate?`: `string` — The start date (inclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+- `beforeDate?`: `string` — The end date (exclusive) for the events search range, in [RFC3339](https://en.wikipedia.org/wiki/ISO_8601#RFC_3339) format.
+- `cursor?`: `string` — The cursor for pagination.
+- `limit`: `number` — The maximum number of events to return.
+- `onError?`: `boolean` — Whether to filter events by error responses.
+- `resourceId?`: `string` — The ID of the event's resource (Transaction, Account, or Group).
+- `type?`: `EventType` — The event type to filter by.
+
+**limit**
+
+Defaults to `50`, maximum is `200`.
+
+**onError**
+
+`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.
+
+**resourceId**
+
+When set, `onError` and `type` are ignored.
+
+**type**
+
+Ignored when `resourceId` or `onError` is set.
+
 ## Enums
 
 ### AccountType
@@ -1362,6 +1400,7 @@ Enum that represents event types.
 - `COMMENT_CREATED`
 - `COMMENT_DELETED`
 - `FILE_CREATED`
+- `FILE_DELETED`
 - `FILE_UPDATED`
 - `GROUP_CREATED`
 - `GROUP_DELETED`

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "bkper",
-    "version": "4.18.4",
+    "version": "4.20.0",
     "description": "Command line client for Bkper",
     "bin": {
         "bkper": "./lib/cli.js"
@@ -43,7 +43,7 @@
         "test:integration": "TS_NODE_TRANSPILE_ONLY=true BKPER_API_URL=${BKPER_API_URL:-http://localhost:8081/_ah/api/bkper} TS_NODE_PROJECT=tsconfig.test.json mocha --config .mocharc.integration.json",
         "test:deploy": "TS_NODE_TRANSPILE_ONLY=true BKPER_PLATFORM_URL=http://localhost:8790 BKPER_API_URL=https://api-dev.bkper.app TS_NODE_PROJECT=tsconfig.test.json mocha --config .mocharc.deploy.json",
         "test:all": "bun run test:unit && bun run test:integration",
-        "version": "bun ./scripts/sync-plugin-version.ts",
+        "version": "bun ./scripts/sync-plugin-version.ts && git add .claude-plugin/plugin.json .claude-plugin/marketplace.json .codex-plugin/plugin.json",
         "release:patch": "npm version patch -m \"chore(release): v%s\"",
         "release:minor": "npm version minor -m \"chore(release): v%s\"",
         "release:major": "npm version major -m \"chore(release): v%s\"",
@@ -52,8 +52,8 @@
         "upgrade:api": "bun update @bkper/bkper-api-types --latest && bun update bkper-js --latest"
     },
     "dependencies": {
-        "@earendil-works/pi-coding-agent": "0.80.3",
-        "bkper-js": "^2.37.0",
+        "@earendil-works/pi-coding-agent": "0.80.10",
+        "bkper-js": "^2.40.1",
         "commander": "^13.1.0",
         "dotenv": "^8.2.0",
         "esbuild": "^0.27.2",