@bkper/bkper-api-types 5.32.0 → 5.33.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CLAUDE.md ADDED
@@ -0,0 +1,24 @@
1
+ # Bkper API Types
2
+
3
+ ## Auto-Generated Types
4
+
5
+ **DO NOT manually edit `index.d.ts`** - this file is auto-generated.
6
+
7
+ 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.
8
+
9
+ ## Regenerating Types
10
+
11
+ Types should be regenerated after `bkper-api` deployment:
12
+
13
+ ```bash
14
+ bun run build
15
+ ```
16
+
17
+ This fetches the latest OpenAPI spec from the production API and regenerates `index.d.ts`.
18
+
19
+ ## Workflow
20
+
21
+ 1. Make changes to the API in `bkper-api`
22
+ 2. Deploy `bkper-api` to production
23
+ 3. Run `bun run build` in this project to regenerate types
24
+ 4. Publish the updated types package
package/index.d.ts CHANGED
@@ -133,9 +133,9 @@ declare namespace bkper {
133
133
  */
134
134
  description?: string;
135
135
  /**
136
- * The developer email
136
+ * The developers (usernames and domain patterns), comma or space separated
137
137
  */
138
- developerEmail?: string;
138
+ developers?: string;
139
139
  /**
140
140
  * Event types the App listen to
141
141
  */
@@ -185,9 +185,13 @@ declare namespace bkper {
185
185
  */
186
186
  name?: string;
187
187
  /**
188
- * The owner email
188
+ * The owner user email
189
189
  */
190
190
  ownerEmail?: string;
191
+ /**
192
+ * The owner user id
193
+ */
194
+ ownerId?: string;
191
195
  /**
192
196
  * The owner company logo url
193
197
  */
@@ -222,9 +226,9 @@ declare namespace bkper {
222
226
  */
223
227
  scopes?: string[];
224
228
  /**
225
- * The user emails to enable the App while not yet published
229
+ * The users (usernames and domain patterns) to enable the App while not yet published
226
230
  */
227
- userEmails?: string;
231
+ users?: string;
228
232
  /**
229
233
  * The Webhook endpoint URL to listen for book events
230
234
  */
@@ -907,6 +911,10 @@ declare namespace bkper {
907
911
  * True if user already had any bank connection
908
912
  */
909
913
  bankConnections?: boolean;
914
+ /**
915
+ * The billing admin email for this user's billing account
916
+ */
917
+ billingAdminEmail?: string;
910
918
  /**
911
919
  * True if billing is enabled for the user
912
920
  */
@@ -951,10 +959,22 @@ declare namespace bkper {
951
959
  * The user plan
952
960
  */
953
961
  plan?: string;
962
+ /**
963
+ * True if subscription payment is overdue
964
+ */
965
+ planOverdue?: boolean;
954
966
  /**
955
967
  * True if user started trial
956
968
  */
957
969
  startedTrial?: boolean;
970
+ /**
971
+ * User-level total transactions this month
972
+ */
973
+ totalTransactionsThisMonth?: number; // int64
974
+ /**
975
+ * User-level total transactions this year
976
+ */
977
+ totalTransactionsThisYear?: number; // int64
958
978
  /**
959
979
  * The Bkper username of the user
960
980
  */
@@ -1325,17 +1345,6 @@ declare namespace Paths {
1325
1345
  export type $200 = bkper.TransactionList;
1326
1346
  }
1327
1347
  }
1328
- namespace BkperV5PatchApp {
1329
- export interface BodyParameters {
1330
- App: Parameters.App;
1331
- }
1332
- namespace Parameters {
1333
- export type App = bkper.App;
1334
- }
1335
- namespace Responses {
1336
- export type $200 = bkper.App;
1337
- }
1338
- }
1339
1348
  namespace BkperV5PostTransaction {
1340
1349
  export interface BodyParameters {
1341
1350
  Transaction: Parameters.Transaction;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@bkper/bkper-api-types",
3
- "version": "5.32.0",
3
+ "version": "5.33.0",
4
4
  "description": "Typescript definitions for Bkper REST API",
5
5
  "homepage": "https://api.bkper.com",
6
6
  "repository": {
@@ -1,9 +0,0 @@
1
- {
2
- "permissions": {
3
- "allow": [
4
- "SlashCommand(/commit)"
5
- ],
6
- "deny": [],
7
- "ask": []
8
- }
9
- }