@firela/api-types 0.0.0-canary.3cce6a41 → 0.0.0-canary.3e45eeb0

package/src/generated/services.gen.ts

@@ -193,6 +193,8 @@ import type {
   TransactionRuleControllerDeleteResponse,
   TransactionRuleControllerTestData,
   TransactionRuleControllerTestResponse,
+  CategoryCatalogControllerListData,
+  CategoryCatalogControllerListResponse,
   EventControllerCreateData,
   EventControllerCreateResponse,
   EventControllerFindAllData,
@@ -2349,7 +2351,7 @@ export class UsersService {
    * Get current authenticated user
    * @param data The data for the request.
    * @param data.acceptLanguage
-   * @returns unknown User retrieved successfully
+   * @returns UserResponseDto User retrieved successfully
    * @throws ApiError
    */
   public static userControllerGetUser(
@@ -2856,6 +2858,34 @@ 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.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.scenario Filter by scenario
+   * @param data.routeBearing Filter by routeBearing (entity-router route() consumes it)
+   * @returns CategoryCatalogListResponseDto Category catalog retrieved successfully
+   * @throws ApiError
+   */
+  public static categoryCatalogControllerList(
+    data: CategoryCatalogControllerListData
+  ): CancelablePromise<CategoryCatalogControllerListResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/categories',
+      path: {
+        region: data.region
+      },
+      query: {
+        scenario: data.scenario,
+        routeBearing: data.routeBearing
+      }
+    });
+  }
+}
+
 export class LifeEventsService {
   /**
    * Create a new life event

package/src/generated/types.gen.ts

@@ -3016,6 +3016,32 @@ export type DeleteOwnUserDto = {
   accessToken: string;
 };
 
+export type UserSettingsResponseDto = {
+  /**
+   * Base currency (ISO 4217) for net-worth/report aggregation. Independent of region (ADR-0006).
+   */
+  baseCurrency: string | null;
+};
+
+export type UserResponseDto = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * Assigned user role
+   */
+  role: string;
+  /**
+   * Permission strings
+   */
+  permissions: Array<string>;
+  /**
+   * User settings
+   */
+  settings: UserSettingsResponseDto;
+};
+
 export type SignupDto = {
   /**
    * Cloudflare Turnstile verification token (optional when Turnstile disabled)
@@ -3502,6 +3528,57 @@ export type TestRuleResponseDto = {
   };
 };
 
+export type CategoryCatalogEntryDto = {
+  /**
+   * Category slug (single source-of-truth)
+   */
+  slug: string;
+  /**
+   * Display scenario group (maps to frontend picker _scenario)
+   */
+  scenario:
+    | 'expense'
+    | 'income'
+    | 'investment'
+    | 'banking'
+    | 'transfer'
+    | 'payment';
+  /**
+   * Lucide icon name
+   */
+  icon: string;
+  /**
+   * Applicable regions ('*' = all, 'cn' = CN-only)
+   */
+  regions: Array<string>;
+};
+
+/**
+ * Display scenario group (maps to frontend picker _scenario)
+ */
+export type scenario =
+  | 'expense'
+  | 'income'
+  | 'investment'
+  | 'banking'
+  | 'transfer'
+  | 'payment';
+
+export type CategoryCatalogListResponseDto = {
+  /**
+   * Category entries (region-scoped, query-filtered)
+   */
+  items: Array<CategoryCatalogEntryDto>;
+  /**
+   * Total category entries for the region (before query filtering)
+   */
+  total: number;
+  /**
+   * Region code
+   */
+  region: string;
+};
+
 export type CreateBeanEventDto = {
   /**
    * Life event date (ISO 8601)
@@ -4183,11 +4260,88 @@ export type ParserTelemetryReportDto = unknown;
 
 export type UncoveredFormatMissDto = unknown;
 
+export type ClientParsedDataDto = {
+  /**
+   * Transaction amount
+   */
+  amount?: number;
+  /**
+   * Currency code
+   */
+  currency?: string;
+  /**
+   * Transaction date (ISO 8601)
+   */
+  date?: string;
+  /**
+   * Payee/merchant name
+   */
+  payee?: string;
+  /**
+   * Transaction narration
+   */
+  narration?: string;
+  /**
+   * Category slug
+   */
+  category?: string;
+  /**
+   * Income type
+   */
+  incomeType?: string;
+  /**
+   * Income source
+   */
+  incomeSource?: string;
+  /**
+   * Security symbol code (e.g., 600519, AAPL)
+   */
+  symbol?: string;
+  /**
+   * Quantity of shares/units
+   */
+  quantity?: number;
+  /**
+   * Unit price per share/unit
+   */
+  price?: number;
+  /**
+   * Investment action
+   */
+  investmentAction?: 'buy' | 'sell';
+  /**
+   * Payment source: asset (default) or liability (credit card)
+   */
+  paymentSource?: 'asset' | 'liability';
+  /**
+   * Liability account hint (CreditCard/Huabei/Baitiao)
+   */
+  liabilityHint?: string;
+  /**
+   * Display-only warning from the prior response; accepted but ignored.
+   */
+  warning?: string;
+};
+
+/**
+ * Investment action
+ */
+export type investmentAction = 'buy' | 'sell';
+
+/**
+ * Payment source: asset (default) or liability (credit card)
+ */
+export type paymentSource = 'asset' | 'liability';
+
 export type ProcessNlpDto = {
   /**
-   * Natural language text describing a transaction (Chinese)
+   * Natural language text describing a transaction. Optional when `confirm` is true (structured confirm); otherwise required.
+   */
+  message?: string;
+  /**
+   * Structured confirm signal — bypasses NL confirm-word matching when true. Send parsedData field edits alongside. The NL word-list path is the fallback.
    */
-  message: string;
+  confirm?: boolean;
   /**
    * Session ID for multi-turn conversation (auto-generated if not provided)
    */
@@ -4195,9 +4349,7 @@ export type ProcessNlpDto = {
   /**
    * Parsed data from previous NLP response for session recovery. Send back the parsedData received in confirm_payee/confirm responses.
    */
-  parsedData?: {
-    [key: string]: unknown;
-  };
+  parsedData?: ClientParsedDataDto;
   /**
    * confirm_rule echo-back: rule id selected from the prior confirm_rule response (matchedRule.id or alternatives[i].ruleId). Applied directly when the session is confirming_rule — no NL re-parse.
    */
@@ -4302,16 +4454,6 @@ export type NlpParsedDataDto = {
   warning?: string;
 };
 
-/**
- * Investment action
- */
-export type investmentAction = 'buy' | 'sell';
-
-/**
- * Payment source: asset (default) or liability (credit card)
- */
-export type paymentSource = 'asset' | 'liability';
-
 export type NlpSourceTransactionDto = {
   /**
    * Transaction date (ISO format)
@@ -4639,7 +4781,12 @@ export type NlpResponseDto = {
   /**
    * Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.
    */
-  assetSubType?: 'transfer' | 'banking' | 'investment';
+  assetSubType?:
+    | 'transfer'
+    | 'banking'
+    | 'investment'
+    | 'lend'
+    | 'lend_collect';
   /**
    * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
    */
@@ -4756,7 +4903,12 @@ export type intent = 'expense' | 'asset' | 'income' | 'liability' | 'equity';
 /**
  * Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.
  */
-export type assetSubType = 'transfer' | 'banking' | 'investment';
+export type assetSubType =
+  | 'transfer'
+  | 'banking'
+  | 'investment'
+  | 'lend'
+  | 'lend_collect';
 
 /**
  * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
@@ -4797,7 +4949,7 @@ export type PlatformListItemDto = {
    */
   canonical: string;
   /**
-   * Suggested path segment — canonical with first char uppercased (ACC_COMP_NAME_RE)
+   * Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")
    */
   suggestedSegment: string;
   /**
@@ -4855,7 +5007,7 @@ export type PlatformMatchResultDto = {
     | 'INSURANCE'
     | 'OTHER';
   /**
-   * Suggested path segment — canonical, already in ACCOUNT_RE format
+   * Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")
    */
   suggestedSegment: string;
   /**
@@ -8437,7 +8589,7 @@ export type UserControllerGetUserData = {
   acceptLanguage: string;
 };
 
-export type UserControllerGetUserResponse = unknown;
+export type UserControllerGetUserResponse = UserResponseDto;
 
 export type UserControllerSignupUserData = {
   requestBody: SignupDto;
@@ -8909,6 +9061,55 @@ export type TransactionRuleControllerTestData = {
 
 export type TransactionRuleControllerTestResponse = TestRuleResponseDto;
 
+export type CategoryCatalogControllerListData = {
+  /**
+   * Region code for tenant context
+   */
+  region:
+    | 'ad'
+    | 'ae'
+    | 'af'
+    | 'ag'
+    | 'al'
+    | 'am'
+    | 'ao'
+    | 'au'
+    | 'br'
+    | 'ca'
+    | 'cn'
+    | 'de'
+    | 'dz'
+    | 'es'
+    | 'fr'
+    | 'gb'
+    | 'hk'
+    | 'in'
+    | 'it'
+    | 'jp'
+    | 'kr'
+    | 'nl'
+    | 'sg'
+    | 'tw'
+    | 'us';
+  /**
+   * Filter by routeBearing (entity-router route() consumes it)
+   */
+  routeBearing?: boolean;
+  /**
+   * Filter by scenario
+   */
+  scenario?:
+    | 'expense'
+    | 'income'
+    | 'investment'
+    | 'banking'
+    | 'transfer'
+    | 'payment';
+};
+
+export type CategoryCatalogControllerListResponse =
+  CategoryCatalogListResponseDto;
+
 export type EventControllerCreateData = {
   /**
    * Region code for tenant context (decorative for life events)
@@ -11570,7 +11771,7 @@ export type $OpenApiTs = {
         /**
          * User retrieved successfully
          */
-        200: unknown;
+        200: UserResponseDto;
       };
     };
     post: {
@@ -11944,6 +12145,17 @@ export type $OpenApiTs = {
       };
     };
   };
+  '/api/v1/{region}/bean/categories': {
+    get: {
+      req: CategoryCatalogControllerListData;
+      res: {
+        /**
+         * Category catalog retrieved successfully
+         */
+        200: CategoryCatalogListResponseDto;
+      };
+    };
+  };
   '/api/v1/{region}/bean/events': {
     post: {
       req: EventControllerCreateData;