@firela/api-types 0.0.0-canary.97006feb → 0.0.0-canary.a0b42138

package/src/generated/schemas.gen.ts

@@ -88,6 +88,49 @@ export const $AccountResponseDto = {
       enum: ['Assets', 'Liabilities', 'Income', 'Expenses', 'Equity'],
       example: 'Assets'
     },
+    assetSubClass: {
+      type: 'string',
+      description:
+        'Account-level asset sub-class (product type, e.g. STOCK/DEPOSIT/CREDIT_CARD/PERSONAL_LOAN). Computed from the account path via the asset-classifier (ADR-0077). Null for non-asset accounts (Income/Expenses/Equity) or unmatched paths.',
+      enum: [
+        'DEPOSIT',
+        'CASH',
+        'MONEY_MARKET_FUND',
+        'STOCK',
+        'ETF',
+        'MUTUAL_FUND',
+        'EQUITY_COMPENSATION',
+        'GOVERNMENT_BOND',
+        'CORPORATE_BOND',
+        'BOND_FUND',
+        'PRIMARY_RESIDENCE',
+        'INVESTMENT_PROPERTY',
+        'REIT',
+        'GOLD',
+        'SILVER',
+        'PRECIOUS_METAL',
+        'PRECIOUS_METAL_FUND',
+        'COMMODITY',
+        'COMMODITY_FUND',
+        'CRYPTOCURRENCY',
+        'RETIREMENT_ACCOUNT',
+        'HEALTH_ACCOUNT',
+        'EDUCATION_ACCOUNT',
+        'INSURANCE',
+        'PRIVATE_EQUITY',
+        'HEDGE_FUND',
+        'COLLECTIBLES',
+        'MORTGAGE',
+        'STUDENT_LOAN',
+        'CREDIT_CARD',
+        'PERSONAL_LOAN',
+        'ACCOUNTS_PAYABLE',
+        'TAX_PAYABLE',
+        'OTHER'
+      ],
+      nullable: true,
+      example: 'STOCK'
+    },
     status: {
       type: 'string',
       description: 'Account status',
@@ -354,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 = {
@@ -4042,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: {
@@ -4847,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: {
@@ -5589,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',
@@ -5603,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',
@@ -5666,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: {
@@ -5686,12 +5879,7 @@ export const $ProviderSyncConfigDto = {
       example: 'acc_gocardless_001'
     }
   },
-  required: [
-    'sourceAccount',
-    'defaultCurrency',
-    'defaultExpenseAccount',
-    'defaultIncomeAccount'
-  ]
+  required: ['sourceAccount', 'defaultCurrency']
 } as const;
 
 export const $ProviderSyncDto = {
@@ -5901,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:
@@ -5917,17 +6195,32 @@ 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',
+      description:
+        '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.',
+      example: 'rule_abc123'
+    },
+    selectedAccount: {
+      type: 'string',
+      description:
+        '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 = {
@@ -6249,7 +6542,8 @@ export const $NlpAccountConfirmationDataDto = {
     },
     suggestedAccount: {
       type: 'string',
-      description: 'Suggested replacement account',
+      description:
+        'Suggested replacement account (omitted when no clear candidate)',
       example: 'Expenses:Food:Drinks'
     },
     similarAccounts: {
@@ -6271,7 +6565,6 @@ export const $NlpAccountConfirmationDataDto = {
   },
   required: [
     'invalidAccount',
-    'suggestedAccount',
     'similarAccounts',
     'errorMessage',
     'transactionContext'
@@ -6444,7 +6737,8 @@ export const $NlpSuggestedAccountDto = {
     },
     confidence: {
       type: 'number',
-      description: 'Confidence score for this suggestion (0-1)',
+      description:
+        'Confidence score for this suggestion (0-1). Present = predicted (confirm/confirm_rule/confirm_account); omitted = actual persisted account (created). (#586)',
       example: 0.9
     }
   },
@@ -6480,23 +6774,31 @@ export const $NlpDefaultAccountsDto = {
   properties: {
     asset: {
       type: 'string',
-      description: 'Default asset account',
-      example: 'Assets:Checking'
+      description:
+        'Default OPEN asset account (MRU when multiple), or null when none/ambiguous',
+      example: 'Assets:Checking',
+      nullable: true
     },
     expense: {
       type: 'string',
-      description: 'Default expense account',
-      example: 'Expenses:Uncategorized'
+      description:
+        'Default OPEN expense account (MRU when multiple), or null when none/ambiguous',
+      example: 'Expenses:Food:Coffee',
+      nullable: true
     },
     income: {
       type: 'string',
-      description: 'Default income account',
-      example: 'Income:Uncategorized'
+      description:
+        'Default OPEN income account (MRU when multiple), or null when none/ambiguous',
+      example: 'Income:Salary',
+      nullable: true
     },
     liability: {
       type: 'string',
-      description: 'Default liability account',
-      example: 'Liabilities:CreditCard'
+      description:
+        'Default OPEN liability account (MRU when multiple), or null when none/ambiguous',
+      example: 'Liabilities:CreditCard',
+      nullable: true
     }
   },
   required: ['asset', 'expense', 'income', 'liability']
@@ -6536,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: {
@@ -6684,7 +6986,7 @@ export const $NlpResponseDto = {
     },
     suggestedAccounts: {
       description:
-        'Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.',
+        'Suggested accounts for this transaction (#586). confirm/confirm_rule/confirm_account: predicted (source/destination carry confidence); created: actual persisted accounts (confidence omitted). confirm_account destination is the suggested replacement, never the invalid account.',
       allOf: [
         {
           $ref: '#/components/schemas/NlpSuggestedAccountsDto'
@@ -6693,7 +6995,7 @@ export const $NlpResponseDto = {
     },
     defaultAccounts: {
       description:
-        'Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.',
+        'Default fallback accounts for the user/region (#586). v1 returns universal constants; per-user personalization is planned.',
       allOf: [
         {
           $ref: '#/components/schemas/NlpDefaultAccountsDto'
@@ -6739,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'
@@ -6759,6 +7074,8 @@ export const $PlatformListItemDto = {
     'canonical',
     'suggestedSegment',
     'logoUrl',
+    'countryCode',
+    'category',
     'isBound'
   ]
 } as const;
@@ -6794,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'",
@@ -6814,6 +7144,8 @@ export const $PlatformMatchResultDto = {
     'type',
     'suggestedSegment',
     'logoUrl',
+    'countryCode',
+    'category',
     'matchType'
   ]
 } as const;
@@ -8062,3 +8394,146 @@ export const $AnonymousLoginResponseDto = {
   },
   required: ['authToken']
 } as const;
+
+export const $SymbolSearchResultDto = {
+  type: 'object',
+  properties: {
+    symbol: {
+      type: 'string',
+      example: 'AAPL'
+    },
+    name: {
+      type: 'object',
+      example: 'Apple Inc.',
+      nullable: true
+    },
+    exchange: {
+      type: 'object',
+      example: 'US',
+      nullable: true
+    },
+    assetType: {
+      type: 'object',
+      description: 'OpenBB asset_type (e.g. stock, etf)',
+      example: 'stock',
+      nullable: true
+    },
+    assetClass: {
+      type: 'object',
+      description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
+      example: 'EQUITY',
+      nullable: true
+    },
+    assetSubClass: {
+      type: 'object',
+      description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
+      example: 'STOCK',
+      nullable: true
+    },
+    currency: {
+      type: 'object',
+      description: 'Trading currency (extra_data or inferred from exchange)',
+      example: 'USD',
+      nullable: true
+    }
+  },
+  required: ['symbol']
+} as const;
+
+export const $SymbolQuoteDto = {
+  type: 'object',
+  properties: {
+    symbol: {
+      type: 'string',
+      example: 'AAPL'
+    },
+    name: {
+      type: 'object',
+      example: 'Apple Inc.',
+      nullable: true
+    },
+    exchange: {
+      type: 'object',
+      example: 'US',
+      nullable: true
+    },
+    assetType: {
+      type: 'object',
+      description: 'OpenBB asset_type',
+      example: 'stock',
+      nullable: true
+    },
+    assetClass: {
+      type: 'object',
+      description: 'IGN asset class',
+      example: 'EQUITY',
+      nullable: true
+    },
+    assetSubClass: {
+      type: 'object',
+      description: 'IGN asset sub-class',
+      example: 'STOCK',
+      nullable: true
+    },
+    currency: {
+      type: 'object',
+      description: 'Trading currency (extra_data or inferred from exchange)',
+      example: 'USD',
+      nullable: true
+    },
+    price: {
+      type: 'object',
+      description: 'Latest price (Decimal string)',
+      example: '189.84',
+      nullable: true
+    },
+    priceDate: {
+      type: 'object',
+      description: 'Date the price was observed (ISO yyyy-MM-dd)',
+      example: '2026-08-05',
+      nullable: true
+    },
+    changePercent: {
+      type: 'object',
+      description:
+        'Change vs previous close, in percentage points (1.7 == 1.7%). openbb stores change_percent as a normalized decimal; this exposes percentage points for frontend convenience.',
+      example: 1.7,
+      nullable: true
+    },
+    prevClose: {
+      type: 'object',
+      description: 'Previous close (Decimal string)',
+      nullable: true
+    },
+    open: {
+      type: 'object',
+      description: 'Day open (Decimal string)',
+      nullable: true
+    },
+    high: {
+      type: 'object',
+      description: 'Day high (Decimal string)',
+      nullable: true
+    },
+    low: {
+      type: 'object',
+      description: 'Day low (Decimal string)',
+      nullable: true
+    },
+    volume: {
+      type: 'object',
+      description: 'Day volume (Decimal string)',
+      nullable: true
+    },
+    yearHigh: {
+      type: 'object',
+      description: '52-week high (Decimal string)',
+      nullable: true
+    },
+    yearLow: {
+      type: 'object',
+      description: '52-week low (Decimal string)',
+      nullable: true
+    }
+  }
+} as const;