@firela/api-types 0.0.0-canary.bd624c6e → 0.0.0-canary.bf10fc7c

package/package.json

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

package/src/generated/schemas.gen.ts

@@ -124,6 +124,8 @@ export const $AccountResponseDto = {
         'STUDENT_LOAN',
         'CREDIT_CARD',
         'PERSONAL_LOAN',
+        'ACCOUNTS_PAYABLE',
+        'TAX_PAYABLE',
         'OTHER'
       ],
       nullable: true,
@@ -395,9 +397,47 @@ export const $AccountStandardResponseDto = {
       type: 'string',
       description: 'Icon identifier for UI display',
       example: 'bank-icbc'
+    },
+    productCategory: {
+      type: 'string',
+      description:
+        'Onboarding product category (coarse grouping derived from assetSubClass)',
+      enum: [
+        'cash',
+        'investment',
+        'credit_card',
+        'loan',
+        'payable_tax',
+        'other'
+      ],
+      example: 'investment'
+    },
+    assetClass: {
+      type: 'string',
+      description:
+        'Asset class (LIQUIDITY/EQUITY/.../LIABILITY), derived at read time from classification rules',
+      enum: [
+        'LIQUIDITY',
+        'EQUITY',
+        'FIXED_INCOME',
+        'PRECIOUS_METALS',
+        'COMMODITY',
+        'INSURANCE',
+        'ALTERNATIVE_INVESTMENT',
+        'PERSONAL_ASSETS',
+        'LIABILITY',
+        'REAL_ESTATE',
+        'INDEX'
+      ]
+    },
+    assetSubClass: {
+      type: 'string',
+      description:
+        'Asset sub-class (product type, derived at read time from classification rules)',
+      example: 'STOCK'
     }
   },
