@firela/api-types 0.0.0-canary.693e8bdf → 0.0.0-canary.69a6df79

package/src/generated/schemas.gen.ts

@@ -776,7 +776,7 @@ export const $PostingResponseDto = {
     units: {
       type: 'string',
       description:
-        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
+        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.',
       example: '100.50'
     },
     currency: {
@@ -1142,7 +1142,7 @@ export const $PostingDetailDto = {
     units: {
       type: 'string',
       description:
-        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.',
+        'Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned. Carries the raw Beancount sign (credit-normal accounts such as Income post negative — the accounting truth, ADR-0126); renderers must not infer economic semantics from this sign.',
       example: '100.50'
     },
     currency: {
@@ -1326,6 +1326,147 @@ export const $TransactionDetailDto = {
   ]
 } as const;
 
+export const $TransactionListItemDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'Transaction ID',
+      example: 'clh1234567890abcdef'
+    },
+    date: {
+      type: 'string',
+      description: 'Transaction date',
+      example: '2024-11-28'
+    },
+    flag: {
+      type: 'string',
+      description: 'Transaction flag',
+      enum: [
+        'CLEARED',
+        'PENDING',
+        'PADDING',
+        'SUMMARIZE',
+        'TRANSFER',
+        'CONVERSIONS'
+      ],
+      example: 'CLEARED'
+    },
+    customFlag: {
+      type: 'string',
+      description: 'Custom flag (if not using standard flags)',
+      example: 'R'
+    },
+    payee: {
+      type: 'string',
+      description: 'Payee name',
+      example: 'Whole Foods Market'
+    },
+    narration: {
+      type: 'string',
+      description: 'Transaction narration',
+      example: 'Grocery shopping'
+    },
+    tags: {
+      description: 'Transaction tags',
+      example: ['groceries'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    links: {
+      description: 'Transaction links',
+      example: ['invoice-2024-001'],
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    meta: {
+      type: 'object',
+      description: 'Transaction metadata'
+    },
+    status: {
+      type: 'string',
+      description: 'Transaction status',
+      enum: ['ACTIVE', 'VOIDED', 'SUPERSEDED'],
+      example: 'ACTIVE'
+    },
+    sourceType: {
+      type: 'string',
+      description:
+        'Source type (free-form string from transaction metadata, e.g. import, api)'
+    },
+    sourcePlatform: {
+      type: 'string',
+      description: 'Source platform (e.g., alipay, wechat)',
+      example: 'alipay'
+    },
+    postings: {
+      description: 'Transaction postings',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/PostingDetailDto'
+      }
+    },
+    createdAt: {
+      type: 'string',
+      description: 'Created at timestamp',
+      example: '2024-11-28T10:30:00.000Z'
+    },
+    voidedAt: {
+      type: 'string',
+      description: 'Voided at timestamp (if voided)',
+      example: '2024-11-29T15:00:00.000Z'
+    },
+    voidedBy: {
+      type: 'string',
+      description: 'User ID who voided this transaction',
+      example: 'clh1234567890abcdef'
+    },
+    correctionReason: {
+      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'
+    },
+    viewpointAmount: {
+      type: 'string',
+      description:
+        'Row amount under the request viewpoint (ADR-0126). Category viewpoint (category + flow): per-leg sign-normalized sum over the category account set (Income-root legs negated, Expenses-root identity) — positive under normal booking but NOT clamped (explicit negative expense legs and net-flip refund months stay negative). No viewpoint (plain list / search, no accountId): wallet money-flow net = raw-sign sum over cost-less Assets/Liabilities legs (income positive, expenses negative, transfers net ~0); color cue is the wallet sign (net < 0 = wealth-decreasing). Status-orthogonal: audit views match too (ADR-0128 amount-as-matching-key). Omitted under the account viewpoint (incl. dual) and for rows with no wallet leg.',
+      example: '10000.00'
+    },
+    viewpointCurrency: {
+      type: 'string',
+      description:
+        'Currency of viewpointAmount. A row spanning multiple currencies takes the largest-magnitude currency group (known simplification, ADR-0126).',
+      example: 'CNY'
+    }
+  },
+  required: [
+    'id',
+    'date',
+    'narration',
+    'tags',
+    'links',
+    'status',
+    'postings',
+    'createdAt'
+  ]
+} as const;
+
 export const $BalanceByCurrencyDto = {
   type: 'object',
   properties: {
@@ -1371,7 +1512,7 @@ export const $TransactionListSummaryDto = {
     totalAmount: {
       type: 'string',
       description:
-        'Partial converted total in base currency (rated currencies only, raw Beancount sign). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
+        'Partial converted total in base currency (rated currencies only). Sign by viewpoint (ADR-0126): account viewpoint keeps the raw Beancount sign (income negative); category viewpoint is per-leg sign-normalized (Income legs negated, Expenses legs identity — positive under normal booking, not clamped). When warnings is non-empty this excludes currencies missing an FX rate; may be "0.00" if ALL non-base currencies lack a rate. Converted at the dateTo (or current) available rate.',
       example: '-6000.00'
     },
     currency: {
@@ -1397,6 +1538,26 @@ export const $TransactionListSummaryDto = {
   required: ['totalAmount', 'currency', 'balanceByCurrency']
 } as const;
 
+export const $TransactionListViewpointDto = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      description:
+        'Viewpoint type (only category drill-down carries a viewpoint today)',
+      enum: ['category'],
+      example: 'category'
+    },
+    flow: {
+      type: 'string',
+      description: 'Flow root the category account set is restricted to',
+      enum: ['income', 'expense'],
+      example: 'expense'
+    }
+  },
+  required: ['type', 'flow']
+} as const;
+
 export const $TransactionListResponseDto = {
   type: 'object',
   properties: {
@@ -1404,7 +1565,7 @@ export const $TransactionListResponseDto = {
       description: 'List of transactions',
       type: 'array',
       items: {
-        $ref: '#/components/schemas/TransactionDetailDto'
+        $ref: '#/components/schemas/TransactionListItemDto'
       }
     },
     total: {
@@ -1430,6 +1591,15 @@ export const $TransactionListResponseDto = {
           $ref: '#/components/schemas/TransactionListSummaryDto'
         }
       ]
+    },
+    viewpoint: {
+      description:
+        'Viewpoint metadata (ADR-0126). Present only for a single category filter (category + flow, no accountId); dual-perspective requests are viewpoint-less (raw signs, no viewpointAmount).',
+      allOf: [
+        {
+          $ref: '#/components/schemas/TransactionListViewpointDto'
+        }
+      ]
     }
   },
   required: ['data', 'total', 'limit', 'offset']
@@ -6217,7 +6387,7 @@ export const $ProcessNlpDto = {
     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.',
+        'confirm_account echo-back: account path selected from the prior confirm_account response (suggestedAccount, similarAccounts[i].path, or a typed path). Applied directly when the session is confirming_account — no NL re-parse.',
       example: 'Expenses:Food:Coffee'
     }
   }
@@ -6532,6 +6702,24 @@ export const $NlpRuleConfirmationDataDto = {
   ]
 } as const;
 
+export const $NlpAccountCandidateDto = {
+  type: 'object',
+  properties: {
+    path: {
+      type: 'string',
+      description: 'Canonical beancount account path (echo back on selection)',
+      example: 'Expenses:Food:Dining'
+    },
+    name: {
+      type: 'string',
+      description:
+        'Localized display name (ADR-0114 read-time projection, user locale)',
+      example: '餐饮'
+    }
+  },
+  required: ['path', 'name']
+} as const;
+
 export const $NlpAccountConfirmationDataDto = {
   type: 'object',
   properties: {
@@ -6547,10 +6735,11 @@ export const $NlpAccountConfirmationDataDto = {
       example: 'Expenses:Food:Drinks'
     },
     similarAccounts: {
-      description: 'Similar accounts for user selection',
+      description:
+        'Similar accounts for user selection (path + localized name, #680)',
       type: 'array',
       items: {
-        type: 'string'
+        $ref: '#/components/schemas/NlpAccountCandidateDto'
       }
     },
     errorMessage: {
@@ -8395,6 +8584,216 @@ export const $AnonymousLoginResponseDto = {
   required: ['authToken']
 } as const;
 
+export const $ParserContributionMetaDto = {
+  type: 'object',
+  properties: {
+    institution: {
+      type: 'string',
+      description: 'Institution slug (lowercase kebab-case)',
+      pattern: '^[a-z0-9]+(-[a-z0-9]+)*$',
+      example: 'icbc'
+    },
+    region: {
+      type: 'string',
+      enum: [
+        'cn',
+        'us',
+        'de',
+        'fr',
+        'gb',
+        'hk',
+        'jp',
+        'sg',
+        'au',
+        'ca',
+        'other'
+      ]
+    },
+    accountType: {
+      type: 'string',
+      enum: ['checking', 'savings', 'credit', 'debit', 'investment']
+    },
+    format: {
+      type: 'string',
+      enum: ['csv', 'xlsx', 'pdf', 'ofx', 'qif']
+    },
+    institutionDisplayName: {
+      type: 'string',
+      example: '中国工商银行'
+    },
+    encoding: {
+      type: 'string',
+      example: 'utf-8'
+    },
+    delimiter: {
+      type: 'string',
+      description: 'CSV delimiter character: ",", ";", "\\t" or "|"'
+    },
+    headerRows: {
+      type: 'number',
+      default: 1,
+      description: 'Header row count; the client omits the field when it is 1'
+    },
+    notes: {
+      type: 'string',
+      maxLength: 2000
+    }
+  },
+  required: ['institution', 'region', 'accountType', 'format']
+} as const;
+
+export const $ParserContributionSamplesDto = {
+  type: 'object',
+  properties: {
+    rows: {
+      description:
+        'Client-sanitized sample rows (key = column name, value = cell)',
+      type: 'array',
+      items: {
+        type: 'object'
+      }
+    },
+    rawHeaders: {
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    }
+  },
+  required: ['rows']
+} as const;
+
+export const $FieldHintDto = {
+  type: 'object',
+  properties: {
+    columnName: {
+      type: 'string',
+      example: '交易日期'
+    },
+    format: {
+      type: 'string',
+      description: 'Date format, e.g. yyyy-MM-dd HH:mm',
+      example: 'yyyy-MM-dd'
+    },
+    signConvention: {
+      type: 'string',
+      enum: ['negative-expense', 'positive-expense', 'separate-columns']
+    },
+    creditColumn: {
+      type: 'string'
+    },
+    debitColumn: {
+      type: 'string'
+    }
+  },
+  required: ['columnName']
+} as const;
+
+export const $ParserContributionFieldHintsDto = {
+  type: 'object',
+  properties: {
+    date: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    amount: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    description: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    balance: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    payee: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    reference: {
+      $ref: '#/components/schemas/FieldHintDto'
+    },
+    category: {
+      $ref: '#/components/schemas/FieldHintDto'
+    }
+  },
+  required: ['date', 'amount']
+} as const;
+
+export const $ExpectedTransactionDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      example: '2026-08-01'
+    },
+    amount: {
+      type: 'number',
+      example: -45.5
+    },
+    description: {
+      type: 'string',
+      example: '星巴克-***店'
+    },
+    payee: {
+      type: 'string'
+    },
+    category: {
+      type: 'string'
+    }
+  },
+  required: ['date', 'amount', 'description']
+} as const;
+
+export const $ParserContributionExamplesDto = {
+  type: 'object',
+  properties: {
+    expectedTransactions: {
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExpectedTransactionDto'
+      }
+    }
+  },
+  required: ['expectedTransactions']
+} as const;
+
+export const $ParserContributionRequestDto = {
+  type: 'object',
+  properties: {
+    meta: {
+      $ref: '#/components/schemas/ParserContributionMetaDto'
+    },
+    samples: {
+      $ref: '#/components/schemas/ParserContributionSamplesDto'
+    },
+    fieldHints: {
+      $ref: '#/components/schemas/ParserContributionFieldHintsDto'
+    },
+    examples: {
+      description: 'Omitted entirely by the client when empty',
+      allOf: [
+        {
+          $ref: '#/components/schemas/ParserContributionExamplesDto'
+        }
+      ]
+    }
+  },
+  required: ['meta', 'samples', 'fieldHints']
+} as const;
+
+export const $ParserContributionRelayResponseDto = {
+  type: 'object',
+  properties: {
+    issueUrl: {
+      type: 'string',
+      example: 'https://github.com/fire-zu/firela-vlt/issues/42'
+    },
+    issueNumber: {
+      type: 'number',
+      example: 42
+    }
+  },
+  required: ['issueUrl', 'issueNumber']
+} as const;
+
 export const $SymbolSearchResultDto = {
   type: 'object',
   properties: {

package/src/generated/services.gen.ts

@@ -280,6 +280,8 @@ import type {
   ApiKeysControllerCreateApiKeyResponse,
   AuthControllerAccessTokenLoginData,
   AuthControllerAccessTokenLoginResponse,
+  ParserContributionControllerCreateData,
+  ParserContributionControllerCreateResponse,
   CacheControllerFlushCacheResponse,
   ExchangeRateControllerGetExchangeRateData,
   ExchangeRateControllerGetExchangeRateResponse,
@@ -638,10 +640,11 @@ export class BeanTransactionsService {
    * @param data.offset Number of items to skip (default: 0)
    * @param data.dateFrom Filter by start date (inclusive), format: YYYY-MM-DD
    * @param data.dateTo Filter by end date (inclusive), format: YYYY-MM-DD
-   * @param data.status Filter by transaction status
+   * @param data.status Filter by transaction status: single value, comma-separated multi-value (e.g. VOIDED,SUPERSEDED), or ALL to include audit rows. Defaults to ACTIVE-only (ADR-0128; previously unfiltered — breaking change).
    * @param data.search Search in narration and payee fields (max 200 chars)
    * @param data.accountId Filter by account ID (transactions with postings to this account)
-   * @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
+   * @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an account whose derived Group segment equals this value. Must be accompanied by flow (ADR-0126).
+   * @param data.flow Required when category is present (400 otherwise) and vice versa (ADR-0126). Restricts the category account set to the flow root (income → Income:, expense → Expenses:) and drives the per-leg sign normalization of row viewpointAmount and the summary. OpenAPI cannot express conditional requiredness — the pairing is enforced at runtime.
    * @returns TransactionListResponseDto Transaction list
    * @throws ApiError
    */
@@ -662,7 +665,8 @@ export class BeanTransactionsService {
         status: data.status,
         search: data.search,
         accountId: data.accountId,
-        category: data.category
+        category: data.category,
+        flow: data.flow
       },
       errors: {
         400: 'Validation failed',
@@ -4042,6 +4046,38 @@ export class AuthService {
   }
 }
 
+export class CommunityService {
+  /**
+   * Relay a sanitized parser-contribution payload
+   * A server-side bot re-sanitizes the payload and opens an issue on the target repository; the issue URL is returned. The payload is never persisted or logged (forward-and-drop).
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context (routing only; the institution region rides in the payload meta)
+   * @param data.requestBody
+   * @returns ParserContributionRelayResponseDto Issue created by the bot
+   * @throws ApiError
+   */
+  public static parserContributionControllerCreate(
+    data: ParserContributionControllerCreateData
+  ): CancelablePromise<ParserContributionControllerCreateResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/community/parser-contributions',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        401: 'Unauthorized',
+        422: 'Validation failed (institution slug, empty samples, row/cell size limits)',
+        429: 'Rate limited (5 submissions per user per hour)',
+        501: 'Relay not configured on this deployment — clients fall back to the clipboard flow',
+        502: 'GitHub bot failure (upstream), safe to retry'
+      }
+    });
+  }
+}
+
 export class DefaultService {
   /**
    * @returns unknown