@firela/api-types 0.0.0-canary.5c1ed455 → 0.0.0-canary.5fa96f73

package/dist/index.js

@@ -670,6 +670,7 @@ var BeanTransactionsService = class {
    * @param data.status Filter by transaction status
    * @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
    * @returns TransactionListResponseDto Transaction list
    * @throws ApiError
    */
@@ -687,7 +688,8 @@ var BeanTransactionsService = class {
         dateTo: data.dateTo,
         status: data.status,
         search: data.search,
-        accountId: data.accountId
+        accountId: data.accountId,
+        category: data.category
       },
       errors: {
         400: "Validation failed",

package/dist/index.mjs

@@ -638,6 +638,7 @@ var BeanTransactionsService = class {
    * @param data.status Filter by transaction status
    * @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
    * @returns TransactionListResponseDto Transaction list
    * @throws ApiError
    */
@@ -655,7 +656,8 @@ var BeanTransactionsService = class {
         dateTo: data.dateTo,
         status: data.status,
         search: data.search,
-        accountId: data.accountId
+        accountId: data.accountId,
+        category: data.category
       },
       errors: {
         400: "Validation failed",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firela/api-types",
-  "version": "0.0.0-canary.5c1ed455",
+  "version": "0.0.0-canary.5fa96f73",
   "description": "TypeScript types generated from IGN OpenAPI specification",
   "license": "MIT",
   "author": "FireLa Team",

package/src/generated/schemas.gen.ts

@@ -1247,6 +1247,77 @@ export const $TransactionDetailDto = {
   ]
 } as const;
 
+export const $BalanceByCurrencyDto = {
+  type: 'object',
+  properties: {
+    currency: {
+      type: 'string',
+      description: 'ISO 4217 currency code',
+      example: 'CNY'
+    },
+    balance: {
+      type: 'string',
+      description: 'Balance amount',
+      example: '50000.00'
+    }
+  },
+  required: ['currency', 'balance']
+} as const;
+
+export const $ExchangeRateWarningDto = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      description: 'Warning type',
+      example: 'MISSING_EXCHANGE_RATE'
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency without exchange rate',
+      example: 'EUR'
+    },
+    totalAmount: {
+      type: 'string',
+      description: 'Total amount affected',
+      example: '1000.00'
+    }
+  },
+  required: ['type', 'currency', 'totalAmount']
+} as const;
+
+export const $TransactionListSummaryDto = {
+  type: 'object',
+  properties: {
+    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.',
+      example: '-6000.00'
+    },
+    currency: {
+      type: 'string',
+      description: 'Base currency (ISO 4217)',
+      example: 'CNY'
+    },
+    balanceByCurrency: {
+      description: 'Raw (unconverted) balance per currency',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/BalanceByCurrencyDto'
+      }
+    },
+    warnings: {
+      description: 'Currencies missing an FX rate (omitted when empty)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExchangeRateWarningDto'
+      }
+    }
+  },
+  required: ['totalAmount', 'currency', 'balanceByCurrency']
+} as const;
+
 export const $TransactionListResponseDto = {
   type: 'object',
   properties: {
@@ -1271,6 +1342,15 @@ export const $TransactionListResponseDto = {
       type: 'number',
       description: 'Number of items skipped',
       example: 0
+    },
+    summary: {
+      description:
+        'Amount summary for the full filtered set (#514). Present only when the request has a single account OR category viewpoint; omitted for search-only / plain-list / dual-perspective requests.',
+      allOf: [
+        {
+          $ref: '#/components/schemas/TransactionListSummaryDto'
+        }
+      ]
     }
   },
   required: ['data', 'total', 'limit', 'offset']
@@ -1855,7 +1935,8 @@ export const $ResolveResultDto = {
     },
     resolutionId: {
       type: 'string',
-      description: 'Resolution ID for undo'
+      description:
+        'Resolution ID for undo. Absent when the resolver rejected the decision (review stayed PENDING).'
     },
     canUndo: {
       type: 'boolean',
@@ -1873,7 +1954,7 @@ export const $ResolveResultDto = {
       example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
     }
   },
-  required: ['success', 'resolutionId', 'canUndo', 'undoDeadline']
+  required: ['success']
 } as const;
 
 export const $UndoResultDto = {
@@ -4311,6 +4392,144 @@ export const $UpdatePropertyDto = {
   required: ['value']
 } as const;
 
+export const $CreateBeanEventDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      description: 'Life event date (ISO 8601)',
+      example: '2024-03-15'
+    },
+    type: {
+      type: 'string',
+      description:
+        'Life event type (e.g., "employer", "location", "marital-status") — user-defined, no enum constraint at engine layer',
+      example: 'employer'
+    },
+    description: {
+      type: 'string',
+      description:
+        'Life event description. Empty string is a VALID value (distinct from absence).',
+      example: 'Acme Corp'
+    },
+    meta: {
+      type: 'object',
+      description:
+        'Product-side metadata (lives in BeanEvent.meta JSON, never in engine Event fields)',
+      example: {
+        note: 'Promotion'
+      }
+    }
+  },
+  required: ['date', 'type', 'description']
+} as const;
+
+export const $EventResponseDto = {
+  type: 'object',
+  properties: {
+    id: {
+      type: 'string',
+      description: 'Unique identifier',
+      example: 'uuid-123-456'
+    },
+    userId: {
+      type: 'string',
+      description: 'User ID (owner of the life event)',
+      example: 'user-123'
+    },
+    date: {
+      type: 'string',
+      description: 'Life event date (ISO 8601 format)',
+      example: '2024-03-15',
+      format: 'date'
+    },
+    type: {
+      type: 'string',
+      description:
+        'Life event type (user-defined, e.g., "employer", "location")',
+      example: 'employer'
+    },
+    description: {
+      type: 'string',
+      description:
+        'Life event description. May be an empty string (a valid value distinct from absence).',
+      example: 'Acme Corp'
+    },
+    meta: {
+      type: 'object',
+      description: 'Product-side metadata (free-form JSON)',
+      example: {
+        note: 'Promotion'
+      }
+    },
+    createdAt: {
+      format: 'date-time',
+      type: 'string',
+      description: 'Creation timestamp',
+      example: '2024-03-15T10:00:00Z'
+    },
+    updatedAt: {
+      format: 'date-time',
+      type: 'string',
+      description:
+        'Last update timestamp. Also emitted as the ETag response header for If-Match optimistic concurrency.',
+      example: '2024-03-15T10:00:00Z'
+    }
+  },
+  required: [
+    'id',
+    'userId',
+    'date',
+    'type',
+    'description',
+    'meta',
+    'createdAt',
+    'updatedAt'
+  ]
+} as const;
+
+export const $EventListResponseDto = {
+  type: 'object',
+  properties: {
+    items: {
+      description: 'List of life events',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/EventResponseDto'
+      }
+    },
+    total: {
+      type: 'number',
+      description: 'Total number of life events matching the query',
+      example: 42
+    }
+  },
+  required: ['items', 'total']
+} as const;
+
+export const $UpdateBeanEventDto = {
+  type: 'object',
+  properties: {
+    date: {
+      type: 'string',
+      description: 'Life event date (ISO 8601)'
+    },
+    type: {
+      type: 'string',
+      description: 'Life event type (user-defined)'
+    },
+    description: {
+      type: 'string',
+      description:
+        'Life event description. Empty string is a VALID value (distinct from absence).'
+    },
+    meta: {
+      type: 'object',
+      description: 'Product-side metadata (free-form JSON)'
+    }
+  }
+} as const;
+
 export const $FileImportDto = {
   type: 'object',
   properties: {
@@ -5790,23 +6009,6 @@ export const $NlpResponseDto = {
   required: ['status', 'action']
 } as const;
 
-export const $BalanceByCurrencyDto = {
-  type: 'object',
-  properties: {
-    currency: {
-      type: 'string',
-      description: 'ISO 4217 currency code',
-      example: 'CNY'
-    },
-    balance: {
-      type: 'string',
-      description: 'Balance amount',
-      example: '50000.00'
-    }
-  },
-  required: ['currency', 'balance']
-} as const;
-
 export const $NetWorthByCurrencyDto = {
   type: 'object',
   properties: {
@@ -5876,28 +6078,6 @@ export const $ConvertedNetWorthDto = {
   ]
 } as const;
 
-export const $ExchangeRateWarningDto = {
-  type: 'object',
-  properties: {
-    type: {
-      type: 'string',
-      description: 'Warning type',
-      example: 'MISSING_EXCHANGE_RATE'
-    },
-    currency: {
-      type: 'string',
-      description: 'Currency without exchange rate',
-      example: 'EUR'
-    },
-    totalAmount: {
-      type: 'string',
-      description: 'Total amount affected',
-      example: '1000.00'
-    }
-  },
-  required: ['type', 'currency', 'totalAmount']
-} as const;
-
 export const $NetWorthResponseDto = {
   type: 'object',
   properties: {
@@ -6025,11 +6205,66 @@ export const $PlatformGroupDto = {
     },
     totalBalance: {
       type: 'string',
-      description: 'Total balance across all accounts in platform',
+      description: 'FX-converted total balance in base currency',
+      example: '100000.00'
+    },
+    balanceByCurrency: {
+      description: 'Raw (unconverted) balances grouped by currency',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/BalanceByCurrencyDto'
+      }
+    },
+    convertedBalance: {
+      type: 'string',
+      description:
+        'Converted balance in base currency (omitted when no currency is convertible)',
       example: '100000.00'
+    },
+    sharePct: {
+      type: 'number',
+      description:
+        'Share of the grand converted total (0-100); 0 when grand total is 0',
+      example: 42.5
     }
   },
-  required: ['platformId', 'platformName', 'accounts', 'totalBalance']
+  required: [
+    'platformId',
+    'platformName',
+    'accounts',
+    'totalBalance',
+    'balanceByCurrency',
+    'sharePct'
+  ]
+} as const;
+
+export const $AccountExchangeRateWarningDto = {
+  type: 'object',
+  properties: {
+    type: {
+      type: 'string',
+      description: 'Warning type',
+      example: 'MISSING_EXCHANGE_RATE'
+    },
+    currency: {
+      type: 'string',
+      description: 'Currency without exchange rate',
+      example: 'USD'
+    },
+    accounts: {
+      description: 'Affected account paths',
+      type: 'array',
+      items: {
+        type: 'string'
+      }
+    },
+    totalAmount: {
+      type: 'string',
+      description: 'Total amount in this currency',
+      example: '5000.00'
+    }
+  },
+  required: ['type', 'currency', 'accounts', 'totalAmount']
 } as const;
 
 export const $AccountsSummaryDto = {
@@ -6042,9 +6277,21 @@ export const $AccountsSummaryDto = {
     totalPlatforms: {
       type: 'number',
       description: 'Total number of platforms'
+    },
+    baseCurrency: {
+      type: 'string',
+      description: 'Base currency for conversion',
+      example: 'CNY'
+    },
+    warnings: {
+      description: 'Per-account exchange rate warnings',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/AccountExchangeRateWarningDto'
+      }
     }
   },
-  required: ['totalAccounts', 'totalPlatforms']
+  required: ['totalAccounts', 'totalPlatforms', 'baseCurrency']
 } as const;
 
 export const $AccountsResponseDto = {
@@ -6175,35 +6422,6 @@ export const $AssetClassGroupDto = {
   required: ['assetClass', 'accounts', 'balanceByCurrency']
 } as const;
 
-export const $AccountExchangeRateWarningDto = {
-  type: 'object',
-  properties: {
-    type: {
-      type: 'string',
-      description: 'Warning type',
-      example: 'MISSING_EXCHANGE_RATE'
-    },
-    currency: {
-      type: 'string',
-      description: 'Currency without exchange rate',
-      example: 'USD'
-    },
-    accounts: {
-      description: 'Affected account paths',
-      type: 'array',
-      items: {
-        type: 'string'
-      }
-    },
-    totalAmount: {
-      type: 'string',
-      description: 'Total amount in this currency',
-      example: '5000.00'
-    }
-  },
-  required: ['type', 'currency', 'accounts', 'totalAmount']
-} as const;
-
 export const $AssetClassSummaryDto = {
   type: 'object',
   properties: {
@@ -6483,6 +6701,101 @@ export const $CashFlowResponseDto = {
   ]
 } as const;
 
+export const $CategoryGroupDto = {
+  type: 'object',
+  properties: {
+    category: {
+      type: 'string',
+      description:
+        'Functional category (account-path Group segment); regional and universal account paths merge under it',
+      example: 'Food'
+    },
+    totalExpense: {
+      type: 'string',
+      description:
+        'Converted total for this category in base currency (expense amount when flow=expense, income amount when flow=income)',
+      example: '1200.00'
+    },
+    sharePct: {
+      type: 'number',
+      description: 'Share of grand total (0-100); 0 when grand total is 0',
+      example: 42.5
+    },
+    balanceByCurrency: {
+      description: 'Raw (unconverted) expense per currency',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/BalanceByCurrencyDto'
+      }
+    },
+    convertedBalance: {
+      type: 'string',
+      description:
+        'Converted total in base currency (omitted when FX missing for all currencies in this category)',
+      example: '1200.00'
+    }
+  },
+  required: ['category', 'totalExpense', 'sharePct', 'balanceByCurrency']
+} as const;
+
+export const $ExpensesByCategorySummaryDto = {
+  type: 'object',
+  properties: {
+    totalExpense: {
+      type: 'string',
+      description:
+        'Total across all categories, converted (convertible categories only); expense totals when flow=expense, income totals when flow=income',
+      example: '5000.00'
+    },
+    categoryCount: {
+      type: 'number',
+      description: 'Number of categories',
+      example: 8
+    }
+  },
+  required: ['totalExpense', 'categoryCount']
+} as const;
+
+export const $ExpensesByCategoryResponseDto = {
+  type: 'object',
+  properties: {
+    period: {
+      type: 'string',
+      description: 'Period requested',
+      example: '1m'
+    },
+    baseCurrency: {
+      type: 'string',
+      description: 'Base currency for converted values',
+      example: 'CNY'
+    },
+    groups: {
+      description:
+        'Expense groups by functional category, sorted by converted total desc',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CategoryGroupDto'
+      }
+    },
+    summary: {
+      description: 'Summary statistics',
+      allOf: [
+        {
+          $ref: '#/components/schemas/ExpensesByCategorySummaryDto'
+        }
+      ]
+    },
+    warnings: {
+      description: 'Exchange rate warnings (e.g. missing rate for a currency)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExchangeRateWarningDto'
+      }
+    }
+  },
+  required: ['period', 'baseCurrency', 'groups', 'summary']
+} as const;
+
 export const $MonetaryDto = {
   type: 'object',
   properties: {
@@ -6964,6 +7277,16 @@ export const $TimeSeriesPointDto = {
       description: 'Change from previous point',
       example: '5000.00'
     },
+    assets: {
+      type: 'string',
+      description: 'Total assets at this date (in base currency)',
+      example: '494338.00'
+    },
+    liabilities: {
+      type: 'string',
+      description: 'Total liabilities at this date (in base currency)',
+      example: '310098.00'
+    },
     byCurrency: {
       description: 'Multi-currency breakdown for this point',
       type: 'array',
@@ -7073,6 +7396,111 @@ export const $PortfolioTrendsResponseDto = {
   required: ['series', 'summary', 'period', 'granularity', 'currency']
 } as const;
 
+export const $CashFlowPointDto = {
+  type: 'object',
+  properties: {
+    month: {
+      type: 'string',
+      description: 'Month key (YYYY-MM)',
+      example: '2024-03'
+    },
+    income: {
+      type: 'string',
+      description: 'Income in base currency (absolute, converted)',
+      example: '10000.00'
+    },
+    expense: {
+      type: 'string',
+      description: 'Expense in base currency (absolute, converted)',
+      example: '5000.00'
+    },
+    netSavings: {
+      type: 'string',
+      description: 'netSavings = income − expense (savings positive)',
+      example: '5000.00'
+    }
+  },
+  required: ['month', 'income', 'expense', 'netSavings']
+} as const;
+
+export const $CashFlowTrendSummaryDto = {
+  type: 'object',
+  properties: {
+    totalIncome: {
+      type: 'string',
+      description: 'Total income across the period',
+      example: '60000.00'
+    },
+    totalExpense: {
+      type: 'string',
+      description: 'Total expense across the period',
+      example: '30000.00'
+    },
+    totalNetSavings: {
+      type: 'string',
+      description: 'income − expense across the period',
+      example: '30000.00'
+    },
+    averageMonthlyNetSavings: {
+      type: 'string',
+      description:
+        'totalNetSavings divided by the window length (N months, incl. zero-filled)',
+      example: '5000.00'
+    }
+  },
+  required: [
+    'totalIncome',
+    'totalExpense',
+    'totalNetSavings',
+    'averageMonthlyNetSavings'
+  ]
+} as const;
+
+export const $CashFlowTrendsResponseDto = {
+  type: 'object',
+  properties: {
+    series: {
+      description:
+        'Monthly cash-flow series (fixed N-month window, zero-filled)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/CashFlowPointDto'
+      }
+    },
+    summary: {
+      description: 'Period totals',
+      allOf: [
+        {
+          $ref: '#/components/schemas/CashFlowTrendSummaryDto'
+        }
+      ]
+    },
+    period: {
+      type: 'string',
+      description: 'Period requested',
+      example: '6m'
+    },
+    granularity: {
+      type: 'string',
+      description: 'Data granularity (v1 returns month buckets)',
+      example: 'month'
+    },
+    currency: {
+      type: 'string',
+      description: 'Base currency for converted values',
+      example: 'CNY'
+    },
+    warnings: {
+      description: 'Exchange rate warnings (e.g. missing rate for a currency)',
+      type: 'array',
+      items: {
+        $ref: '#/components/schemas/ExchangeRateWarningDto'
+      }
+    }
+  },
+  required: ['series', 'summary', 'period', 'granularity', 'currency']
+} as const;
+
 export const $GenerateSnapshotBody = {
   type: 'object',
   properties: {}