-  required: ['path', 'type', 'description', 'tags', 'icon']
+  required: ['path', 'type', 'description', 'tags', 'icon', 'productCategory']
 } as const;
 
 export const $AccountStandardListResponseDto = {
@@ -4083,6 +4123,50 @@ export const $DeleteOwnUserDto = {
   required: ['accessToken']
 } as const;
 
+export const $UserSettingsResponseDto = {
+  type: 'object',
+  properties: {
+    baseCurrency: {
+      type: 'string',
+      description:
+        'Base currency (ISO 4217) for net-worth/report aggregation. Independent of region (ADR-0006).',
+      example: 'USD',
+      nullable: true
+    }
+  },
+  required: ['baseCurrency']
+} as const;
+
+export const $UserResponseDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'User ID'
+    },
+    role: {
+      type: 'string',
+      description: 'Assigned user role'
+    },
+    permissions: {
+      description: 'Permission strings',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    settings: {
+      description: 'User settings',
+      allOf: [
+        {
+          $ref: '#/components/schemas/UserSettingsResponseDto'
+        }
+      ]
+    }
+  },
+  required: ['id', 'role', 'permissions', 'settings']
+} as const;
+
 export const $SignupDto = {
   type: 'object',
   properties: {
@@ -4888,6 +4972,69 @@ export const $TestRuleResponseDto = {
   required: ['ruleId', 'matches', 'confidence', 'matchDetails']
 } as const;
 
+export const $CategoryCatalogEntryDto = {
+  type: 'object',
+  properties: {
+    slug: {
+      type: 'string',
+      description: 'Category slug (single source-of-truth)',
+      example: 'food'
+    },
+    scenario: {
+      type: 'string',
+      description: 'Display scenario group (maps to frontend picker _scenario)',
+      enum: [
+        'expense',
+        'income',
+        'investment',
+        'banking',
+        'transfer',
+        'payment'
+      ],
+      example: 'expense'
+    },
+    icon: {
+      type: 'string',
+      description: 'Lucide icon name',
+      example: 'utensils'
+    },
+    regions: {
+      description: "Applicable regions ('*' = all, 'cn' = CN-only)",
+      example: ['*'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    }
+  },
+  required: ['slug', 'scenario', 'icon', 'regions']
+} as const;
+
+export const $CategoryCatalogListResponseDto = {
+  type: 'object',
+  properties: {
+    items: {
+      description: 'Category entries (region-scoped, query-filtered)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CategoryCatalogEntryDto'
+      }
+    },
+    total: {
+      type: 'number',
+      description:
+        'Total category entries for the region (before query filtering)',
+      example: 30
+    },
+    region: {
+      type: 'string',
+      description: 'Region code',
+      example: 'cn'
+    }
+  },
+  required: ['items', 'total', 'region']
+} as const;
+
 export const $CreateBeanEventDto = {
   type: 'object',
   properties: {
@@ -5630,7 +5777,8 @@ export const $UpdateMapperDefaultsDto = {
       type: 'string',
       description: 'Source account for transactions (Beancount format)',
       example: 'Assets:CN:Alipay:Balance',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     currency: {
       type: 'string',
@@ -5644,13 +5792,15 @@ export const $UpdateMapperDefaultsDto = {
       type: 'string',
       description: 'Default expense account (optional)',
       example: 'Expenses:Unknown',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     incomeAccount: {
       type: 'string',
       description: 'Default income account (optional)',
       example: 'Income:Unknown',
-      pattern: '^[A-Z][a-zA-Z0-9-]*:[a-zA-Z0-9-:]+$'
+      pattern:
+        '^(Assets|Liabilities|Income|Expenses|Equity)(:[A-Za-z0-9][A-Za-z0-9-]*)+$'
     },
     methodAccountMapping: {
       type: 'object',
@@ -5707,12 +5857,14 @@ export const $ProviderSyncConfigDto = {
     },
     defaultExpenseAccount: {
       type: 'string',
-      description: 'Default expense account for the second posting',
+      description:
+        'Default expense account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
       example: 'Expenses:Unknown'
     },
     defaultIncomeAccount: {
       type: 'string',
-      description: 'Default income account for the second posting',
+      description:
+        'Default income account for the second posting. Omit when no real default exists; the pipeline routes to Review via the Uncategorized sentinel (#618).',
       example: 'Income:Unknown'
     },
     filterPending: {
@@ -5727,12 +5879,7 @@ export const $ProviderSyncConfigDto = {
       example: 'acc_gocardless_001'
     }
   },
-  required: [
-    'sourceAccount',
-    'defaultCurrency',
-    'defaultExpenseAccount',
-    'defaultIncomeAccount'
-  ]
+  required: ['sourceAccount', 'defaultCurrency']
 } as const;
 
 export const $ProviderSyncDto = {
@@ -5942,15 +6089,105 @@ export const $UncoveredFormatMissDto = {
   properties: {}
 } as const;
 
+export const $ClientParsedDataDto = {
+  type: 'object',
+  properties: {
+    amount: {
+      type: 'number',
+      description: 'Transaction amount',
+      example: 35
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency code',
+      example: 'CNY'
+    },
+    date: {
+      type: 'string',
+      description: 'Transaction date (ISO 8601)',
+      example: '2026-08-15'
+    },
+    payee: {
+      type: 'string',
+      description: 'Payee/merchant name',
+      example: 'Starbucks'
+    },
+    narration: {
+      type: 'string',
+      description: 'Transaction narration'
+    },
+    category: {
+      type: 'string',
+      description: 'Category slug',
+      example: 'food_restaurant'
+    },
+    incomeType: {
+      type: 'string',
+      description: 'Income type',
+      example: 'Salary'
+    },
+    incomeSource: {
+      type: 'string',
+      description: 'Income source',
+      example: 'Anthropic Inc.'
+    },
+    symbol: {
+      type: 'string',
+      description: 'Security symbol code (e.g., 600519, AAPL)',
+      example: 'AAPL'
+    },
+    quantity: {
+      type: 'number',
+      description: 'Quantity of shares/units',
+      example: 100
+    },
+    price: {
+      type: 'number',
+      description: 'Unit price per share/unit',
+      example: 1900
+    },
+    investmentAction: {
+      type: 'string',
+      description: 'Investment action',
+      enum: ['buy', 'sell'],
+      example: 'buy'
+    },
+    paymentSource: {
+      type: 'string',
+      description: 'Payment source: asset (default) or liability (credit card)',
+      enum: ['asset', 'liability'],
+      example: 'asset'
+    },
+    liabilityHint: {
+      type: 'string',
+      description: 'Liability account hint (CreditCard/Huabei/Baitiao)',
+      example: 'CreditCard'
+    },
+    warning: {
+      type: 'string',
+      description:
+        'Display-only warning from the prior response; accepted but ignored.',
+      example: 'Cross-currency settlement applies.'
+    }
+  }
+} as const;
+
 export const $ProcessNlpDto = {
   type: 'object',
   properties: {
     message: {
       type: 'string',
-      description: 'Natural language text describing a transaction (Chinese)',
-      example: 'yesterday Starbucks spent 35 yuan',
+      description:
+        'Natural language text describing a transaction. Optional when `confirm` is true (structured confirm); otherwise required.',
+      example: 'Starbucks 35',
       maxLength: 500
     },
+    confirm: {
+      type: 'boolean',
+      description:
+        'Structured confirm signal — bypasses NL confirm-word matching when true. Send parsedData field edits alongside. The NL word-list path is the fallback.',
+      example: true
+    },
     sessionId: {
       type: 'string',
       description:
@@ -5958,14 +6195,18 @@ export const $ProcessNlpDto = {
       example: 'session_abc123'
     },
     parsedData: {
-      type: 'object',
       description:
         'Parsed data from previous NLP response for session recovery. Send back the parsedData received in confirm_payee/confirm responses.',
       example: {
         amount: 35,
         currency: 'CNY',
         payee: 'Starbucks'
-      }
+      },
+      allOf: [
+        {
+          $ref: '#/components/schemas/ClientParsedDataDto'
+        }
+      ]
     },
     selectedRuleId: {
       type: 'string',
@@ -5979,8 +6220,7 @@ export const $ProcessNlpDto = {
         'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i], or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
       example: 'Expenses:Food:Coffee'
     }
-  },
-  required: ['message']
+  }
 } as const;
 
 export const $NlpTransactionInfoDto = {
@@ -6598,7 +6838,7 @@ export const $NlpResponseDto = {
       type: 'string',
       description:
         'Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.',
-      enum: ['transfer', 'banking', 'investment'],
+      enum: ['transfer', 'banking', 'investment', 'lend', 'lend_collect'],
       example: 'investment'
     },
     liabilitySubType: {
@@ -6801,13 +7041,26 @@ export const $PlatformListItemDto = {
     suggestedSegment: {
       type: 'string',
       description:
-        '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")'
     },
     logoUrl: {
       type: 'string',
       description: 'Logo URL',
       nullable: true
     },
+    countryCode: {
+      type: 'string',
+      description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
+      example: 'CN',
+      nullable: true
+    },
+    category: {
+      type: 'string',
+      description:
+        'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
+      nullable: true,
+      example: 'DigitalWallet'
+    },
     isBound: {
       type: 'boolean',
       description: 'Whether user has accounts using this platform'
@@ -6821,6 +7074,8 @@ export const $PlatformListItemDto = {
     'canonical',
     'suggestedSegment',
     'logoUrl',
+    'countryCode',
+    'category',
     'isBound'
   ]
 } as const;
@@ -6856,13 +7111,26 @@ export const $PlatformMatchResultDto = {
     suggestedSegment: {
       type: 'string',
       description:
-        'Suggested path segment — canonical, already in ACCOUNT_RE format'
+        'Suggested path segment — canonical PascalCased per hyphen-part, hyphens preserved (e.g. "Apple-Pay")'
     },
     logoUrl: {
       type: 'string',
       description: 'Logo URL',
       nullable: true
     },
+    countryCode: {
+      type: 'string',
+      description: 'ISO 3166-1 alpha-2 (UPPERCASE); null = global platform',
+      example: 'CN',
+      nullable: true
+    },
+    category: {
+      type: 'string',
+      description:
+        'Region-aware category (institution vocab, e.g. DigitalWallet/Bank). null = no region-aware suggestion; fall back to type.',
+      nullable: true,
+      example: 'DigitalWallet'
+    },
     matchType: {
       type: 'string',
       description: "How this row matched: 'exact' > 'prefix' > 'substring'",
@@ -6876,6 +7144,8 @@ export const $PlatformMatchResultDto = {
     'type',
     'suggestedSegment',
     'logoUrl',
+    'countryCode',
+    'category',
     'matchType'
   ]
 } as const;

package/src/generated/services.gen.ts

@@ -193,6 +193,8 @@ import type {
   TransactionRuleControllerDeleteResponse,
   TransactionRuleControllerTestData,
   TransactionRuleControllerTestResponse,
+  CategoryCatalogControllerListData,
+  CategoryCatalogControllerListResponse,
   EventControllerCreateData,
   EventControllerCreateResponse,
   EventControllerFindAllData,
@@ -257,6 +259,7 @@ import type {
   PlatformControllerFindAllResponse,
   PlatformControllerCreateData,
   PlatformControllerCreateResponse,
+  PlatformControllerGetPlatformListData,
   PlatformControllerGetPlatformListResponse,
   PlatformControllerMatchPlatformsData,
   PlatformControllerMatchPlatformsResponse,
@@ -2348,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(
@@ -2855,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
@@ -3730,13 +3761,20 @@ export class BeanPlatformsService {
 
   /**
    * Get platform list for current user
+   * @param data The data for the request.
+   * @param data.region Region code (ISO 3166-1 alpha-2) that biases within-type-bucket ordering (local-region platforms first). Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
    * @returns PlatformListItemDto List of platforms with user binding status
    * @throws ApiError
    */
-  public static platformControllerGetPlatformList(): CancelablePromise<PlatformControllerGetPlatformListResponse> {
+  public static platformControllerGetPlatformList(
+    data: PlatformControllerGetPlatformListData = {}
+  ): CancelablePromise<PlatformControllerGetPlatformListResponse> {
     return __request(OpenAPI, {
       method: 'GET',
-      url: '/api/v1/bean/platforms/list'
+      url: '/api/v1/bean/platforms/list',
+      query: {
+        region: data.region
+      }
     });
   }
 
@@ -3744,7 +3782,7 @@ export class BeanPlatformsService {
    * Match platforms by name or alias
    * @param data The data for the request.
    * @param data.q Search query — Chinese name, English name, or abbreviation
-   * @param data.region Region code for category override lookup
+   * @param data.region Region code (ISO 3166-1 alpha-2) that biases within-tier ordering (local-region platforms first); also the intended categoryOverrides key. Case-insensitive — stored/compared UPPERCASE ("cn" == "CN").
    * @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
    * @throws ApiError
    */