@firela/api-types 0.0.0-canary.e6edf4ac → 0.0.0-canary.e7253df6

package/dist/index.js

@@ -484,7 +484,7 @@ var BeanAccountsService = class {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for account path
+   * @param data.search Search term matched against account path and user-set display name (case-insensitive)
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully

package/dist/index.mjs

@@ -452,7 +452,7 @@ var BeanAccountsService = class {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for account path
+   * @param data.search Search term matched against account path and user-set display name (case-insensitive)
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firela/api-types",
-  "version": "0.0.0-canary.e6edf4ac",
+  "version": "0.0.0-canary.e7253df6",
   "description": "TypeScript types generated from IGN OpenAPI specification",
   "license": "MIT",
   "author": "FireLa Team",

package/src/generated/schemas.gen.ts

@@ -51,6 +51,14 @@ export const $CreateAccountDto = {
       description: 'Icon identifier (overrides template)',
       example: 'bank-custom'
     },
+    displayName: {
+      type: 'string',
+      description:
+        'User-set display name override (omit/null = keep the derived name)',
+      nullable: true,
+      maxLength: 50,
+      example: 'Salary card'
+    },
     openDirectiveMeta: {
       type: 'object',
       description:
@@ -181,7 +189,8 @@ export const $AccountResponseDto = {
     },
     displayName: {
       type: 'string',
-      description: 'Localized display name (ADR-0114, read-time projection)',
+      description:
+        'Display name with precedence: user-set name (#762) > ADR-0114 localized name > path leaf (read-time projection)',
       example: 'Checking'
     },
     icon: {
@@ -277,6 +286,14 @@ export const $UpdateAccountDto = {
       description: 'Icon identifier',
       example: 'bank-custom'
     },
+    displayName: {
+      type: 'string',
+      description:
+        'User-set display name override (null = clear the override and fall back to the derived name, omit = unchanged)',
+      nullable: true,
+      maxLength: 50,
+      example: 'Salary card'
+    },
     openDirectiveMeta: {
       type: 'object',
       description:
@@ -525,7 +542,10 @@ export const $RegionConfigDto = {
     },
     locale: {
       type: 'string',
-      example: 'de-DE'
+      example: 'de-DE',
+      pattern: '^[a-z]{2,8}-[A-Z]{2}$',
+      description:
+        "Region-qualified BCP-47 tag whose region subtag equals the region's own ISO 3166-1 code (e.g., ja-JP, zh-CN, zh-HK)"
     }
   },
   required: ['currency', 'dateFormat', 'locale']
@@ -538,6 +558,12 @@ export const $RegionInfoDto = {
       type: 'string',
       example: 'de'
     },
+    open: {
+      type: 'boolean',
+      example: true,
+      description:
+        'Whether the region is open (has a ready regional account template). Not-yet-open regions still return identity metadata and degrade to the universal-only catalog.'
+    },
     displayName: {
       type: 'string',
       example: 'Germany'
@@ -556,7 +582,7 @@ export const $RegionInfoDto = {
       $ref: '#/components/schemas/RegionConfigDto'
     }
   },
-  required: ['code', 'displayName', 'chain', 'config']
+  required: ['code', 'open', 'displayName', 'chain', 'config']
 } as const;
 
 export const $RegionsMetadataResponseDto = {
@@ -1978,13 +2004,17 @@ export const $ReviewStatsDto = {
       type: 'object',
       description: 'Count by type'
     },
+    resolved: {
+      type: 'number',
+      description: 'Current count of reviews in RESOLVED status'
+    },
     oldestPending: {
       format: 'date-time',
       type: 'string',
       description: 'Oldest pending review date'
     }
   },
-  required: ['total', 'byType']
+  required: ['total', 'byType', 'resolved']
 } as const;
 
 export const $DecisionOptionDto = {
@@ -2289,6 +2319,44 @@ export const $BatchResolveDto = {
   required: ['reviewIds', 'action']
 } as const;
 
+export const $BatchResolveItemDto = {
+  type: 'object',
+  properties: {
+    reviewId: {
+      type: 'string',
+      description: 'Review item ID'
+    },
+    success: {
+      type: 'boolean',
+      description: 'Whether this item was resolved successfully'
+    },
+    resolutionId: {
+      type: 'string',
+      description:
+        'Resolution ID for undo. Present only on successful items (failed items stay PENDING).'
+    },
+    messageKey: {
+      type: 'string',
+      description:
+        '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.'
+    },
+    messageParams: {
+      type: 'object',
+      description:
+        'Parameters for message interpolation (e.g., { name: "PayeeName" })',
+      additionalProperties: {
+        type: 'string'
+      }
+    },
+    error: {
+      type: 'string',
+      description:
+        '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).'
+    }
+  },
+  required: ['reviewId', 'success']
+} as const;
+
 export const $BatchResolveResultDto = {
   type: 'object',
   properties: {
@@ -2304,7 +2372,7 @@ export const $BatchResolveResultDto = {
       description: 'Details for each item',
       type: 'array',
       items: {
-        type: 'string'
+        $ref: '#/components/schemas/BatchResolveItemDto'
       }
     }
   },
@@ -5204,9 +5272,23 @@ export const $CategoryCatalogEntryDto = {
       items: {
         type: 'string'
       }
+    },
+    categoryAccounts: {
+      description:
+        "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.",
+      example: [
+        'Expenses:Utilities:Electricity',
+        'Expenses:Utilities:Gas',
+        'Expenses:Utilities:Internet',
+        'Expenses:Utilities:Water'
+      ],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
     }
   },
-  required: ['slug', 'scenario', 'icon', 'regions']
+  required: ['slug', 'scenario', 'icon', 'regions', 'categoryAccounts']
 } as const;
 
 export const $CategoryCatalogListResponseDto = {
@@ -5397,6 +5479,14 @@ export const $OnboardingAccountDto = {
       description:
         'Platform ID to bind the account to (references Platform.id); omit for unbound',
       example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
+    },
+    displayName: {
+      type: 'string',
+      description:
+        'User-set display name override (omit/null = keep the derived name)',
+      nullable: true,
+      maxLength: 50,
+      example: 'Salary card'
     }
   },
   required: ['path', 'currency']
@@ -6317,8 +6407,9 @@ export const $ClientParsedDataDto = {
     },
     category: {
       type: 'string',
-      description: 'Category slug',
-      example: 'food_restaurant'
+      description:
+        '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.',
+      example: 'food'
     },
     incomeType: {
       type: 'string',
@@ -6504,7 +6595,9 @@ export const $NlpParsedDataDto = {
     },
     category: {
       type: 'string',
-      description: 'Category'
+      description:
+        '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.',
+      example: 'food'
     },
     incomeType: {
       type: 'string',
@@ -7753,7 +7846,8 @@ export const $AccountItemDto = {
     },
     displayName: {
       type: 'string',
-      description: 'Display name (last part of account path)',
+      description:
+        '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)',
       example: 'Savings'
     },
     balance: {
@@ -7925,7 +8019,8 @@ export const $AccountItemWithAssetClassDto = {
     },
     displayName: {
       type: 'string',
-      description: 'Display name (last part of account path)',
+      description:
+        '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)',
       example: 'Savings'
     },
     balance: {

package/src/generated/services.gen.ts

@@ -337,7 +337,7 @@ export class BeanAccountsService {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for account path
+   * @param data.search Search term matched against account path and user-set display name (case-insensitive)
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully
@@ -533,9 +533,9 @@ export class BeanAccountsService {
 export class BeanAccountStandardsService {
   /**
    * Get account templates
-   * Returns predefined account templates for a region. Supports filtering by account type and search term.
+   * Returns predefined account templates for a region. Supports filtering by account type and search term. Not-yet-open region codes return the universal-only catalog (#759).
    * @param data The data for the request.
-   * @param data.region Region code (cn, us, de)
+   * @param data.region Region code (any ISO alpha-2; not-yet-open codes return the universal-only catalog)
    * @param data.type Filter by account type
    * @param data.search Search term for path, description, aliases, or localized display name
    * @returns AccountStandardListResponseDto Account templates retrieved successfully
@@ -561,7 +561,7 @@ export class BeanAccountStandardsService {
    * Get template metadata for an account path
    * Returns root type for a template path.
    * @param data The data for the request.
-   * @param data.region Region code for tenant context
+   * @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
    * @param data.path Account path to check
    * @returns TemplateMetadataResponseDto Template metadata retrieved successfully
    * @throws ApiError
@@ -583,9 +583,9 @@ export class BeanAccountStandardsService {
 
   /**
    * Get available regions with hierarchy
-   * Returns supported regions with inheritance metadata
+   * Returns the full region catalog (every ISO 3166-1 entry) with an 'open' flag and inheritance metadata (#759)
    * @param data The data for the request.
-   * @param data.region Region code for tenant context
+   * @param data.region Region code for tenant context. Not-yet-open codes degrade to the universal-only catalog (#759)
    * @returns RegionsMetadataResponseDto Regions metadata retrieved successfully
    * @throws ApiError
    */
@@ -2867,7 +2867,7 @@ export class BeanTransactionRulesService {
 export class BeanCategoryCatalogService {
   /**
    * List category catalog for a region
-   * 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.
+   * 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.
    * @param data The data for the request.
    * @param data.region Region code for tenant context
    * @param data.scenario Filter by scenario
@@ -3071,7 +3071,7 @@ export class OnboardingService {
   /**
    * Bootstrap core accounts + register asset accounts with opening balances (ADR-0113)
    * @param data The data for the request.
-   * @param data.region Region code for tenant context
+   * @param data.region Region code for tenant context. Not-yet-open codes are accepted: the universal catalog backs onboarding regardless of region (#759)
    * @param data.requestBody
    * @returns unknown Onboarding bootstrap result.
    * @throws ApiError