@firela/api-types 0.0.0-canary.bd196208 → 0.0.0-canary.bd300c5f

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.bd196208",
3
+ "version": "0.0.0-canary.bd300c5f",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -2004,13 +2004,17 @@ export const $ReviewStatsDto = {
2004
2004
  type: 'object',
2005
2005
  description: 'Count by type'
2006
2006
  },
2007
+ resolved: {
2008
+ type: 'number',
2009
+ description: 'Current count of reviews in RESOLVED status'
2010
+ },
2007
2011
  oldestPending: {
2008
2012
  format: 'date-time',
2009
2013
  type: 'string',
2010
2014
  description: 'Oldest pending review date'
2011
2015
  }
2012
2016
  },
2013
- required: ['total', 'byType']
2017
+ required: ['total', 'byType', 'resolved']
2014
2018
  } as const;
2015
2019
 
2016
2020
  export const $DecisionOptionDto = {
@@ -2315,6 +2319,44 @@ export const $BatchResolveDto = {
2315
2319
  required: ['reviewIds', 'action']
2316
2320
  } as const;
2317
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
+
2318
2360
  export const $BatchResolveResultDto = {
2319
2361
  type: 'object',
2320
2362
  properties: {
@@ -2330,7 +2372,7 @@ export const $BatchResolveResultDto = {
2330
2372
  description: 'Details for each item',
2331
2373
  type: 'array',
2332
2374
  items: {
2333
- type: 'string'
2375
+ $ref: '#/components/schemas/BatchResolveItemDto'
2334
2376
  }
2335
2377
  }
2336
2378
  },
@@ -5230,9 +5272,23 @@ export const $CategoryCatalogEntryDto = {
5230
5272
  items: {
5231
5273
  type: 'string'
5232
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
+ }
5233
5289
  }
5234
5290
  },
5235
- required: ['slug', 'scenario', 'icon', 'regions']
5291
+ required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
5236
5292
  } as const;
5237
5293
 
5238
5294
  export const $CategoryCatalogListResponseDto = {
@@ -6351,8 +6407,9 @@ export const $ClientParsedDataDto = {
6351
6407
  },
6352
6408
  category: {
6353
6409
  type: 'string',
6354
- description: 'Category slug',
6355
- 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'
6356
6413
  },
6357
6414
  incomeType: {
6358
6415
  type: 'string',
@@ -6538,7 +6595,9 @@ export const $NlpParsedDataDto = {
6538
6595
  },
6539
6596
  category: {
6540
6597
  type: 'string',
6541
- 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'
6542
6601
  },
6543
6602
  incomeType: {
6544
6603
  type: 'string',
@@ -7788,7 +7847,7 @@ export const $AccountItemDto = {
7788
7847
  displayName: {
7789
7848
  type: 'string',
7790
7849
  description:
7791
- '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)',
7792
7851
  example: 'Savings'
7793
7852
  },
7794
7853
  balance: {
@@ -7961,7 +8020,7 @@ export const $AccountItemWithAssetClassDto = {
7961
8020
  displayName: {
7962
8021
  type: 'string',
7963
8022
  description:
7964
- '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)',
7965
8024
  example: 'Savings'
7966
8025
  },
7967
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