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

package/src/generated/schemas.gen.ts

@@ -583,7 +583,8 @@ export const $PostingResponseDto = {
     },
     units: {
       type: 'string',
-      description: 'Amount (may be null if interpolated)',
+      description:
+        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
       example: '100.50'
     },
     currency: {
@@ -840,6 +841,85 @@ export const $BatchTransactionResponseDto = {
   required: ['succeeded', 'failed']
 } as const;
 
+export const $CorrectTransactionDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      description: 'Transaction date (ISO 8601 format)',
+      example: '2024-11-28'
+    },
+    flag: {
+      type: 'string',
+      description: 'Transaction flag: * (cleared), ! (pending)',
+      enum: ['*', '!'],
+      example: '*'
+    },
+    payee: {
+      type: 'string',
+      description: 'Payee name',
+      example: 'Whole Foods Market'
+    },
+    narration: {
+      type: 'string',
+      description: 'Transaction narration/description',
+      example: 'Grocery shopping'
+    },
+    tags: {
+      description: 'Transaction tags (without # prefix)',
+      example: ['vacation', 'personal'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    links: {
+      description: 'Transaction links (without ^ prefix)',
+      example: ['invoice-123'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    postings: {
+      description:
+        'Transaction postings (minimum 1, typically 2 for double-entry)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CreatePostingDto'
+      }
+    },
+    meta: {
+      type: 'object',
+      description: 'Transaction-level metadata',
+      example: {
+        invoice: '12345'
+      }
+    },
+    idempotencyKey: {
+      type: 'string',
+      description:
+        'Unique key for idempotent transaction creation. If provided, duplicate requests with the same key will return the existing transaction.',
+      example: 'import-2024-01-15-batch-001',
+      maxLength: 128
+    },
+    autoCreateAccounts: {
+      type: 'boolean',
+      description:
+        '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.',
+      default: true,
+      example: true
+    },
+    correctionReason: {
+      type: 'string',
+      description: 'Reason for correcting/superseding the original transaction',
+      example: 'Wrong amount — corrected from receipt',
+      maxLength: 500
+    }
+  },
+  required: ['date', 'narration', 'postings']
+} as const;
+
 export const $PostingDetailDto = {
   type: 'object',
   properties: {
@@ -860,7 +940,8 @@ export const $PostingDetailDto = {
     },
     units: {
       type: 'string',
-      description: 'Amount (may be null if interpolated)',
+      description:
+        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
       example: '100.50'
     },
     currency: {
@@ -975,8 +1056,8 @@ export const $TransactionDetailDto = {
     },
     sourceType: {
       type: 'string',
-      description: 'Source type (how the transaction was created)',
-      enum: ['NLP', 'CSV', 'OCR', 'API']
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
     },
     sourcePlatform: {
       type: 'string',
@@ -1009,6 +1090,18 @@ export const $TransactionDetailDto = {
       type: 'string',
       description: 'Correction reason (if voided or superseded)',
       example: 'Duplicate entry'
+    },
+    supersededBy: {
+      type: 'string',
+      description:
+        'ID of the transaction that supersedes this one (set when status=SUPERSEDED)',
+      example: 'clh1234567890abcdef'
+    },
+    originalTxn: {
+      type: 'string',
+      description:
+        'ID of the transaction this one corrected/replaced (back-link on the replacement)',
+      example: 'clh1234567890abcdef'
     }
   },
   required: [
@@ -1052,6 +1145,37 @@ export const $TransactionListResponseDto = {
   required: ['data', 'total', 'limit', 'offset']
 } as const;
 
+export const $TagSuggestionDto = {
+  type: 'object',
+  properties: {
+    tag: {
+      type: 'string',
+      description: 'Tag name',
+      example: 'Monthly'
+    },
+    count: {
+      type: 'number',
+      description: 'Usage count across ACTIVE transactions',
+      example: 12
+    }
+  },
+  required: ['tag', 'count']
+} as const;
+
+export const $TagSuggestionsResponseDto = {
+  type: 'object',
+  properties: {
+    data: {
+      description: 'Tag suggestions sorted as requested',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/TagSuggestionDto'
+      }
+    }
+  },
+  required: ['data']
+} as const;
+
 export const $UpdateTransactionDto = {
   type: 'object',
   properties: {
@@ -1202,8 +1326,8 @@ export const $TransactionSummaryDto = {
     },
     sourceType: {
       type: 'string',
-      description: 'Source type (NLP, CSV, OCR, API)',
-      enum: ['NLP', 'CSV', 'OCR', 'API']
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
     },
     sourcePlatform: {
       type: 'string',
@@ -1243,8 +1367,10 @@ export const $ReviewSummaryDto = {
     },
     confidenceLevel: {
       type: 'string',
-      description: 'Confidence level derived from score',
-      enum: ['HIGH', 'MEDIUM', 'LOW']
+      description:
+        'Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.',
+      enum: ['HIGH', 'MEDIUM', 'LOW'],
+      nullable: true
     },
     summaryKey: {
       type: 'string',
@@ -1268,7 +1394,8 @@ export const $ReviewSummaryDto = {
     },
     sourceType: {
       type: 'string',
-      description: 'Source type (NLP, CSV, OCR, API)'
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
     },
     sourcePlatform: {
       type: 'string',
@@ -1378,7 +1505,20 @@ export const $DecisionOptionDto = {
   properties: {
     value: {
       type: 'string',
-      description: 'The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)'
+      description: 'The action value to submit (e.g., UPGRADE_REPLACE, ACCEPT)',
+      enum: [
+        'UPGRADE_REPLACE',
+        'LINK_KEEP_BOTH',
+        'IGNORE_NEW',
+        'CONFIRM_DIFFERENT',
+        'ACCEPT',
+        'REJECT',
+        'ACCEPT_AND_LEARN',
+        'CHOOSE_OTHER',
+        'CANCEL',
+        'FIX',
+        'IGNORE'
+      ]
     },
     labelKey: {
       type: 'string',
@@ -1426,8 +1566,10 @@ export const $ReviewDetailDto = {
     },
     confidenceLevel: {
       type: 'string',
-      description: 'Confidence level derived from score',
-      enum: ['HIGH', 'MEDIUM', 'LOW']
+      description:
+        'Confidence level derived from score. Null for error-type reviews (ACCOUNT_VALIDATION/PIPELINE_ERROR) which carry no confidence.',
+      enum: ['HIGH', 'MEDIUM', 'LOW'],
+      nullable: true
     },
     summaryKey: {
       type: 'string',
@@ -1451,7 +1593,8 @@ export const $ReviewDetailDto = {
     },
     sourceType: {
       type: 'string',
-      description: 'Source type (NLP, CSV, OCR, API)'
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
     },
     sourcePlatform: {
       type: 'string',
@@ -1531,7 +1674,20 @@ export const $ResolveReviewDto = {
     action: {
       type: 'string',
       description:
-        '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.',
+      enum: [
+        'UPGRADE_REPLACE',
+        'LINK_KEEP_BOTH',
+        'IGNORE_NEW',
+        'CONFIRM_DIFFERENT',
+        'ACCEPT',
+        'REJECT',
+        'ACCEPT_AND_LEARN',
+        'CHOOSE_OTHER',
+        'CANCEL',
+        'FIX',
+        'IGNORE'
+      ],
       example: 'ACCEPT'
     },
     data: {
@@ -1622,6 +1778,19 @@ export const $BatchResolveDto = {
     action: {
       type: 'string',
       description: 'Decision action to apply to all items',
+      enum: [
+        'UPGRADE_REPLACE',
+        'LINK_KEEP_BOTH',
+        'IGNORE_NEW',
+        'CONFIRM_DIFFERENT',
+        'ACCEPT',
+        'REJECT',
+        'ACCEPT_AND_LEARN',
+        'CHOOSE_OTHER',
+        'CANCEL',
+        'FIX',
+        'IGNORE'
+      ],
       example: 'ACCEPT'
     },
     data: {

package/src/generated/services.gen.ts

@@ -29,6 +29,10 @@ import type {
   TransactionControllerListResponse,
   TransactionControllerCreateBatchData,
   TransactionControllerCreateBatchResponse,
+  TransactionControllerCorrectData,
+  TransactionControllerCorrectResponse,
+  TransactionControllerSuggestTagsData,
+  TransactionControllerSuggestTagsResponse,
   TransactionControllerGetDetailData,
   TransactionControllerGetDetailResponse,
   TransactionControllerUpdateData,
@@ -603,6 +607,68 @@ export class BeanTransactionsService {
     });
   }
 
+  /**
+   * Correct (supersede) a transaction
+   * Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
+   * @param data The data for the request.
+   * @param data.id Original transaction ID to correct
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns TransactionDetailDto Corrected transaction created
+   * @throws ApiError
+   */
+  public static transactionControllerCorrect(
+    data: TransactionControllerCorrectData
+  ): CancelablePromise<TransactionControllerCorrectResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/transactions/{id}/correct',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Original transaction not found',
+        409: 'Original no longer ACTIVE (concurrent modification)',
+        422: 'Pipeline validation failed (does not balance, invalid accounts)'
+      }
+    });
+  }
+
+  /**
+   * Suggest transaction tags
+   * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.q Prefix match, case-insensitive (max 50 chars)
+   * @param data.sort usage (default) or name
+   * @param data.limit Max suggestions (1-100, default 10)
+   * @returns TagSuggestionsResponseDto Tag suggestions
+   * @throws ApiError
+   */
+  public static transactionControllerSuggestTags(
+    data: TransactionControllerSuggestTagsData
+  ): CancelablePromise<TransactionControllerSuggestTagsResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/bean/transactions/tags',
+      path: {
+        region: data.region
+      },
+      query: {
+        q: data.q,
+        sort: data.sort,
+        limit: data.limit
+      },
+      errors: {
+        400: 'Validation failed',
+        401: 'Authentication required'
+      }
+    });
+  }
+
   /**
    * Get transaction detail
    * Returns transaction details including all postings