@firela/api-types 0.0.0-canary.ebb51de2 → 0.0.0-canary.efbd2b9a

package/src/generated/types.gen.ts

@@ -1324,17 +1324,17 @@ export type ResolveResultDto = {
     [key: string]: string;
   };
   /**
-   * Resolution ID for undo
+   * Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).
    */
-  resolutionId: string;
+  resolutionId?: string;
   /**
    * Whether this decision can be undone
    */
-  canUndo: boolean;
+  canUndo?: boolean;
   /**
    * Deadline for undo (24h from resolution)
    */
-  undoDeadline: string;
+  undoDeadline?: string;
   /**
    * Rule ID if learning was triggered (ACCEPT_AND_LEARN actions). Use this to deep-link to the rule management page.
    */
@@ -3457,6 +3457,33 @@ export type ProviderSyncDto = {
   transactions: unknown[];
 };
 
+export type ProviderSyncResponseDto = {
+  /**
+   * Number of transactions successfully imported
+   */
+  imported: number;
+  /**
+   * Number of transactions skipped (duplicates)
+   */
+  skipped: number;
+  /**
+   * Number of transactions pending review
+   */
+  pendingReview: number;
+  /**
+   * Number of transactions that failed to import
+   */
+  failed: number;
+  /**
+   * IDs of successfully imported transactions
+   */
+  importedTransactionIds?: Array<string>;
+  /**
+   * IDs of review items created for branched transactions
+   */
+  reviewItemIds?: Array<string>;
+};
+
 export type SupportedProvidersResponseDto = {
   /**
    * List of supported provider names
@@ -3485,6 +3512,564 @@ export type ProcessNlpDto = {
   };
 };
 
+export type NlpTransactionInfoDto = {
+  /**
+   * Transaction ID
+   */
+  id: string;
+  /**
+   * Transaction date (ISO format)
+   */
+  date: string;
+  /**
+   * Transaction amount
+   */
+  amount: number;
+  /**
+   * Currency code
+   */
+  currency: string;
+  /**
+   * Payee name
+   */
+  payee?: string;
+  /**
+   * Transaction narration
+   */
+  narration?: string;
+  /**
+   * Warning message for special transaction scenarios (e.g., cross-currency settlement)
+   */
+  warning?: string;
+};
+
+export type NlpParsedDataDto = {
+  /**
+   * Extracted amount
+   */
+  amount?: number;
+  /**
+   * Currency code
+   */
+  currency?: string;
+  /**
+   * Transaction date (ISO format)
+   */
+  date?: string;
+  /**
+   * Payee name
+   */
+  payee?: string;
+  /**
+   * Transaction narration
+   */
+  narration?: string;
+  /**
+   * Category
+   */
+  category?: string;
+  /**
+   * Income type (e.g., Salary, Bonus, Dividend, Interest)
+   */
+  incomeType?: string;
+  /**
+   * Income source (e.g., company name)
+   */
+  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;
+  /**
+   * Warning message for special scenarios (e.g., cross-currency settlement)
+   */
+  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)
+   */
+  date: string;
+  /**
+   * Amount as string
+   */
+  amount: string;
+  /**
+   * Currency code
+   */
+  currency: string;
+  /**
+   * Payee name
+   */
+  payee?: string;
+  /**
+   * Transaction narration
+   */
+  narration: string;
+};
+
+export type NlpTargetTransactionDto = {
+  /**
+   * Existing transaction ID
+   */
+  id: string;
+  /**
+   * Transaction date (ISO format)
+   */
+  date: string;
+  /**
+   * Amount as string
+   */
+  amount: string;
+  /**
+   * Currency code
+   */
+  currency: string;
+  /**
+   * Payee name
+   */
+  payee?: string;
+  /**
+   * Transaction narration
+   */
+  narration: string;
+};
+
+export type NlpSimilarityDto = {
+  /**
+   * Whether dates match
+   */
+  dateMatch: boolean;
+  /**
+   * Date difference in days
+   */
+  dateDiff: number;
+  /**
+   * Whether amounts match
+   */
+  amountMatch: boolean;
+  /**
+   * Amount difference as decimal string
+   */
+  amountDiff: string;
+  /**
+   * Whether payees match
+   */
+  payeeMatch: boolean;
+  /**
+   * Payee similarity score (0-1)
+   */
+  payeeSimilarity: number;
+  /**
+   * Account overlap score (0-1)
+   */
+  accountOverlap: number;
+};
+
+export type NlpDuplicateConfirmationDataDto = {
+  /**
+   * Duplicate detection confidence score (0.5-0.89)
+   */
+  confidence: number;
+  /**
+   * Source transaction summary (the new transaction being entered)
+   */
+  sourceTransaction: NlpSourceTransactionDto;
+  /**
+   * Target transaction summary (existing potential duplicate)
+   */
+  targetTransaction: NlpTargetTransactionDto;
+  /**
+   * Detailed similarity information
+   */
+  similarity: NlpSimilarityDto;
+  /**
+   * Human-readable reasons for duplicate detection
+   */
+  reasons: Array<string>;
+};
+
+export type NlpRuleConfirmationDataDto = {
+  /**
+   * Rule match confidence score (0.5-0.74)
+   */
+  confidence: number;
+  /**
+   * Matched rule information
+   */
+  matchedRule: {
+    [key: string]: unknown;
+  };
+  /**
+   * Suggested accounts from the rule
+   */
+  suggestedAccounts: {
+    [key: string]: unknown;
+  };
+  /**
+   * Alternative rules that also match
+   */
+  alternatives: unknown[];
+  /**
+   * Human-readable reasons for the match
+   */
+  reasons: Array<string>;
+};
+
+export type NlpAccountConfirmationDataDto = {
+  /**
+   * The invalid account name
+   */
+  invalidAccount: string;
+  /**
+   * Suggested replacement account
+   */
+  suggestedAccount: string;
+  /**
+   * Similar accounts for user selection
+   */
+  similarAccounts: Array<string>;
+  /**
+   * Error message explaining the issue
+   */
+  errorMessage: string;
+  /**
+   * Transaction context for reference
+   */
+  transactionContext: {
+    [key: string]: unknown;
+  };
+};
+
+export type NlpSuggestedPayeeDto = {
+  /**
+   * Payee ID
+   */
+  id: string;
+  /**
+   * Payee name
+   */
+  name: string;
+  /**
+   * Payee category
+   */
+  category?: string;
+  /**
+   * Source of the payee
+   */
+  source?: 'user' | 'global';
+  /**
+   * PayeeProfile ID (if matched from global)
+   */
+  payeeProfileId?: string;
+};
+
+/**
+ * Source of the payee
+ */
+export type source = 'user' | 'global';
+
+export type NlpAlternativePayeeDto = {
+  /**
+   * Payee ID
+   */
+  id: string;
+  /**
+   * Payee name
+   */
+  name: string;
+  /**
+   * Similarity score (0-1)
+   */
+  similarity: number;
+};
+
+export type NlpPayeeConfirmationDataDto = {
+  /**
+   * Confidence score for the payee match (0-1)
+   */
+  confidence: number;
+  /**
+   * Original payee string from user input
+   */
+  originalPayee: string;
+  /**
+   * Suggested payee to use (null when no similar payees found)
+   */
+  suggestedPayee?: NlpSuggestedPayeeDto | null;
+  /**
+   * Similarity score between original and suggested (0-1)
+   */
+  similarity: number;
+  /**
+   * Alternative payee options
+   */
+  alternatives: Array<NlpAlternativePayeeDto>;
+  /**
+   * Human-readable reasons for the match
+   */
+  reasons: Array<string>;
+};
+
+export type RecurringMatchInfoDto = {
+  /**
+   * Expected transaction ID
+   */
+  expectedId: string;
+  /**
+   * Recurring rule ID
+   */
+  ruleId: string;
+  /**
+   * Rule name for display
+   */
+  ruleName: string;
+  /**
+   * Rule icon
+   */
+  ruleIcon?: string;
+  /**
+   * Expected date (YYYY-MM-DD)
+   */
+  expectedDate: string;
+  /**
+   * Expected amount
+   */
+  expectedAmount: number;
+  /**
+   * Match confidence score (0-1)
+   */
+  confidence: number;
+  /**
+   * Whether auto-matched (confidence >= 0.82)
+   */
+  isAutoMatched: boolean;
+};
+
+export type NlpSuggestedAccountDto = {
+  /**
+   * Suggested account path
+   */
+  account: string;
+  /**
+   * Confidence score for this suggestion (0-1)
+   */
+  confidence?: number;
+};
+
+export type NlpSuggestedAccountsDto = {
+  /**
+   * Source account suggestion (where money comes from). For expense: asset/liability account. For income: income account.
+   */
+  source?: NlpSuggestedAccountDto;
+  /**
+   * Destination account suggestion (where money goes to). For expense: expense account. For income: asset/liability account.
+   */
+  destination?: NlpSuggestedAccountDto;
+};
+
+export type NlpDefaultAccountsDto = {
+  /**
+   * Default asset account
+   */
+  asset: string;
+  /**
+   * Default expense account
+   */
+  expense: string;
+  /**
+   * Default income account
+   */
+  income: string;
+  /**
+   * Default liability account
+   */
+  liability: string;
+};
+
+export type NlpResponseDto = {
+  /**
+   * Response status
+   */
+  status: 'success' | 'pending' | 'error';
+  /**
+   * Action taken or requested
+   */
+  action:
+    | 'created'
+    | 'ask'
+    | 'confirm'
+    | 'confirm_duplicate'
+    | 'confirm_rule'
+    | 'confirm_account'
+    | 'confirm_payee'
+    | 'cancel';
+  /**
+   * Transaction intent detected by EntityRouter (v6.0: 5 core intents). Frontend uses this to render scenario-specific form fields.
+   */
+  intent?: 'expense' | 'asset' | 'income' | 'liability' | 'equity';
+  /**
+   * Asset sub-type (only present when intent is "asset"). Determines which asset-related form to render.
+   */
+  assetSubType?: 'transfer' | 'banking' | 'investment';
+  /**
+   * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
+   */
+  liabilitySubType?: 'borrow' | 'repay';
+  /**
+   * Equity sub-type (only present when intent is "equity"). opening: account opening balance (Equity → Assets), adjustment: balance correction.
+   */
+  equitySubType?: 'opening' | 'adjustment';
+  /**
+   * Payment source for expense transactions (v6.1). Indicates whether payment comes from asset or liability account. Only present when intent is "expense".
+   */
+  paymentSource?: 'asset' | 'liability';
+  /**
+   * Liability account type hint for credit card/BNPL spending (v6.1). Only present when paymentSource is "liability". Values: CreditCard, Huabei, Baitiao
+   */
+  liabilityHint?: string;
+  /**
+   * Human-readable message (for ask or error actions). Deprecated: Use messageKey for i18n support.
+   * @deprecated
+   */
+  message?: string;
+  /**
+   * i18n message key for frontend translation. Use this instead of message for internationalization support.
+   */
+  messageKey?: string;
+  /**
+   * Parameters for message interpolation. Used with messageKey for dynamic values in translated messages.
+   */
+  messageParams?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Session ID for multi-turn dialogue. Must be included in subsequent requests to continue the conversation.
+   */
+  sessionId?: string;
+  /**
+   * Which slot is waiting for user input
+   */
+  waitingFor?: string;
+  /**
+   * Created transaction info (for created action)
+   */
+  transaction?: NlpTransactionInfoDto;
+  /**
+   * Parsed data for confirmation (when action is "confirm"). Contains extracted fields that user should verify before transaction creation.
+   */
+  parsedData?: NlpParsedDataDto;
+  /**
+   * Duplicate detection data (when action is "confirm_duplicate"). Contains information about potential duplicate transaction for user confirmation.
+   */
+  duplicateData?: NlpDuplicateConfirmationDataDto;
+  /**
+   * Rule match data (when action is "confirm_rule"). Contains information about medium-confidence rule match for user confirmation.
+   */
+  ruleData?: NlpRuleConfirmationDataDto;
+  /**
+   * Account validation data (when action is "confirm_account"). Contains information about invalid account for user correction.
+   */
+  accountData?: NlpAccountConfirmationDataDto;
+  /**
+   * Payee confirmation data (when action is "confirm_payee"). Contains information about medium/low confidence payee match for user confirmation.
+   */
+  payeeData?: NlpPayeeConfirmationDataDto;
+  /**
+   * Overall confidence score (0-1)
+   */
+  confidence?: number;
+  /**
+   * Confidence threshold for automatic creation (default: 0.75). When confidence < threshold, action will be "confirm" requiring user verification.
+   */
+  confidenceThreshold?: number;
+  /**
+   * Recurring transaction match info (when action is "created"). Contains match details when transaction matches a pending expected transaction.
+   */
+  recurringMatch?: RecurringMatchInfoDto;
+  /**
+   * Recurring rule creation suggestion (when action is "created"). Contains suggestion to create a recurring rule based on detected patterns. Only present when no existing rule matched and similar historical transactions were found.
+   */
+  recurringSuggestion?: RecurringSuggestionDto;
+  /**
+   * Suggested accounts for this transaction. Contains recommended source and destination accounts based on the detected intent and rules.
+   */
+  suggestedAccounts?: NlpSuggestedAccountsDto;
+  /**
+   * Default accounts for the user/region. These are fallback accounts used when no specific suggestion is available.
+   */
+  defaultAccounts?: NlpDefaultAccountsDto;
+};
+
+/**
+ * Response status
+ */
+export type status4 = 'success' | 'pending' | 'error';
+
+/**
+ * Action taken or requested
+ */
+export type action2 =
+  | 'created'
+  | 'ask'
+  | 'confirm'
+  | 'confirm_duplicate'
+  | 'confirm_rule'
+  | 'confirm_account'
+  | 'confirm_payee'
+  | 'cancel';
+
+/**
+ * Transaction intent detected by EntityRouter (v6.0: 5 core intents). Frontend uses this to render scenario-specific form fields.
+ */
+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';
+
+/**
+ * Liability sub-type (only present when intent is "liability"). borrow: borrowing money (Liabilities → Assets), repay: repaying debt (Assets → Liabilities).
+ */
+export type liabilitySubType = 'borrow' | 'repay';
+
+/**
+ * Equity sub-type (only present when intent is "equity"). opening: account opening balance (Equity → Assets), adjustment: balance correction.
+ */
+export type equitySubType = 'opening' | 'adjustment';
+
 export type BalanceByCurrencyDto = {
   /**
    * ISO 4217 currency code
@@ -3704,7 +4289,7 @@ export type AccountItemWithAssetClassDto = {
 /**
  * ADR-0105 classification provenance (holding level always; account level only on FALLBACK)
  */
-export type source =
+export type source2 =
   | 'USER_META'
   | 'FIAT_CURRENCY'
   | 'OPENBB_MAPPING'
@@ -3983,7 +4568,7 @@ export type CurrentPriceDto = {
 /**
  * Price source
  */
-export type source2 = 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
+export type source3 = 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
 
 export type FxRateDto = {
   from: string;
@@ -4357,7 +4942,7 @@ export type AccountControllerCreateData = {
   requestBody: CreateAccountDto;
 };
 
-export type AccountControllerCreateResponse = unknown;
+export type AccountControllerCreateResponse = AccountResponseDto;
 
 export type AccountControllerFindAllData = {
   /**
@@ -4406,6 +4991,9 @@ export type AccountControllerFindOneData = {
 export type AccountControllerFindOneResponse = AccountResponseDto;
 
 export type AccountControllerUpdateData = {
+  /**
+   * Account UUID
+   */
   id: string;
   /**
    * Region code for tenant context
@@ -4414,9 +5002,12 @@ export type AccountControllerUpdateData = {
   requestBody: UpdateAccountDto;
 };
 
-export type AccountControllerUpdateResponse = unknown;
+export type AccountControllerUpdateResponse = AccountResponseDto;
 
 export type AccountControllerDeleteData = {
+  /**
+   * Account UUID
+   */
   id: string;
   /**
    * Region code for tenant context
@@ -4424,9 +5015,12 @@ export type AccountControllerDeleteData = {
   region: 'cn' | 'us' | 'de' | 'gb';
 };
 
-export type AccountControllerDeleteResponse = unknown;
+export type AccountControllerDeleteResponse = void;
 
 export type AccountControllerCloseData = {
+  /**
+   * Account UUID
+   */
   id: string;
   /**
    * Region code for tenant context
@@ -4435,9 +5029,12 @@ export type AccountControllerCloseData = {
   requestBody: CloseAccountDto;
 };
 
-export type AccountControllerCloseResponse = unknown;
+export type AccountControllerCloseResponse = AccountResponseDto;
 
 export type AccountControllerReopenData = {
+  /**
+   * Account UUID
+   */
   id: string;
   /**
    * Region code for tenant context
@@ -4446,7 +5043,7 @@ export type AccountControllerReopenData = {
   requestBody: ReopenAccountDto;
 };
 
-export type AccountControllerReopenResponse = unknown;
+export type AccountControllerReopenResponse = AccountResponseDto;
 
 export type AccountStandardsControllerGetTemplatesData = {
   /**
@@ -5528,13 +6125,25 @@ export type FileImportControllerIdentifyFileData = {
 export type FileImportControllerIdentifyFileResponse = IdentifyResultDto;
 
 export type FileImportControllerImportBeancountData = {
+  /**
+   * Beancount file to import
+   */
+  formData: FileImportDto;
   /**
    * Region code for tenant context
    */
   region: 'cn' | 'us' | 'de' | 'gb';
 };
 
-export type FileImportControllerImportBeancountResponse = unknown;
+export type FileImportControllerImportBeancountResponse = {
+  imported?: number;
+  skipped?: number;
+  failed?: number;
+  accountsCreated?: number;
+  errors?: Array<{
+    [key: string]: unknown;
+  }>;
+};
 
 export type ImporterConfigControllerGetConfigData = {
   /**
@@ -5622,7 +6231,18 @@ export type PlatformControllerDeleteData = {
 export type PlatformControllerDeleteResponse = void;
 
 export type ProviderSyncControllerSyncData = {
-  providerName: string;
+  /**
+   * Provider name
+   */
+  providerName:
+    | 'plaid'
+    | 'teller'
+    | 'truelayer'
+    | 'gocardless'
+    | 'simplefin'
+    | 'yodlee'
+    | 'beancount-direct'
+    | 'parsed-bill';
   /**
    * Region code for tenant context
    */
@@ -5630,7 +6250,7 @@ export type ProviderSyncControllerSyncData = {
   requestBody: ProviderSyncDto;
 };
 
-export type ProviderSyncControllerSyncResponse = unknown;
+export type ProviderSyncControllerSyncResponse = ProviderSyncResponseDto;
 
 export type ProviderSyncControllerGetSupportedProvidersData = {
   /**
@@ -5693,10 +6313,13 @@ export type NlpControllerProcessNaturalLanguageData = {
    * Region code for tenant context
    */
   region: 'cn' | 'us' | 'de' | 'gb';
+  /**
+   * Natural language transaction input with optional session ID
+   */
   requestBody: ProcessNlpDto;
 };
 
-export type NlpControllerProcessNaturalLanguageResponse = unknown;
+export type NlpControllerProcessNaturalLanguageResponse = NlpResponseDto;
 
 export type NlpControllerClearSessionData = {
   /**
@@ -5990,7 +6613,14 @@ export type $OpenApiTs = {
     post: {
       req: AccountControllerCreateData;
       res: {
-        201: unknown;
+        /**
+         * Account created successfully
+         */
+        201: AccountResponseDto;
+        /**
+         * Account already exists
+         */
+        409: unknown;
       };
     };
     get: {
@@ -6020,13 +6650,31 @@ export type $OpenApiTs = {
     put: {
       req: AccountControllerUpdateData;
       res: {
-        200: unknown;
+        /**
+         * Account updated successfully
+         */
+        200: AccountResponseDto;
+        /**
+         * Account not found
+         */
+        404: unknown;
       };
     };
     delete: {
       req: AccountControllerDeleteData;
       res: {
-        200: unknown;
+        /**
+         * Account deleted successfully
+         */
+        204: void;
+        /**
+         * Account not found
+         */
+        404: unknown;
+        /**
+         * Account has transactions and cannot be deleted
+         */
+        409: unknown;
       };
     };
   };
@@ -6034,7 +6682,18 @@ export type $OpenApiTs = {
     post: {
       req: AccountControllerCloseData;
       res: {
-        201: unknown;
+        /**
+         * Account closed successfully
+         */
+        200: AccountResponseDto;
+        /**
+         * Account is already closed
+         */
+        400: unknown;
+        /**
+         * Account not found
+         */
+        404: unknown;
       };
     };
   };
@@ -6042,7 +6701,18 @@ export type $OpenApiTs = {
     post: {
       req: AccountControllerReopenData;
       res: {
-        201: unknown;
+        /**
+         * Account reopened successfully
+         */
+        200: AccountResponseDto;
+        /**
+         * Account is not closed
+         */
+        400: unknown;
+        /**
+         * Account not found
+         */
+        404: unknown;
       };
     };
   };
@@ -7378,7 +8048,22 @@ export type $OpenApiTs = {
     post: {
       req: FileImportControllerImportBeancountData;
       res: {
-        201: unknown;
+        /**
+         * Beancount file imported successfully
+         */
+        200: {
+          imported?: number;
+          skipped?: number;
+          failed?: number;
+          accountsCreated?: number;
+          errors?: Array<{
+            [key: string]: unknown;
+          }>;
+        };
+        /**
+         * Bad request - invalid file or no file uploaded
+         */
+        400: ApiProblemResponseDto;
       };
     };
   };
@@ -7509,7 +8194,22 @@ export type $OpenApiTs = {
     post: {
       req: ProviderSyncControllerSyncData;
       res: {
-        201: unknown;
+        /**
+         * Sync completed successfully
+         */
+        200: ProviderSyncResponseDto;
+        /**
+         * Invalid request data
+         */
+        400: unknown;
+        /**
+         * Missing or invalid authentication
+         */
+        401: unknown;
+        /**
+         * Provider not supported
+         */
+        404: unknown;
       };
     };
   };
@@ -7588,7 +8288,18 @@ export type $OpenApiTs = {
     post: {
       req: NlpControllerProcessNaturalLanguageData;
       res: {
-        201: unknown;
+        /**
+         * NLP processing result - either created transaction or asking for more info
+         */
+        200: NlpResponseDto;
+        /**
+         * Invalid input
+         */
+        400: unknown;
+        /**
+         * Unauthorized
+         */
+        401: unknown;
       };
     };
   };