@firela/api-types 0.0.0-canary.89313ec3 → 0.0.0-canary.8958e0bf
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/dist/index.d.mts +151 -111
- package/dist/index.d.ts +151 -111
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +75 -8
- package/src/generated/services.gen.ts +2 -2
- package/src/generated/types.gen.ts +19022 -1883
package/dist/index.js
CHANGED
|
@@ -484,7 +484,7 @@ var BeanAccountsService = class {
|
|
|
484
484
|
* @param data.type Filter by account type
|
|
485
485
|
* @param data.status Filter by status
|
|
486
486
|
* @param data.isCustom Filter by custom (user-created) accounts only
|
|
487
|
-
* @param data.search Search term
|
|
487
|
+
* @param data.search Search term matched against account path and user-set display name (case-insensitive)
|
|
488
488
|
* @param data.limit Maximum number of results
|
|
489
489
|
* @param data.offset Number of results to skip
|
|
490
490
|
* @returns AccountListResponseDto Accounts retrieved successfully
|
package/dist/index.mjs
CHANGED
|
@@ -452,7 +452,7 @@ var BeanAccountsService = class {
|
|
|
452
452
|
* @param data.type Filter by account type
|
|
453
453
|
* @param data.status Filter by status
|
|
454
454
|
* @param data.isCustom Filter by custom (user-created) accounts only
|
|
455
|
-
* @param data.search Search term
|
|
455
|
+
* @param data.search Search term matched against account path and user-set display name (case-insensitive)
|
|
456
456
|
* @param data.limit Maximum number of results
|
|
457
457
|
* @param data.offset Number of results to skip
|
|
458
458
|
* @returns AccountListResponseDto Accounts retrieved successfully
|
package/package.json
CHANGED
|
@@ -286,6 +286,14 @@ export const $UpdateAccountDto = {
|
|
|
286
286
|
description: 'Icon identifier',
|
|
287
287
|
example: 'bank-custom'
|
|
288
288
|
},
|
|
289
|
+
displayName: {
|
|
290
|
+
type: 'string',
|
|
291
|
+
description:
|
|
292
|
+
'User-set display name override (null = clear the override and fall back to the derived name, omit = unchanged)',
|
|
293
|
+
nullable: true,
|
|
294
|
+
maxLength: 50,
|
|
295
|
+
example: 'Salary card'
|
|
296
|
+
},
|
|
289
297
|
openDirectiveMeta: {
|
|
290
298
|
type: 'object',
|
|
291
299
|
description:
|
|
@@ -1996,13 +2004,17 @@ export const $ReviewStatsDto = {
|
|
|
1996
2004
|
type: 'object',
|
|
1997
2005
|
description: 'Count by type'
|
|
1998
2006
|
},
|
|
2007
|
+
resolved: {
|
|
2008
|
+
type: 'number',
|
|
2009
|
+
description: 'Current count of reviews in RESOLVED status'
|
|
2010
|
+
},
|
|
1999
2011
|
oldestPending: {
|
|
2000
2012
|
format: 'date-time',
|
|
2001
2013
|
type: 'string',
|
|
2002
2014
|
description: 'Oldest pending review date'
|
|
2003
2015
|
}
|
|
2004
2016
|
},
|
|
2005
|
-
required: ['total', 'byType']
|
|
2017
|
+
required: ['total', 'byType', 'resolved']
|
|
2006
2018
|
} as const;
|
|
2007
2019
|
|
|
2008
2020
|
export const $DecisionOptionDto = {
|
|
@@ -2307,6 +2319,44 @@ export const $BatchResolveDto = {
|
|
|
2307
2319
|
required: ['reviewIds', 'action']
|
|
2308
2320
|
} as const;
|
|
2309
2321
|
|
|
2322
|
+
export const $BatchResolveItemDto = {
|
|
2323
|
+
type: 'object',
|
|
2324
|
+
properties: {
|
|
2325
|
+
reviewId: {
|
|
2326
|
+
type: 'string',
|
|
2327
|
+
description: 'Review item ID'
|
|
2328
|
+
},
|
|
2329
|
+
success: {
|
|
2330
|
+
type: 'boolean',
|
|
2331
|
+
description: 'Whether this item was resolved successfully'
|
|
2332
|
+
},
|
|
2333
|
+
resolutionId: {
|
|
2334
|
+
type: 'string',
|
|
2335
|
+
description:
|
|
2336
|
+
'Resolution ID for undo. Present only on successful items (failed items stay PENDING).'
|
|
2337
|
+
},
|
|
2338
|
+
messageKey: {
|
|
2339
|
+
type: 'string',
|
|
2340
|
+
description:
|
|
2341
|
+
'i18n message key for the per-item failure reason (e.g., review.payee.error.no_suggestion), mirroring the single-item resolve response. Present only on resolver rejections, not on unexpected errors.'
|
|
2342
|
+
},
|
|
2343
|
+
messageParams: {
|
|
2344
|
+
type: 'object',
|
|
2345
|
+
description:
|
|
2346
|
+
'Parameters for message interpolation (e.g., { name: "PayeeName" })',
|
|
2347
|
+
additionalProperties: {
|
|
2348
|
+
type: 'string'
|
|
2349
|
+
}
|
|
2350
|
+
},
|
|
2351
|
+
error: {
|
|
2352
|
+
type: 'string',
|
|
2353
|
+
description:
|
|
2354
|
+
'Diagnostic string: the messageKey on the resolver-rejection path; an i18n key mapped from the exception type on the unexpected-error path (#903, raw exception detail stays in server logs).'
|
|
2355
|
+
}
|
|
2356
|
+
},
|
|
2357
|
+
required: ['reviewId', 'success']
|
|
2358
|
+
} as const;
|
|
2359
|
+
|
|
2310
2360
|
export const $BatchResolveResultDto = {
|
|
2311
2361
|
type: 'object',
|
|
2312
2362
|
properties: {
|
|
@@ -2322,7 +2372,7 @@ export const $BatchResolveResultDto = {
|
|
|
2322
2372
|
description: 'Details for each item',
|
|
2323
2373
|
type: 'array',
|
|
2324
2374
|
items: {
|
|
2325
|
-
|
|
2375
|
+
$ref: '#/components/schemas/BatchResolveItemDto'
|
|
2326
2376
|
}
|
|
2327
2377
|
}
|
|
2328
2378
|
},
|
|
@@ -5222,9 +5272,23 @@ export const $CategoryCatalogEntryDto = {
|
|
|
5222
5272
|
items: {
|
|
5223
5273
|
type: 'string'
|
|
5224
5274
|
}
|
|
5275
|
+
},
|
|
5276
|
+
categoryAccounts: {
|
|
5277
|
+
description:
|
|
5278
|
+
"Beancount account paths (categoryAccount) of the region-enabled system rules whose categoryKeywords include this slug (#816). System rules only (public endpoint — user rules excluded); one-to-many by design (e.g. 'utilities' → Electricity/Water/Internet/Gas), sorted, [] when no rule maps the slug.",
|
|
5279
|
+
example: [
|
|
5280
|
+
'Expenses:Utilities:Electricity',
|
|
5281
|
+
'Expenses:Utilities:Gas',
|
|
5282
|
+
'Expenses:Utilities:Internet',
|
|
5283
|
+
'Expenses:Utilities:Water'
|
|
5284
|
+
],
|
|
5285
|
+
type: 'array',
|
|
5286
|
+
items: {
|
|
5287
|
+
type: 'string'
|
|
5288
|
+
}
|
|
5225
5289
|
}
|
|
5226
5290
|
},
|
|
5227
|
-
required: ['slug', 'scenario', 'icon', 'regions']
|
|
5291
|
+
required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
|
|
5228
5292
|
} as const;
|
|
5229
5293
|
|
|
5230
5294
|
export const $CategoryCatalogListResponseDto = {
|
|
@@ -6343,8 +6407,9 @@ export const $ClientParsedDataDto = {
|
|
|
6343
6407
|
},
|
|
6344
6408
|
category: {
|
|
6345
6409
|
type: 'string',
|
|
6346
|
-
description:
|
|
6347
|
-
|
|
6410
|
+
description:
|
|
6411
|
+
'Category in canonical form (catalog slug or Stage-2 rule keyword token, ADR-0116) — echo back verbatim from parsedData.category. Foreign forms (locale display names, account paths) are rejected with nlp.category.invalid.',
|
|
6412
|
+
example: 'food'
|
|
6348
6413
|
},
|
|
6349
6414
|
incomeType: {
|
|
6350
6415
|
type: 'string',
|
|
@@ -6530,7 +6595,9 @@ export const $NlpParsedDataDto = {
|
|
|
6530
6595
|
},
|
|
6531
6596
|
category: {
|
|
6532
6597
|
type: 'string',
|
|
6533
|
-
description:
|
|
6598
|
+
description:
|
|
6599
|
+
'Category in canonical form: a CATEGORY_CATALOG slug (GET /{region}/bean/categories) or a Stage-2 rule categoryKeywords token (ADR-0116 D2). Never a locale display name or a beancount account path. Echo back verbatim on confirm.',
|
|
6600
|
+
example: 'food'
|
|
6534
6601
|
},
|
|
6535
6602
|
incomeType: {
|
|
6536
6603
|
type: 'string',
|
|
@@ -7780,7 +7847,7 @@ export const $AccountItemDto = {
|
|
|
7780
7847
|
displayName: {
|
|
7781
7848
|
type: 'string',
|
|
7782
7849
|
description:
|
|
7783
|
-
'Display name: user-set name if provided (#762), else last part of account path',
|
|
7850
|
+
'Display name: user-set name if provided (#762), else the ADR-0114 chain — request-locale catalog name, en pivot, then the last part of the account path (#771)',
|
|
7784
7851
|
example: 'Savings'
|
|
7785
7852
|
},
|
|
7786
7853
|
balance: {
|
|
@@ -7953,7 +8020,7 @@ export const $AccountItemWithAssetClassDto = {
|
|
|
7953
8020
|
displayName: {
|
|
7954
8021
|
type: 'string',
|
|
7955
8022
|
description:
|
|
7956
|
-
'Display name: user-set name if provided (#762), else last part of account path',
|
|
8023
|
+
'Display name: user-set name if provided (#762), else the ADR-0114 chain — request-locale catalog name, en pivot, then the last part of the account path (#771)',
|
|
7957
8024
|
example: 'Savings'
|
|
7958
8025
|
},
|
|
7959
8026
|
balance: {
|
|
@@ -337,7 +337,7 @@ export class BeanAccountsService {
|
|
|
337
337
|
* @param data.type Filter by account type
|
|
338
338
|
* @param data.status Filter by status
|
|
339
339
|
* @param data.isCustom Filter by custom (user-created) accounts only
|
|
340
|
-
* @param data.search Search term
|
|
340
|
+
* @param data.search Search term matched against account path and user-set display name (case-insensitive)
|
|
341
341
|
* @param data.limit Maximum number of results
|
|
342
342
|
* @param data.offset Number of results to skip
|
|
343
343
|
* @returns AccountListResponseDto Accounts retrieved successfully
|
|
@@ -2867,7 +2867,7 @@ export class BeanTransactionRulesService {
|
|
|
2867
2867
|
export class BeanCategoryCatalogService {
|
|
2868
2868
|
/**
|
|
2869
2869
|
* List category catalog for a region
|
|
2870
|
-
* Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker. CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
|
|
2870
|
+
* Returns the region-scoped category slugs (expense/income/investment/banking/transfer/payment) for the NLP result picker, each with the categoryAccount paths the region-enabled system rules map it to (#816). CN-exclusive payment instruments (huabei/baitiao) appear only under /cn.
|
|
2871
2871
|
* @param data The data for the request.
|
|
2872
2872
|
* @param data.region Region code for tenant context
|
|
2873
2873
|
* @param data.scenario Filter by scenario
|