@firela/api-types 0.0.0-canary.9d18b250 → 0.0.0-canary.a026f79e

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: {
@@ -197,7 +206,7 @@ export const $AccountResponseDto = {
       }
     },
     platformId: {
-      type: 'object',
+      type: 'string',
       description: 'Platform ID (null if unbound)',
       example: 'c98e5d4a-2f71-4a5a-bb3c-92c9f231d5e2'
     },
@@ -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 = {
@@ -2537,10 +2563,10 @@ export const $UpdatePayeeDto = {
     meta: {
       type: 'object',
       description:
-        'Metadata for extended information (location, notes, contact info, etc.). Will merge with existing metadata.',
+        'Metadata for extended information (location, notes, contact info, etc.)',
       example: {
         location: 'Zhongguancun',
-        note: 'Updated note',
+        note: 'Near subway station',
         favorite: true
       }
     },
@@ -3132,7 +3158,7 @@ export const $TimeSeriesPointDto = {
       example: '500000.00'
     },
     change: {
-      type: 'object',
+      type: 'string',
       description: 'Change from previous point',
       example: '5000.00'
     },
@@ -3553,7 +3579,7 @@ export const $UserSettingsResponseDto = {
   type: 'object',
   properties: {
     baseCurrency: {
-      type: 'object',
+      type: 'string',
       description:
         'Stored base currency choice (ISO 4217) for net-worth/report aggregation. null = user never chose; aggregates fall back to the region default at display time (#713).',
       example: 'USD',
@@ -3862,7 +3888,7 @@ export const $RecurringRuleResponseDto = {
       description: 'Rule name'
     },
     icon: {
-      type: 'object',
+      type: 'string',
       description: 'Icon emoji'
     },
     frequency: {
@@ -3874,11 +3900,11 @@ export const $RecurringRuleResponseDto = {
       description: 'Expected amount'
     },
     expectedDay: {
-      type: 'object',
+      type: 'number',
       description: 'Expected day of month'
     },
     customIntervalDays: {
-      type: 'object',
+      type: 'number',
       description: 'Custom interval in days'
     },
     currency: {
@@ -3886,7 +3912,7 @@ export const $RecurringRuleResponseDto = {
       description: 'Currency code'
     },
     matchPayeePattern: {
-      type: 'object',
+      type: 'string',
       description: 'Payee matching pattern'
     },
     matchAmountTolerance: {
@@ -3894,15 +3920,15 @@ export const $RecurringRuleResponseDto = {
       description: 'Amount tolerance percentage'
     },
     defaultExpenseAccount: {
-      type: 'object',
+      type: 'string',
       description: 'Default expense account'
     },
     defaultPaymentAccount: {
-      type: 'object',
+      type: 'string',
       description: 'Default payment account'
     },
     defaultPayee: {
-      type: 'object',
+      type: 'string',
       description: 'Default payee'
     },
     isActive: {
@@ -3914,7 +3940,7 @@ export const $RecurringRuleResponseDto = {
       description: 'Rule start date (YYYY-MM-DD)'
     },
     endDate: {
-      type: 'object',
+      type: 'string',
       description: 'Rule end date (YYYY-MM-DD)'
     },
     autoCreate: {
@@ -3922,7 +3948,7 @@ export const $RecurringRuleResponseDto = {
       description: 'Auto-create transaction on expected date'
     },
     lastOccurrence: {
-      type: 'object',
+      type: 'string',
       description: 'Last matched occurrence date (YYYY-MM-DD)'
     },
     totalCount: {
@@ -4004,7 +4030,7 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Rule name'
     },
     icon: {
-      type: 'object',
+      type: 'string',
       description: 'Icon emoji'
     },
     frequency: {
@@ -4016,11 +4042,11 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Expected amount'
     },
     expectedDay: {
-      type: 'object',
+      type: 'number',
       description: 'Expected day of month'
     },
     customIntervalDays: {
-      type: 'object',
+      type: 'number',
       description: 'Custom interval in days'
     },
     currency: {
@@ -4028,7 +4054,7 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Currency code'
     },
     matchPayeePattern: {
-      type: 'object',
+      type: 'string',
       description: 'Payee matching pattern'
     },
     matchAmountTolerance: {
@@ -4036,15 +4062,15 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Amount tolerance percentage'
     },
     defaultExpenseAccount: {
-      type: 'object',
+      type: 'string',
       description: 'Default expense account'
     },
     defaultPaymentAccount: {
-      type: 'object',
+      type: 'string',
       description: 'Default payment account'
     },
     defaultPayee: {
-      type: 'object',
+      type: 'string',
       description: 'Default payee'
     },
     isActive: {
@@ -4056,7 +4082,7 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Rule start date (YYYY-MM-DD)'
     },
     endDate: {
-      type: 'object',
+      type: 'string',
       description: 'Rule end date (YYYY-MM-DD)'
     },
     autoCreate: {
@@ -4064,7 +4090,7 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Auto-create transaction on expected date'
     },
     lastOccurrence: {
-      type: 'object',
+      type: 'string',
       description: 'Last matched occurrence date (YYYY-MM-DD)'
     },
     totalCount: {
@@ -4090,7 +4116,7 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Number of overdue expected transactions'
     },
     nextExpectedDate: {
-      type: 'object',
+      type: 'string',
       description: 'Next expected date (YYYY-MM-DD)'
     },
     totalAmount: {
@@ -4106,11 +4132,11 @@ export const $RecurringRuleWithStatsResponseDto = {
       description: 'Number of matched transactions'
     },
     firstDate: {
-      type: 'object',
+      type: 'string',
       description: 'First matched transaction date (YYYY-MM-DD)'
     },
     lastDate: {
-      type: 'object',
+      type: 'string',
       description: 'Last matched transaction date (YYYY-MM-DD)'
     },
     variance: {
@@ -4151,7 +4177,7 @@ export const $UpdateRecurringRuleDto = {
   properties: {
     name: {
       type: 'string',
-      description: 'Rule name',
+      description: 'Rule name (unique per user)',
       maxLength: 100
     },
     icon: {
@@ -4174,7 +4200,7 @@ export const $UpdateRecurringRuleDto = {
     },
     expectedAmount: {
       type: 'number',
-      description: 'Expected amount',
+      description: 'Expected amount (positive number)',
       minimum: 0
     },
     expectedDay: {
@@ -4183,11 +4209,6 @@ export const $UpdateRecurringRuleDto = {
       minimum: 1,
       maximum: 31
     },
-    customIntervalDays: {
-      type: 'number',
-      description: 'Custom interval in days',
-      minimum: 1
-    },
     currency: {
       type: 'string',
       description: 'Currency code',
@@ -4195,41 +4216,48 @@ export const $UpdateRecurringRuleDto = {
     },
     matchPayeePattern: {
       type: 'string',
-      description: 'Payee matching pattern',
+      description: 'Payee matching pattern (supports wildcards)',
       maxLength: 200
     },
     matchAmountTolerance: {
       type: 'number',
       description: 'Amount tolerance percentage (0-1)',
+      default: 0.075,
       minimum: 0,
       maximum: 1
     },
     defaultExpenseAccount: {
       type: 'string',
-      description: 'Default expense account',
+      description: 'Default expense account for auto-create',
       maxLength: 200
     },
     defaultPaymentAccount: {
       type: 'string',
-      description: 'Default payment account',
+      description: 'Default payment account for auto-create',
       maxLength: 200
     },
     defaultPayee: {
       type: 'string',
-      description: 'Default payee',
+      description: 'Default payee for auto-create',
       maxLength: 200
     },
     autoCreate: {
       type: 'boolean',
-      description: 'Auto-create transaction'
-    },
-    isActive: {
-      type: 'boolean',
-      description: 'Rule active status'
+      description: 'Auto-create transaction when expected date arrives',
+      default: false
     },
     endDate: {
       type: 'string',
       description: 'Rule end date (ISO format)'
+    },
+    customIntervalDays: {
+      type: 'number',
+      description: 'Custom interval in days',
+      minimum: 1
+    },
+    isActive: {
+      type: 'boolean',
+      description: 'Rule active status'
     }
   }
 } as const;
@@ -4242,7 +4270,7 @@ export const $ExpectedTransactionRuleDto = {
       description: 'Rule name'
     },
     icon: {
-      type: 'object',
+      type: 'string',
       description: 'Rule icon'
     },
     frequency: {
@@ -4285,15 +4313,15 @@ export const $ExpectedTransactionResponseDto = {
       description: 'Status (PENDING, COMPLETED, SKIPPED)'
     },
     matchedTransactionId: {
-      type: 'object',
+      type: 'string',
       description: 'Matched transaction ID'
     },
     matchedAt: {
-      type: 'object',
+      type: 'string',
       description: 'Match timestamp (ISO 8601)'
     },
     matchConfidence: {
-      type: 'object',
+      type: 'number',
       description: 'Match confidence score (0-1)'
     },
     isOverdue: {
@@ -5077,7 +5105,8 @@ export const $UpdateTransactionRuleDto = {
     },
     matchLogic: {
       type: 'string',
-      enum: ['OR', 'AND']
+      enum: ['OR', 'AND'],
+      default: 'OR'
     },
     amountMin: {
       type: 'number',
@@ -5091,13 +5120,10 @@ export const $UpdateTransactionRuleDto = {
     },
     priority: {
       type: 'number',
+      default: 50,
       minimum: 0,
       maximum: 1000
     },
-    enabled: {
-      type: 'boolean',
-      description: 'Enable or disable the rule'
-    },
     additionalTags: {
       items: {
         type: 'array'
@@ -5107,6 +5133,10 @@ export const $UpdateTransactionRuleDto = {
     },
     additionalMetadata: {
       type: 'object'
+    },
+    enabled: {
+      type: 'boolean',
+      description: 'Enable or disable the rule'
     }
   }
 } as const;
@@ -5200,9 +5230,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 = {
@@ -5393,6 +5437,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']
@@ -6313,8 +6365,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',
@@ -6500,7 +6553,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',
@@ -7585,7 +7640,8 @@ export const $UpdatePlatformDto = {
     },
     isActive: {
       type: 'boolean',
-      description: 'Whether the platform is active'
+      description: 'Whether the platform is active',
+      default: true
     }
   }
 } as const;
@@ -7748,7 +7804,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: {
@@ -7920,7 +7977,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: {
@@ -8406,7 +8464,7 @@ export const $MonetaryDto = {
       example: 'USD'
     },
     baseCcyEquivalent: {
-      type: 'object',
+      type: 'string',
       description: 'Converted to user base currency (Decimal string)',
       example: '21600',
       nullable: true
@@ -8482,13 +8540,13 @@ export const $HoldingPnlRowDto = {
       example: 'Assets:US:Broker:AAPL'
     },
     accountCcy: {
-      type: 'object',
+      type: 'string',
       description: 'Account settlement currency (ISO 4217), from cost currency',
       nullable: true,
       example: 'USD'
     },
     brokerType: {
-      type: 'object',
+      type: 'string',
       description: 'Broker type derived from Platform.type',
       nullable: true,
       example: 'broker'
@@ -8509,7 +8567,7 @@ export const $HoldingPnlRowDto = {
       example: 'EQUITY'
     },
     assetSubClass: {
-      type: 'object',
+      type: 'string',
       nullable: true,
       example: 'STOCK'
     },
@@ -8556,14 +8614,14 @@ export const $HoldingPnlRowDto = {
       ]
     },
     unrealizedPnlBase: {
-      type: 'object',
+      type: 'string',
       description:
         'Unrealized P&L in base currency (Decimal string); null when any FX/price missing',
       nullable: true,
       example: '6000'
     },
     unrealizedPnlPct: {
-      type: 'object',
+      type: 'string',
       description: 'Unrealized P&L % (Decimal string)',
       nullable: true,
       example: '25'
@@ -8587,7 +8645,7 @@ export const $HoldingPnlRowDto = {
       ]
     },
     pctOfInvestedAssets: {
-      type: 'object',
+      type: 'string',
       description:
         'Share of invested assets % (Decimal string); only for invested chartTokens',
       nullable: true,
@@ -8632,15 +8690,15 @@ export const $HoldingPnlWarningDto = {
       ]
     },
     symbol: {
-      type: 'object',
+      type: 'string',
       nullable: true
     },
     accountId: {
-      type: 'object',
+      type: 'string',
       nullable: true
     },
     currency: {
-      type: 'object',
+      type: 'string',
       nullable: true
     }
   },
@@ -8922,35 +8980,35 @@ export const $SymbolSearchResultDto = {
       example: 'AAPL'
     },
     name: {
-      type: 'object',
+      type: 'string',
       example: 'Apple Inc.',
       nullable: true
     },
     exchange: {
-      type: 'object',
+      type: 'string',
       example: 'US',
       nullable: true
     },
     assetType: {
-      type: 'object',
+      type: 'string',
       description: 'OpenBB asset_type (e.g. stock, etf)',
       example: 'stock',
       nullable: true
     },
     assetClass: {
-      type: 'object',
+      type: 'string',
       description: 'IGN asset class (region.types.ts ASSET_CLASSES)',
       example: 'EQUITY',
       nullable: true
     },
     assetSubClass: {
-      type: 'object',
+      type: 'string',
       description: 'IGN asset sub-class (region.types.ts ASSET_SUB_CLASSES)',
       example: 'STOCK',
       nullable: true
     },
     currency: {
-      type: 'object',
+      type: 'string',
       description: 'Trading currency (extra_data or inferred from exchange)',
       example: 'USD',
       nullable: true
@@ -8967,90 +9025,90 @@ export const $SymbolQuoteDto = {
       example: 'AAPL'
     },
     name: {
-      type: 'object',
+      type: 'string',
       example: 'Apple Inc.',
       nullable: true
     },
     exchange: {
-      type: 'object',
+      type: 'string',
       example: 'US',
       nullable: true
     },
     assetType: {
-      type: 'object',
+      type: 'string',
       description: 'OpenBB asset_type',
       example: 'stock',
       nullable: true
     },
     assetClass: {
-      type: 'object',
+      type: 'string',
       description: 'IGN asset class',
       example: 'EQUITY',
       nullable: true
     },
     assetSubClass: {
-      type: 'object',
+      type: 'string',
       description: 'IGN asset sub-class',
       example: 'STOCK',
       nullable: true
     },
     currency: {
-      type: 'object',
+      type: 'string',
       description: 'Trading currency (extra_data or inferred from exchange)',
       example: 'USD',
       nullable: true
     },
     price: {
-      type: 'object',
+      type: 'string',
       description: 'Latest price (Decimal string)',
       example: '189.84',
       nullable: true
     },
     priceDate: {
-      type: 'object',
+      type: 'string',
       description: 'Date the price was observed (ISO yyyy-MM-dd)',
       example: '2026-08-05',
       nullable: true
     },
     changePercent: {
-      type: 'object',
+      type: 'number',
       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',
+      type: 'string',
       description: 'Previous close (Decimal string)',
       nullable: true
     },
     open: {
-      type: 'object',
+      type: 'string',
       description: 'Day open (Decimal string)',
       nullable: true
     },
     high: {
-      type: 'object',
+      type: 'string',
       description: 'Day high (Decimal string)',
       nullable: true
     },
     low: {
-      type: 'object',
+      type: 'string',
       description: 'Day low (Decimal string)',
       nullable: true
     },
     volume: {
-      type: 'object',
+      type: 'string',
       description: 'Day volume (Decimal string)',
       nullable: true
     },
     yearHigh: {
-      type: 'object',
+      type: 'string',
       description: '52-week high (Decimal string)',
       nullable: true
     },
     yearLow: {
-      type: 'object',
+      type: 'string',
       description: '52-week low (Decimal string)',
       nullable: true
     }