@firela/api-types 0.0.0-canary.792fa5f1 → 0.0.0-canary.7a8f5374

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.792fa5f1",
+  "version": "0.0.0-canary.7a8f5374",
   "description": "TypeScript types generated from IGN OpenAPI specification",
   "license": "MIT",
   "author": "FireLa Team",

package/src/generated/schemas.gen.ts

@@ -660,6 +660,32 @@ export const $CreateTransactionDto = {
   required: ['date', 'narration', 'postings']
 } as const;
 
+export const $CostDetailDto = {
+  type: 'object',
+  properties: {
+    number: {
+      type: 'string',
+      description: 'Per-unit cost basis (mirrors engine Cost.number)',
+      example: '240'
+    },
+    currency: {
+      type: 'string',
+      description: 'Cost currency',
+      example: 'USD'
+    },
+    date: {
+      type: 'string',
+      description: 'Lot acquisition date (ISO yyyy-mm-dd)',
+      example: '2024-01-15'
+    },
+    label: {
+      type: 'string',
+      description: 'Lot label',
+      example: 'lot-2024-01'
+    }
+  }
+} as const;
+
 export const $PostingResponseDto = {
   type: 'object',
   properties: {
@@ -678,6 +704,15 @@ export const $PostingResponseDto = {
       type: 'string',
       description: 'Currency',
       example: 'USD'
+    },
+    cost: {
+      description:
+        'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
+      allOf: [
+        {
+          $ref: '#/components/schemas/CostDetailDto'
+        }
+      ]
     }
   },
   required: ['account']
@@ -1051,6 +1086,15 @@ export const $PostingDetailDto = {
       description: 'Cost date',
       example: '2024-01-15'
     },
+    cost: {
+      description:
+        'Booking-resolved cost (mirrors engine Cost). Undefined when the posting has no cost basis.',
+      allOf: [
+        {
+          $ref: '#/components/schemas/CostDetailDto'
+        }
+      ]
+    },
     priceAmount: {
       type: 'string',
       description: 'Price amount',
@@ -1811,7 +1855,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',
@@ -1829,7 +1874,7 @@ export const $ResolveResultDto = {
       example: 'rule_01HXK5V8N2M3P4Q5R6S7T8U9V0'
     }
   },
-  required: ['success', 'resolutionId', 'canUndo', 'undoDeadline']
+  required: ['success']
 } as const;
 
 export const $UndoResultDto = {
@@ -4267,6 +4312,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: {
@@ -6439,6 +6622,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: {
@@ -6920,6 +7198,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',
@@ -7029,6 +7317,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: {}