@firela/api-types 0.0.0-canary.da82874e → 0.0.0-canary.de851cbd

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.da82874e",
3
+ "version": "0.0.0-canary.de851cbd",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -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:
@@ -5222,9 +5230,23 @@ export const $CategoryCatalogEntryDto = {
5222
5230
  items: {
5223
5231
  type: 'string'
5224
5232
  }
5233
+ },
5234
+ categoryAccounts: {
5235
+ description:
5236
+ "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.",
5237
+ example: [
5238
+ 'Expenses:Utilities:Electricity',
5239
+ 'Expenses:Utilities:Gas',
5240
+ 'Expenses:Utilities:Internet',
5241
+ 'Expenses:Utilities:Water'
5242
+ ],
5243
+ type: 'array',
5244
+ items: {
5245
+ type: 'string'
5246
+ }
5225
5247
  }
5226
5248
  },
5227
- required: ['slug', 'scenario', 'icon', 'regions']
5249
+ required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
5228
5250
  } as const;
5229
5251
 
5230
5252
  export const $CategoryCatalogListResponseDto = {
@@ -6343,8 +6365,9 @@ export const $ClientParsedDataDto = {
6343
6365
  },
6344
6366
  category: {
6345
6367
  type: 'string',
6346
- description: 'Category slug',
6347
- example: 'food_restaurant'
6368
+ description:
6369
+ '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.',
6370
+ example: 'food'
6348
6371
  },
6349
6372
  incomeType: {
6350
6373
  type: 'string',
@@ -6530,7 +6553,9 @@ export const $NlpParsedDataDto = {
6530
6553
  },
6531
6554
  category: {
6532
6555
  type: 'string',
6533
- description: 'Category'
6556
+ description:
6557
+ '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.',
6558
+ example: 'food'
6534
6559
  },
6535
6560
  incomeType: {
6536
6561
  type: 'string',
@@ -7780,7 +7805,7 @@ export const $AccountItemDto = {
7780
7805
  displayName: {
7781
7806
  type: 'string',
7782
7807
  description:
7783
- 'Display name: user-set name if provided (#762), else last part of account path',
7808
+ '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
7809
  example: 'Savings'
7785
7810
  },
7786
7811
  balance: {
@@ -7953,7 +7978,7 @@ export const $AccountItemWithAssetClassDto = {
7953
7978
  displayName: {
7954
7979
  type: 'string',
7955
7980
  description:
7956
- 'Display name: user-set name if provided (#762), else last part of account path',
7981
+ '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
7982
  example: 'Savings'
7958
7983
  },
7959
7984
  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