@firela/api-types 0.0.0-canary.6feee68d → 0.0.0-canary.78c2840b

package/src/generated/types.gen.ts

@@ -393,7 +393,7 @@ export type PostingResponseDto = {
    */
   account: string;
   /**
-   * Amount (may be null if interpolated)
+   * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
    */
   units?: string;
   /**
@@ -561,6 +561,55 @@ export type BatchTransactionResponseDto = {
   failed: Array<BatchTransactionErrorDto>;
 };
 
+export type CorrectTransactionDto = {
+  /**
+   * Transaction date (ISO 8601 format)
+   */
+  date: string;
+  /**
+   * Transaction flag: * (cleared), ! (pending)
+   */
+  flag?: '*' | '!';
+  /**
+   * Payee name
+   */
+  payee?: string;
+  /**
+   * Transaction narration/description
+   */
+  narration: string;
+  /**
+   * Transaction tags (without # prefix)
+   */
+  tags?: Array<string>;
+  /**
+   * Transaction links (without ^ prefix)
+   */
+  links?: Array<string>;
+  /**
+   * Transaction postings (minimum 1, typically 2 for double-entry)
+   */
+  postings: Array<CreatePostingDto>;
+  /**
+   * Transaction-level metadata
+   */
+  meta?: {
+    [key: string]: unknown;
+  };
+  /**
+   * Unique key for idempotent transaction creation. If provided, duplicate requests with the same key will return the existing transaction.
+   */
+  idempotencyKey?: string;
+  /**
+   * Auto-create accounts if not found. When true, missing accounts will be automatically created. When false (default for API), missing accounts will cause a validation error. Set to true for quick entry scenarios where you want to create accounts on-the-fly.
+   */
+  autoCreateAccounts?: boolean;
+  /**
+   * Reason for correcting/superseding the original transaction
+   */
+  correctionReason?: string;
+};
+
 export type PostingDetailDto = {
   /**
    * Posting ID
@@ -575,7 +624,7 @@ export type PostingDetailDto = {
    */
   accountName: string;
   /**
-   * Amount (may be null if interpolated)
+   * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
    */
   units?: string;
   /**
@@ -664,9 +713,9 @@ export type TransactionDetailDto = {
    */
   status: 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
   /**
-   * Source type (how the transaction was created)
+   * Source type (free-form string from transaction metadata, e.g. import, api)
    */
-  sourceType?: 'NLP' | 'CSV' | 'OCR' | 'API';
+  sourceType?: string;
   /**
    * Source platform (e.g., alipay, wechat)
    */
@@ -691,6 +740,14 @@ export type TransactionDetailDto = {
    * Correction reason (if voided or superseded)
    */
   correctionReason?: string;
+  /**
+   * ID of the transaction that supersedes this one (set when status=SUPERSEDED)
+   */
+  supersededBy?: string;
+  /**
+   * ID of the transaction this one corrected/replaced (back-link on the replacement)
+   */
+  originalTxn?: string;
 };
 
 /**
@@ -709,11 +766,6 @@ export type flag2 =
  */
 export type status2 = 'ACTIVE' | 'VOIDED' | 'SUPERSEDED';
 
-/**
- * Source type (how the transaction was created)
- */
-export type sourceType = 'NLP' | 'CSV' | 'OCR' | 'API';
-
 export type TransactionListResponseDto = {
   /**
    * List of transactions
@@ -733,6 +785,24 @@ export type TransactionListResponseDto = {
   offset: number;
 };
 
+export type TagSuggestionDto = {
+  /**
+   * Tag name
+   */
+  tag: string;
+  /**
+   * Usage count across ACTIVE transactions
+   */
+  count: number;
+};
+
+export type TagSuggestionsResponseDto = {
+  /**
+   * Tag suggestions sorted as requested
+   */
+  data: Array<TagSuggestionDto>;
+};
+
 export type UpdateTransactionDto = {
   /**
    * Transaction flag (CLEARED, PENDING, etc.)
@@ -834,9 +904,9 @@ export type TransactionSummaryDto = {
    */
   accountName?: string;
   /**
-   * Source type (NLP, CSV, OCR, API)
+   * Source type (free-form string from transaction metadata, e.g. import, api)
    */
-  sourceType?: 'NLP' | 'CSV' | 'OCR' | 'API';
+  sourceType?: string;
   /**
    * Source platform (e.g., alipay, wechat)
    */
@@ -866,9 +936,9 @@ export type ReviewSummaryDto = {
    */
   confidence: number;
   /**
-   * Confidence level derived from score
+   * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
    */
-  confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+  confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW' | null;
   /**
    * i18n message key for summary (e.g., review.summary.duplicate). Translate on frontend with summaryParams.
    */
@@ -884,7 +954,7 @@ export type ReviewSummaryDto = {
    */
   matchReasons: Array<string>;
   /**
-   * Source type (NLP, CSV, OCR, API)
+   * Source type (free-form string from transaction metadata, e.g. import, api)
    */
   sourceType: string;
   /**
@@ -937,7 +1007,7 @@ export type type2 =
 export type status3 = 'PENDING' | 'RESOLVED' | 'EXPIRED' | 'CANCELLED';
 
 /**
- * Confidence level derived from score
+ * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
  */
 export type confidenceLevel = 'HIGH' | 'MEDIUM' | 'LOW';
 
@@ -982,7 +1052,18 @@ export type DecisionOptionDto = {
   /**
    * The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)
    */
-  value: string;
+  value:
+    | 'UPGRADE_REPLACE'
+    | 'LINK_KEEP_BOTH'
+    | 'IGNORE_NEW'
+    | 'CONFIRM_DIFFERENT'
+    | 'ACCEPT'
+    | 'REJECT'
+    | 'ACCEPT_AND_LEARN'
+    | 'CHOOSE_OTHER'
+    | 'CANCEL'
+    | 'FIX'
+    | 'IGNORE';
   /**
    * i18n message key for display label (e.g., review.payee.accept.label)
    */
@@ -997,6 +1078,22 @@ export type DecisionOptionDto = {
   recommended?: boolean;
 };
 
+/**
+ * The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)
+ */
+export type value =
+  | 'UPGRADE_REPLACE'
+  | 'LINK_KEEP_BOTH'
+  | 'IGNORE_NEW'
+  | 'CONFIRM_DIFFERENT'
+  | 'ACCEPT'
+  | 'REJECT'
+  | 'ACCEPT_AND_LEARN'
+  | 'CHOOSE_OTHER'
+  | 'CANCEL'
+  | 'FIX'
+  | 'IGNORE';
+
 export type ReviewDetailDto = {
   /**
    * Review item ID
@@ -1020,9 +1117,9 @@ export type ReviewDetailDto = {
    */
   confidence: number;
   /**
-   * Confidence level derived from score
+   * Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.
    */
-  confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW';
+  confidenceLevel: 'HIGH' | 'MEDIUM' | 'LOW' | null;
   /**
    * i18n message key for summary (e.g., review.summary.duplicate). Translate on frontend with summaryParams.
    */
@@ -1038,7 +1135,7 @@ export type ReviewDetailDto = {
    */
   matchReasons: Array<string>;
   /**
-   * Source type (NLP, CSV, OCR, API)
+   * Source type (free-form string from transaction metadata, e.g. import, api)
    */
   sourceType: string;
   /**
@@ -1091,9 +1188,20 @@ export type ReviewDetailDto = {
 
 export type ResolveReviewDto = {
   /**
-   * Decision action. Available actions vary by review type: DUPLICATE: UPGRADE_REPLACE, KEEP_EXISTING, KEEP_BOTH | PAYEE_MATCH: ACCEPT, REJECT, ACCEPT_AND_LEARN | ACCOUNT_VALIDATION: FIX, REJECT | RULE_MATCH: ACCEPT, REJECT, ACCEPT_AND_LEARN
+   * Decision action. Valid actions vary by review type — see DecisionOptionDto.value returned by the review detail endpoint.
    */
-  action: string;
+  action:
+    | 'UPGRADE_REPLACE'
+    | 'LINK_KEEP_BOTH'
+    | 'IGNORE_NEW'
+    | 'CONFIRM_DIFFERENT'
+    | 'ACCEPT'
+    | 'REJECT'
+    | 'ACCEPT_AND_LEARN'
+    | 'CHOOSE_OTHER'
+    | 'CANCEL'
+    | 'FIX'
+    | 'IGNORE';
   /**
    * Additional data for the decision (e.g., selected account ID)
    */
@@ -1102,6 +1210,22 @@ export type ResolveReviewDto = {
   };
 };
 
+/**
+ * Decision action. Valid actions vary by review type — see DecisionOptionDto.value returned by the review detail endpoint.
+ */
+export type action =
+  | 'UPGRADE_REPLACE'
+  | 'LINK_KEEP_BOTH'
+  | 'IGNORE_NEW'
+  | 'CONFIRM_DIFFERENT'
+  | 'ACCEPT'
+  | 'REJECT'
+  | 'ACCEPT_AND_LEARN'
+  | 'CHOOSE_OTHER'
+  | 'CANCEL'
+  | 'FIX'
+  | 'IGNORE';
+
 export type ResolveResultDto = {
   /**
    * Whether resolution was successful
@@ -1158,7 +1282,18 @@ export type BatchResolveDto = {
   /**
    * Decision action to apply to all items
    */
-  action: string;
+  action:
+    | 'UPGRADE_REPLACE'
+    | 'LINK_KEEP_BOTH'
+    | 'IGNORE_NEW'
+    | 'CONFIRM_DIFFERENT'
+    | 'ACCEPT'
+    | 'REJECT'
+    | 'ACCEPT_AND_LEARN'
+    | 'CHOOSE_OTHER'
+    | 'CANCEL'
+    | 'FIX'
+    | 'IGNORE';
   /**
    * Additional data for the decision
    */
@@ -3821,7 +3956,7 @@ export type status4 = 'success' | 'pending' | 'error';
 /**
  * Action taken or requested
  */
-export type action =
+export type action2 =
   | 'created'
   | 'ask'
   | 'confirm'
@@ -4563,6 +4698,42 @@ export type TransactionControllerCreateBatchData = {
 export type TransactionControllerCreateBatchResponse =
   BatchTransactionResponseDto;
 
+export type TransactionControllerCorrectData = {
+  /**
+   * Original transaction ID to correct
+   */
+  id: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  requestBody: CorrectTransactionDto;
+};
+
+export type TransactionControllerCorrectResponse = TransactionDetailDto;
+
+export type TransactionControllerSuggestTagsData = {
+  /**
+   * Max suggestions (1-100, default 10)
+   */
+  limit?: number;
+  /**
+   * Prefix match, case-insensitive (max 50 chars)
+   */
+  q?: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  /**
+   * usage (default) or name
+   */
+  sort?: 'usage' | 'name';
+};
+
+export type TransactionControllerSuggestTagsResponse =
+  TagSuggestionsResponseDto;
+
 export type TransactionControllerGetDetailData = {
   /**
    * Transaction ID
@@ -6041,6 +6212,48 @@ export type $OpenApiTs = {
       };
     };
   };
+  '/api/v1/{region}/bean/transactions/{id}/correct': {
+    post: {
+      req: TransactionControllerCorrectData;
+      res: {
+        /**
+         * Corrected transaction created
+         */
+        201: TransactionDetailDto;
+        /**
+         * Original transaction not found
+         */
+        404: ApiProblemResponseDto;
+        /**
+         * Original no longer ACTIVE (concurrent modification)
+         */
+        409: ApiProblemResponseDto;
+        /**
+         * Pipeline validation failed (does not balance, invalid accounts)
+         */
+        422: ApiProblemResponseDto;
+      };
+    };
+  };
+  '/api/v1/{region}/bean/transactions/tags': {
+    get: {
+      req: TransactionControllerSuggestTagsData;
+      res: {
+        /**
+         * Tag suggestions
+         */
+        200: TagSuggestionsResponseDto;
+        /**
+         * Validation failed
+         */
+        400: ApiProblemResponseDto;
+        /**
+         * Authentication required
+         */
+        401: ApiProblemResponseDto;
+      };
+    };
+  };
   '/api/v1/{region}/bean/transactions/{id}': {
     get: {
       req: TransactionControllerGetDetailData;