@bkper/bkper-api-types 5.32.3 → 5.34.0

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "SlashCommand(/commit)"
+    ],
+    "deny": [],
+    "ask": []
+  }
+}

package/CLAUDE.md

@@ -0,0 +1,24 @@
+# Bkper API Types
+
+## Auto-Generated Types
+
+**DO NOT manually edit `index.d.ts`** - this file is auto-generated.
+
+The types are generated from the Bkper [Open API spec](https://app.bkper.com/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
+
+## Regenerating Types
+
+Types should be regenerated after `bkper-api` deployment:
+
+```bash
+bun run build
+```
+
+This fetches the latest OpenAPI spec from the production API and regenerates `index.d.ts`.
+
+## Workflow
+
+1. Make changes to the API in `bkper-api`
+2. Deploy `bkper-api` to production
+3. Run `bun run build` in this project to regenerate types
+4. Publish the updated types package

package/index.d.ts

@@ -133,13 +133,9 @@ declare namespace bkper {
          */
         description?: string;
         /**
-         * The developer email (deprecated, use developerEmails)
+         * The developers (usernames and domain patterns), comma or space separated
          */
-        developerEmail?: string;
-        /**
-         * The developer emails, comma or space separated
-         */
-        developerEmails?: string;
+        developers?: string;
         /**
          * Event types the App listen to
          */
@@ -189,9 +185,13 @@ declare namespace bkper {
          */
         name?: string;
         /**
-         * The owner email
+         * The owner user email
          */
         ownerEmail?: string;
+        /**
+         * The owner user id
+         */
+        ownerId?: string;
         /**
          * The owner company logo url
          */
@@ -226,9 +226,9 @@ declare namespace bkper {
          */
         scopes?: string[];
         /**
-         * The user emails to enable the App while not yet published
+         * The users (usernames and domain patterns) to enable the App while not yet published
          */
-        userEmails?: string;
+        users?: string;
         /**
          * The Webhook endpoint URL to listen for book events
          */
@@ -287,6 +287,40 @@ declare namespace bkper {
         rangeBeginLabel?: string;
         rangeEndLabel?: string;
     }
+    export interface Billing {
+        /**
+         * The billing admin email for the user's billing account
+         */
+        adminEmail?: string;
+        /**
+         * How many days the user has left in the trial period
+         */
+        daysLeftInTrial?: number; // int32
+        /**
+         * True if billing is enabled for the user
+         */
+        enabled?: boolean;
+        /**
+         * The user's current plan
+         */
+        plan?: string;
+        /**
+         * True if subscription payment is overdue
+         */
+        planOverdue?: boolean;
+        /**
+         * True if the user has started the trial period
+         */
+        startedTrial?: boolean;
+        /**
+         * User-level total transactions this month
+         */
+        totalTransactionsThisMonth?: number; // int64
+        /**
+         * User-level total transactions this year
+         */
+        totalTransactionsThisYear?: number; // int64
+    }
     export interface Book {
         /**
          * The book Accounts
@@ -911,6 +945,10 @@ declare namespace bkper {
          * True if user already had any bank connection
          */
         bankConnections?: boolean;
+        /**
+         * The billing admin email for this user's billing account
+         */
+        billingAdminEmail?: string;
         /**
          * True if billing is enabled for the user
          */
@@ -955,10 +993,22 @@ declare namespace bkper {
          * The user plan
          */
         plan?: string;
+        /**
+         * True if subscription payment is overdue
+         */
+        planOverdue?: boolean;
         /**
          * True if user started trial
          */
         startedTrial?: boolean;
+        /**
+         * User-level total transactions this month
+         */
+        totalTransactionsThisMonth?: number; // int64
+        /**
+         * User-level total transactions this year
+         */
+        totalTransactionsThisYear?: number; // int64
         /**
          * The Bkper username of the user
          */
@@ -1209,6 +1259,11 @@ declare namespace Paths {
             export type $200 = bkper.Balances;
         }
     }
+    namespace BkperV5GetBilling {
+        namespace Responses {
+            export type $200 = bkper.Billing;
+        }
+    }
     namespace BkperV5GetBillingPortal {
         namespace Responses {
             export type $200 = bkper.Url;
@@ -1264,6 +1319,11 @@ declare namespace Paths {
             export type $200 = bkper.AppList;
         }
     }
+    namespace BkperV5ListBillingCounts {
+        namespace Responses {
+            export type $200 = bkper.Counts;
+        }
+    }
     namespace BkperV5ListBookApps {
         namespace Responses {
             export type $200 = bkper.AppList;
@@ -1329,17 +1389,6 @@ declare namespace Paths {
             export type $200 = bkper.TransactionList;
         }
     }
-    namespace BkperV5PatchApp {
-        export interface BodyParameters {
-            App: Parameters.App;
-        }
-        namespace Parameters {
-            export type App = bkper.App;
-        }
-        namespace Responses {
-            export type $200 = bkper.App;
-        }
-    }
     namespace BkperV5PostTransaction {
         export interface BodyParameters {
             Transaction: Parameters.Transaction;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bkper/bkper-api-types",
-  "version": "5.32.3",
+  "version": "5.34.0",
   "description": "Typescript definitions for Bkper REST API",
   "homepage": "https://api.bkper.com",
   "repository": {