@firela/api-types 0.0.0-canary.614ff760 → 0.0.0-canary.6e40e263

package/src/generated/types.gen.ts

@@ -316,6 +316,53 @@ export type RegionsMetadataResponseDto = {
   regions: Array<RegionInfoDto>;
 };
 
+export type CostSpecDto = {
+  /**
+   * Cost specification mode (mirrors engine CostSpec)
+   */
+  mode: 'per-unit' | 'total' | 'date' | 'label' | 'auto';
+  /**
+   * Per-unit cost (required when mode is "per-unit")
+   */
+  numberPerUnit?: string;
+  /**
+   * Total cost for all units (required when mode is "total")
+   */
+  totalNumber?: string;
+  /**
+   * Cost currency (required in all modes)
+   */
+  currency: string;
+  /**
+   * Lot acquisition date, ISO 8601 (required when mode is "date")
+   */
+  date?: string;
+  /**
+   * Lot label (required when mode is "label"; optional tag in buy modes)
+   */
+  label?: string;
+  /**
+   * Merge lots for AVERAGE booking (mode: auto)
+   */
+  merge?: boolean;
+};
+
+/**
+ * Cost specification mode (mirrors engine CostSpec)
+ */
+export type mode = 'per-unit' | 'total' | 'date' | 'label' | 'auto';
+
+export type AmountDto = {
+  /**
+   * Amount as decimal string (max 15 integer + 15 decimal digits)
+   */
+  number: string;
+  /**
+   * Currency/commodity code
+   */
+  currency: string;
+};
+
 export type CreatePostingDto = {
   /**
    * Account name in Beancount format (must start with uppercase, colon-separated)
@@ -335,6 +382,14 @@ export type CreatePostingDto = {
   meta?: {
     [key: string]: unknown;
   };
+  /**
+   * Cost basis (Beancount `{...}`). Maps to engine costSpec. Required for commodity holdings so they carry a monetary weight that can balance.
+   */
+  cost?: CostSpecDto;
+  /**
+   * Price annotation (Beancount `@...`). Maps to engine price. Used for valuation; cost takes priority for balance weight.
+   */
+  price?: AmountDto;
 };
 
 export type CreateTransactionDto = {
@@ -387,6 +442,25 @@ export type CreateTransactionDto = {
  */
 export type flag = '*' | '!';
 
+export type CostDetailDto = {
+  /**
+   * Per-unit cost basis (mirrors engine Cost.number)
+   */
+  number?: string;
+  /**
+   * Cost currency
+   */
+  currency?: string;
+  /**
+   * Lot acquisition date (ISO yyyy-mm-dd)
+   */
+  date?: string;
+  /**
+   * Lot label
+   */
+  label?: string;
+};
+
 export type PostingResponseDto = {
   /**
    * Account name
@@ -400,6 +474,10 @@ export type PostingResponseDto = {
    * Currency
    */
   currency?: string;
+  /**
+   * Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.
+   */
+  cost?: CostDetailDto;
 };
 
 export type RecurringSuggestionDto = {
@@ -620,9 +698,9 @@ export type PostingDetailDto = {
    */
   accountId: string;
   /**
-   * Account name
+   * Fully-qualified Beancount account path
    */
-  accountName: string;
+  account: string;
   /**
    * Amount as decimal string. Typed optional but always present in responses: interpolation fills any MISSING posting before it is persisted or returned.
    */
@@ -643,6 +721,10 @@ export type PostingDetailDto = {
    * Cost date
    */
   costDate?: string;
+  /**
+   * Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.
+   */
+  cost?: CostDetailDto;
   /**
    * Price amount
    */
@@ -3411,6 +3493,8 @@ export type SupportedProvidersResponseDto = {
 
 export type ParserTelemetryReportDto = unknown;
 
+export type UncoveredFormatMissDto = unknown;
+
 export type ProcessNlpDto = {
   /**
    * Natural language text describing a transaction (Chinese)
@@ -4196,8 +4280,21 @@ export type AccountItemWithAssetClassDto = {
    * Risk level
    */
   riskLevel?: string;
+  /**
+   * ADR-0105 classification provenance (holding level always; account level only on FALLBACK)
+   */
+  source?: 'USER_META' | 'FIAT_CURRENCY' | 'OPENBB_MAPPING' | 'FALLBACK';
 };
 
+/**
+ * ADR-0105 classification provenance (holding level always; account level only on FALLBACK)
+ */
+export type source2 =
+  | 'USER_META'
+  | 'FIAT_CURRENCY'
+  | 'OPENBB_MAPPING'
+  | 'FALLBACK';
+
 export type AssetClassGroupDto = {
   /**
    * Asset class name
@@ -4284,6 +4381,12 @@ export type AssetClassSummaryDto = {
    * Exchange rate warnings
    */
   warnings?: Array<AccountExchangeRateWarningDto>;
+  /**
+   * ADR-0105 §4 fallback provenance stats (holding level only). valueRatio is the grey-area share of total converted value; count is the number of source=FALLBACK holdings.
+   */
+  fallback?: {
+    [key: string]: unknown;
+  };
 };
 
 export type AssetClassAccountsResponseDto = {
@@ -4295,6 +4398,56 @@ export type AssetClassAccountsResponseDto = {
    * Summary statistics
    */
   summary: AssetClassSummaryDto;
+  /**
+   * ADR-0105 §6 holding-level grey-area bucket (source=FALLBACK holdings peeled out of groups). Present only for groupBy=holdingAssetClass when FALLBACK holdings exist.
+   */
+  uncategorized?: AssetClassGroupDto;
+};
+
+export type HoldingAssetClassAccountSliceDto = {
+  /**
+   * Account ID
+   */
+  accountId: string;
+  /**
+   * Full account path
+   */
+  accountPath: string;
+  /**
+   * Currency of the holding with the largest converted base value; undefined when no holding is convertible
+   */
+  accountCurrency?: string;
+  /**
+   * Account's market value in base currency (Σ converted holdings; grey bucket included)
+   */
+  marketValueBase: string;
+  /**
+   * Share of the global total (0-100). 0 when globalTotal is zero (no NaN/Infinity).
+   */
+  shareOfTotalPct: number;
+  /**
+   * Per-account asset-class breakdown
+   */
+  groups: Array<AssetClassGroupDto>;
+  /**
+   * Per-account grey bucket (source=FALLBACK holdings, incl. broker cash)
+   */
+  uncategorized?: AssetClassGroupDto;
+  /**
+   * Every holding row for this account (account ID in each row’s `id` field)
+   */
+  holdings: Array<AccountItemWithAssetClassDto>;
+};
+
+export type HoldingAssetClassCrossAccountResponseDto = {
+  /**
+   * Merged cross-account holding aggregation
+   */
+  global: AssetClassAccountsResponseDto;
+  /**
+   * Per-account slices
+   */
+  byAccount: Array<HoldingAssetClassAccountSliceDto>;
 };
 
 export type CashFlowByCurrencyDto = {
@@ -4376,6 +4529,303 @@ export type CashFlowResponseDto = {
   warnings?: Array<ExchangeRateWarningDto>;
 };
 
+export type MonetaryDto = {
+  /**
+   * Amount (Decimal string)
+   */
+  amount: string;
+  /**
+   * ISO 4217 currency
+   */
+  currency: string;
+  /**
+   * Converted to user base currency (Decimal string)
+   */
+  baseCcyEquivalent?: {
+    [key: string]: unknown;
+  } | null;
+};
+
+export type CurrentPriceDto = {
+  /**
+   * Price amount (Decimal string)
+   */
+  amount: string;
+  /**
+   * Price currency (ISO 4217)
+   */
+  currency: string;
+  /**
+   * Price date (ISO 8601)
+   */
+  date: string;
+  /**
+   * Price source
+   */
+  source: 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
+};
+
+/**
+ * Price source
+ */
+export type source3 = 'USER_OVERRIDE' | 'OPENBB_EQUITY' | 'OPENBB_CURRENCY';
+
+export type FxRateDto = {
+  from: string;
+  to: string;
+  /**
+   * FX rate (Decimal string)
+   */
+  rate: string;
+  /**
+   * Rate date (ISO 8601)
+   */
+  date: string;
+};
+
+export type HoldingPnlRowDto = {
+  /**
+   * Account UUID
+   */
+  accountId: string;
+  /**
+   * Full account path
+   */
+  accountPath: string;
+  /**
+   * Account settlement currency (ISO 4217), from cost currency
+   */
+  accountCcy?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Broker type derived from Platform.type
+   */
+  brokerType?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Commodity symbol
+   */
+  symbol: string;
+  /**
+   * Chart segment token (libs/common resolver)
+   */
+  chartToken: 'equity' | 'fund' | 'bond' | 'cash' | 'other';
+  assetClass: string;
+  assetSubClass?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Net held units (Decimal string)
+   */
+  units: string;
+  /**
+   * Average cost per unit; null when cost currency conflicts or no cost
+   */
+  averageCostPerUnit?: MonetaryDto | null;
+  /**
+   * Cost basis of held units
+   */
+  costBasis?: MonetaryDto | null;
+  /**
+   * Market value at asOf price
+   */
+  marketValue?: MonetaryDto | null;
+  /**
+   * Price used for market value
+   */
+  currentPrice?: CurrentPriceDto | null;
+  /**
+   * Unrealized P&L in base currency (Decimal string); null when any FX/price missing
+   */
+  unrealizedPnlBase?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Unrealized P&L % (Decimal string)
+   */
+  unrealizedPnlPct?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Historical FX rate applied to cost basis
+   */
+  costFxRate?: FxRateDto | null;
+  /**
+   * FX rate applied to market value
+   */
+  marketFxRate?: FxRateDto | null;
+  /**
+   * Share of invested assets % (Decimal string); only for invested chartTokens
+   */
+  pctOfInvestedAssets?: {
+    [key: string]: unknown;
+  } | null;
+  /**
+   * Cumulative realized P&L on sold lots (asOf-date cutoff); null when the method has no applicable sells, a sell lacks a price, or any required FX rate is missing (never-mix). When a sell spans multiple currencies (cross-currency sale), amount and currency reflect the base currency; baseCcyEquivalent is always the authoritative dual-FX figure
+   */
+  realizedPnl?: MonetaryDto | null;
+};
+
+/**
+ * Chart segment token (libs/common resolver)
+ */
+export type chartToken = 'equity' | 'fund' | 'bond' | 'cash' | 'other';
+
+export type HoldingPnlWarningDto = {
+  /**
+   * Warning type
+   */
+  type:
+    | 'MISSING_COST_FX_RATE'
+    | 'MISSING_MARKET_FX_RATE'
+    | 'MISSING_SALE_PRICE'
+    | 'MISSING_REALIZED_FX_RATE'
+    | 'OVERSOLD_LOTS'
+    | 'NO_PRICE'
+    | 'MIXED_COST_CURRENCY';
+  symbol?: {
+    [key: string]: unknown;
+  } | null;
+  accountId?: {
+    [key: string]: unknown;
+  } | null;
+  currency?: {
+    [key: string]: unknown;
+  } | null;
+};
+
+/**
+ * Warning type
+ */
+export type type4 =
+  | 'MISSING_COST_FX_RATE'
+  | 'MISSING_MARKET_FX_RATE'
+  | 'MISSING_SALE_PRICE'
+  | 'MISSING_REALIZED_FX_RATE'
+  | 'OVERSOLD_LOTS'
+  | 'NO_PRICE'
+  | 'MIXED_COST_CURRENCY';
+
+export type HoldingPnlResponseDto = {
+  asOfDate: string;
+  baseCurrency: string;
+  /**
+   * Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).
+   */
+  method: 'average' | 'FIFO';
+  rows: Array<HoldingPnlRowDto>;
+  warnings: Array<HoldingPnlWarningDto>;
+};
+
+/**
+ * Realized-P&L lot-matching method (FIFO or average). Unrealized cost basis remains average regardless of this value (#473).
+ */
+export type method = 'average' | 'FIFO';
+
+export type CreateBeanPriceDto = {
+  /**
+   * Currency being priced (e.g., USD, AAPL, BTC)
+   */
+  currency: string;
+  /**
+   * Quote currency (pricing currency, e.g., CNY, EUR)
+   */
+  quoteCurrency: string;
+  /**
+   * Price amount (MUST be >= 0 per Beancount spec, supports up to 15 decimal places). Zero allowed for conversion entries, negative strictly prohibited.
+   */
+  amount: number;
+  /**
+   * Price date (ISO 8601 format)
+   */
+  date: string;
+  /**
+   * Metadata (validated by Zod schema, max field lengths enforced)
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+
+export type PriceResponseDto = {
+  /**
+   * Unique identifier
+   */
+  id: string;
+  /**
+   * User ID (owner of the price)
+   */
+  userId: string;
+  /**
+   * Currency being priced (e.g., USD, AAPL, BTC)
+   */
+  currency: string;
+  /**
+   * Quote currency (pricing currency, e.g., USD, CNY)
+   */
+  quoteCurrency: string;
+  /**
+   * Price amount (corresponds to Beancount Amount.number). Supports up to 15 decimal places.
+   */
+  amount: number;
+  /**
+   * Price date (ISO 8601 format). Represents the date this price was valid.
+   */
+  date: string;
+  /**
+   * Metadata (corresponds to Beancount meta field). Contains source, confidence, note, etc.
+   */
+  meta: {
+    [key: string]: unknown;
+  };
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string;
+};
+
+export type PriceListResponseDto = {
+  /**
+   * List of prices
+   */
+  items: Array<PriceResponseDto>;
+  /**
+   * Total number of prices
+   */
+  total: number;
+};
+
+export type UpdateBeanPriceDto = {
+  /**
+   * Currency being priced
+   */
+  currency?: string;
+  /**
+   * Quote currency (pricing currency)
+   */
+  quoteCurrency?: string;
+  /**
+   * Price amount (MUST be >= 0 per Beancount spec)
+   */
+  amount?: number;
+  /**
+   * Price date (ISO 8601 format)
+   */
+  date?: string;
+  /**
+   * Metadata
+   */
+  metadata?: {
+    [key: string]: unknown;
+  };
+};
+
 export type CurrencyBalanceDto = {
   /**
    * ISO 4217 currency code
@@ -5794,9 +6244,9 @@ export type ProviderSyncControllerSyncData = {
     | 'beancount-direct'
     | 'parsed-bill';
   /**
-   * Region code
+   * Region code for tenant context
    */
-  region: unknown;
+  region: 'cn' | 'us' | 'de' | 'gb';
   requestBody: ProviderSyncDto;
 };
 
@@ -5835,6 +6285,29 @@ export type TelemetryControllerReportTelemetryData = {
 
 export type TelemetryControllerReportTelemetryResponse = unknown;
 
+export type TelemetryControllerReportCoverageMissData = {
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  requestBody: UncoveredFormatMissDto;
+};
+
+export type TelemetryControllerReportCoverageMissResponse = unknown;
+
+export type TelemetryControllerGetCoverageMetricsData = {
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  /**
+   * Top-N uncovered formats (default 10)
+   */
+  topN?: unknown;
+};
+
+export type TelemetryControllerGetCoverageMetricsResponse = unknown;
+
 export type NlpControllerProcessNaturalLanguageData = {
   /**
    * Region code for tenant context
@@ -5888,6 +6361,10 @@ export type DashboardControllerGetNetWorthData = {
 export type DashboardControllerGetNetWorthResponse = NetWorthResponseDto;
 
 export type DashboardControllerGetAccountsData = {
+  /**
+   * Scope to a single account (only valid with groupBy=holdingAssetClass, ADR-0105 §6)
+   */
+  accountId?: string;
   /**
    * Date for balance calculation (ISO 8601 format)
    */
@@ -5895,7 +6372,11 @@ export type DashboardControllerGetAccountsData = {
   /**
    * Grouping strategy
    */
-  groupBy?: 'platform' | 'assetClass';
+  groupBy?:
+    | 'platform'
+    | 'assetClass'
+    | 'holdingAssetClass'
+    | 'holdingAssetClassByAccount';
   /**
    * Region code for tenant context
    */
@@ -5904,7 +6385,8 @@ export type DashboardControllerGetAccountsData = {
 
 export type DashboardControllerGetAccountsResponse =
   | AccountsResponseDto
-  | AssetClassAccountsResponseDto;
+  | AssetClassAccountsResponseDto
+  | HoldingAssetClassCrossAccountResponseDto;
 
 export type DashboardControllerGetCashFlowData = {
   /**
@@ -5919,6 +6401,124 @@ export type DashboardControllerGetCashFlowData = {
 
 export type DashboardControllerGetCashFlowResponse = CashFlowResponseDto;
 
+export type HoldingPnlControllerGetHoldingPnlData = {
+  /**
+   * Scope to a single account
+   */
+  accountId?: string;
+  /**
+   * As-of date (ISO 8601), defaults to today
+   */
+  asOf?: string;
+  /**
+   * Realized-P&L lot-matching method (default average). Does not affect the average-cost unrealized basis.
+   */
+  method?: 'FIFO' | 'average';
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+};
+
+export type HoldingPnlControllerGetHoldingPnlResponse = HoldingPnlResponseDto;
+
+export type PriceControllerCreateData = {
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  requestBody: CreateBeanPriceDto;
+};
+
+export type PriceControllerCreateResponse = PriceResponseDto;
+
+export type PriceControllerFindAllData = {
+  /**
+   * Filter by currency (e.g., BTC, AAPL, USD)
+   */
+  currency?: string;
+  /**
+   * Filter prices from this date (ISO 8601 format)
+   */
+  dateFrom?: string;
+  /**
+   * Filter prices to this date (ISO 8601 format)
+   */
+  dateTo?: string;
+  /**
+   * Number of items per page (default: 20, max: 100)
+   */
+  limit?: number;
+  /**
+   * Page number for pagination (default: 1)
+   */
+  page?: number;
+  /**
+   * Filter by quote currency (pricing currency, e.g., USD, CNY)
+   */
+  quoteCurrency?: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  /**
+   * Search term for currency or quoteCurrency (case-insensitive partial match)
+   */
+  search?: string;
+};
+
+export type PriceControllerFindAllResponse = PriceListResponseDto;
+
+export type PriceControllerFindOneData = {
+  /**
+   * Price ID
+   */
+  id: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+};
+
+export type PriceControllerFindOneResponse = PriceResponseDto;
+
+export type PriceControllerUpdateData = {
+  /**
+   * Price ID
+   */
+  id: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  requestBody: UpdateBeanPriceDto;
+};
+
+export type PriceControllerUpdateResponse = PriceResponseDto;
+
+export type PriceControllerDeleteData = {
+  /**
+   * Price ID
+   */
+  id: string;
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+};
+
+export type PriceControllerDeleteResponse = void;
+
+export type PriceControllerBulkCreateData = {
+  /**
+   * Region code for tenant context
+   */
+  region: 'cn' | 'us' | 'de' | 'gb';
+  requestBody: Array<string>;
+};
+
+export type PriceControllerBulkCreateResponse = Array<PriceResponseDto>;
+
 export type ReportingControllerGetPortfolioTrendsData = {
   /**
    * Data granularity
@@ -7658,6 +8258,32 @@ export type $OpenApiTs = {
       };
     };
   };
+  '/api/v1/{region}/bean/import/parser-coverage-miss': {
+    post: {
+      req: TelemetryControllerReportCoverageMissData;
+      res: {
+        /**
+         * Coverage miss report received
+         */
+        200: unknown;
+        /**
+         * Unauthorized
+         */
+        401: unknown;
+      };
+    };
+  };
+  '/api/v1/{region}/bean/import/parser-coverage-metrics': {
+    get: {
+      req: TelemetryControllerGetCoverageMetricsData;
+      res: {
+        /**
+         * Coverage metrics
+         */
+        200: unknown;
+      };
+    };
+  };
   '/api/v1/{region}/bean/nlp/process': {
     post: {
       req: NlpControllerProcessNaturalLanguageData;
@@ -7727,7 +8353,10 @@ export type $OpenApiTs = {
         /**
          * Accounts retrieved successfully. Response type depends on groupBy parameter.
          */
-        200: AccountsResponseDto | AssetClassAccountsResponseDto;
+        200:
+          | AccountsResponseDto
+          | AssetClassAccountsResponseDto
+          | HoldingAssetClassCrossAccountResponseDto;
         /**
          * User not authenticated
          */
@@ -7754,6 +8383,109 @@ export type $OpenApiTs = {
       };
     };
   };
+  '/api/v1/{region}/investment/holdings/pnl': {
+    get: {
+      req: HoldingPnlControllerGetHoldingPnlData;
+      res: {
+        /**
+         * Holding P&L retrieved successfully
+         */
+        200: HoldingPnlResponseDto;
+        /**
+         * Invalid asOf format/value/future date, invalid accountId format, or unsupported method
+         */
+        400: unknown;
+        /**
+         * User not authenticated
+         */
+        401: unknown;
+      };
+    };
+  };
+  '/api/v1/{region}/bean/prices': {
+    post: {
+      req: PriceControllerCreateData;
+      res: {
+        /**
+         * Price created successfully
+         */
+        201: PriceResponseDto;
+        /**
+         * Currency or quoteCurrency commodity not found
+         */
+        404: unknown;
+        /**
+         * Price already exists for this currency pair and date
+         */
+        409: unknown;
+      };
+    };
+    get: {
+      req: PriceControllerFindAllData;
+      res: {
+        /**
+         * Prices retrieved successfully
+         */
+        200: PriceListResponseDto;
+      };
+    };
+  };
+  '/api/v1/{region}/bean/prices/{id}': {
+    get: {
+      req: PriceControllerFindOneData;
+      res: {
+        /**
+         * Price retrieved successfully
+         */
+        200: PriceResponseDto;
+        /**
+         * Price not found
+         */
+        404: unknown;
+      };
+    };
+    put: {
+      req: PriceControllerUpdateData;
+      res: {
+        /**
+         * Price updated successfully
+         */
+        200: PriceResponseDto;
+        /**
+         * Price not found
+         */
+        404: unknown;
+        /**
+         * Updated price conflicts with existing price
+         */
+        409: unknown;
+      };
+    };
+    delete: {
+      req: PriceControllerDeleteData;
+      res: {
+        /**
+         * Price deleted successfully
+         */
+        204: void;
+        /**
+         * Price not found
+         */
+        404: unknown;
+      };
+    };
+  };
+  '/api/v1/{region}/bean/prices/bulk': {
+    post: {
+      req: PriceControllerBulkCreateData;
+      res: {
+        /**
+         * Prices created successfully
+         */
+        201: Array<PriceResponseDto>;
+      };
+    };
+  };
   '/api/v1/{region}/reporting/portfolio/trends': {
     get: {
       req: ReportingControllerGetPortfolioTrendsData;