@firela/api-types 0.0.0-canary.e85e9088 → 0.0.0-canary.e98f0384

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.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 for account path
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 for account path
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.e85e9088",
3
+ "version": "0.0.0-canary.e98f0384",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -51,6 +51,14 @@ export const $CreateAccountDto = {
51
51
  description: 'Icon identifier (overrides template)',
52
52
  example: 'bank-custom'
53
53
  },
54
+ displayName: {
55
+ type: 'string',
56
+ description:
57
+ 'User-set display name override (omit/null = keep the derived name)',
58
+ nullable: true,
59
+ maxLength: 50,
60
+ example: 'Salary card'
61
+ },
54
62
  openDirectiveMeta: {
55
63
  type: 'object',
56
64
  description:
@@ -181,7 +189,8 @@ export const $AccountResponseDto = {
181
189
  },
182
190
  displayName: {
183
191
  type: 'string',
184
- description: 'Localized display name (ADR-0114, read-time projection)',
192
+ description:
193
+ 'Display name with precedence: user-set name (#762) > ADR-0114 localized name > path leaf (read-time projection)',
185
194
  example: 'Checking'
186
195
  },
187
196
  icon: {
@@ -277,6 +286,14 @@ export const $UpdateAccountDto = {
277
286
  description: 'Icon identifier',
278
287
  example: 'bank-custom'
279
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
+ },
280
297
  openDirectiveMeta: {
281
298
  type: 'object',
282
299
  description:
@@ -1987,13 +2004,17 @@ export const $ReviewStatsDto = {
1987
2004
  type: 'object',
1988
2005
  description: 'Count by type'
1989
2006
  },
2007
+ resolved: {
2008
+ type: 'number',
2009
+ description: 'Current count of reviews in RESOLVED status'
2010
+ },
1990
2011
  oldestPending: {
1991
2012
  format: 'date-time',
1992
2013
  type: 'string',
1993
2014
  description: 'Oldest pending review date'
1994
2015
  }
1995
2016
  },
1996
- required: ['total', 'byType']
2017
+ required: ['total', 'byType', 'resolved']
1997
2018
  } as const;
1998
2019
 
1999
2020
  export const $DecisionOptionDto = {
@@ -2298,6 +2319,44 @@ export const $BatchResolveDto = {
2298
2319
  required: ['reviewIds', 'action']
2299
2320
  } as const;
2300
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
+
2301
2360
  export const $BatchResolveResultDto = {
2302
2361
  type: 'object',
2303
2362
  properties: {
@@ -2313,7 +2372,7 @@ export const $BatchResolveResultDto = {
2313
2372
  description: 'Details for each item',
2314
2373
  type: 'array',
2315
2374
  items: {
2316
- type: 'string'
2375
+ $ref: '#/components/schemas/BatchResolveItemDto'
2317
2376
  }
2318
2377
  }
2319
2378
  },
@@ -5213,9 +5272,23 @@ export const $CategoryCatalogEntryDto = {
5213
5272
  items: {
5214
5273
  type: 'string'
5215
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
+ }
5216
5289
  }
5217
5290
  },
5218
- required: ['slug', 'scenario', 'icon', 'regions']
5291
+ required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
5219
5292
  } as const;
5220
5293
 
5221
5294
  export const $CategoryCatalogListResponseDto = {
@@ -5406,6 +5479,14 @@ export const $OnboardingAccountDto = {
5406
5479
  description:
5407
5480
  'Platform ID to bind the account to (references Platform.id); omit for unbound',
5408
5481
  example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
5482
+ },
5483
+ displayName: {
5484
+ type: 'string',
5485
+ description:
5486
+ 'User-set display name override (omit/null = keep the derived name)',
5487
+ nullable: true,
5488
+ maxLength: 50,
5489
+ example: 'Salary card'
5409
5490
  }
5410
5491
  },
5411
5492
  required: ['path', 'currency']
@@ -6326,8 +6407,9 @@ export const $ClientParsedDataDto = {
6326
6407
  },
6327
6408
  category: {
6328
6409
  type: 'string',
6329
- description: 'Category slug',
6330
- example: 'food_restaurant'
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'
6331
6413
  },
6332
6414
  incomeType: {
6333
6415
  type: 'string',
@@ -6513,7 +6595,9 @@ export const $NlpParsedDataDto = {
6513
6595
  },
6514
6596
  category: {
6515
6597
  type: 'string',
6516
- description: 'Category'
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'
6517
6601
  },
6518
6602
  incomeType: {
6519
6603
  type: 'string',
@@ -7762,7 +7846,8 @@ export const $AccountItemDto = {
7762
7846
  },
7763
7847
  displayName: {
7764
7848
  type: 'string',
7765
- description: 'Display name (last part of account path)',
7849
+ description:
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)',
7766
7851
  example: 'Savings'
7767
7852
  },
7768
7853
  balance: {
@@ -7934,7 +8019,8 @@ export const $AccountItemWithAssetClassDto = {
7934
8019
  },
7935
8020
  displayName: {
7936
8021
  type: 'string',
7937
- description: 'Display name (last part of account path)',
8022
+ description:
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)',
7938
8024
  example: 'Savings'
7939
8025
  },
7940
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 for account path
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