@firela/api-types 0.0.0-canary.2fbeefe9 → 0.0.0-canary.3d558482

package/src/generated/services.gen.ts

@@ -17,6 +17,8 @@ import type {
   AccountControllerCloseResponse,
   AccountControllerReopenData,
   AccountControllerReopenResponse,
+  AccountControllerAddOpeningBalanceData,
+  AccountControllerAddOpeningBalanceResponse,
   AccountStandardsControllerGetTemplatesData,
   AccountStandardsControllerGetTemplatesResponse,
   AccountStandardsControllerGetTemplateMetadataData,
@@ -183,6 +185,14 @@ import type {
   PropertyControllerUpdateResponse,
   PropertyControllerDeleteData,
   PropertyControllerDeleteResponse,
+  ReportingControllerGetPortfolioTrendsData,
+  ReportingControllerGetPortfolioTrendsResponse,
+  ReportingControllerGetCashFlowTrendsData,
+  ReportingControllerGetCashFlowTrendsResponse,
+  ReportingControllerGenerateSnapshotData,
+  ReportingControllerGenerateSnapshotResponse,
+  ReportingControllerBackfillSnapshotsData,
+  ReportingControllerBackfillSnapshotsResponse,
   EventControllerCreateData,
   EventControllerCreateResponse,
   EventControllerFindAllData,
@@ -264,14 +274,6 @@ import type {
   DashboardControllerGetExpensesResponse,
   HoldingPnlControllerGetHoldingPnlData,
   HoldingPnlControllerGetHoldingPnlResponse,
-  ReportingControllerGetPortfolioTrendsData,
-  ReportingControllerGetPortfolioTrendsResponse,
-  ReportingControllerGetCashFlowTrendsData,
-  ReportingControllerGetCashFlowTrendsResponse,
-  ReportingControllerGenerateSnapshotData,
-  ReportingControllerGenerateSnapshotResponse,
-  ReportingControllerBackfillSnapshotsData,
-  ReportingControllerBackfillSnapshotsResponse,
   ApiKeysControllerCreateApiKeyResponse,
   AuthControllerAccessTokenLoginData,
   AuthControllerAccessTokenLoginResponse,
@@ -486,6 +488,35 @@ export class BeanAccountsService {
       }
     });
   }
+
+  /**
+   * Post an opening-balance transaction
+   * Posts a double-entry opening-balance transaction against Equity:Opening-Balances for an existing Assets/Liabilities account. At most one active opening balance per account.
+   * @param data The data for the request.
+   * @param data.id Account UUID
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns OpeningBalanceResultDto Opening-balance transaction created
+   * @throws ApiError
+   */
+  public static accountControllerAddOpeningBalance(
+    data: AccountControllerAddOpeningBalanceData
+  ): CancelablePromise<AccountControllerAddOpeningBalanceResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/bean/accounts/{id}/opening-balance',
+      path: {
+        id: data.id,
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        404: 'Account not found',
+        409: 'An opening balance already exists for this account'
+      }
+    });
+  }
 }
 
 export class BeanAccountStandardsService {
@@ -2454,7 +2485,7 @@ export class UsersService {
    * Create a new account with auto-generated access token. Protected by Cloudflare Turnstile to prevent automated signup (when enabled).
    * @param data The data for the request.
    * @param data.requestBody
-   * @returns unknown User created successfully
+   * @returns SignupResponseDto User created successfully
    * @throws ApiError
    */
   public static userControllerSignupUser(
@@ -2663,6 +2694,163 @@ export class PropertiesService {
   }
 }
 
+export class ReportingService {
+  /**
+   * Get portfolio value trends
+   *
+   * Returns time series data of portfolio net worth.
+   *
+   * **Multi-currency Support:**
+   * - `series[].byCurrency` - Currency breakdown for each data point
+   * - `byCurrency` - Separate time series grouped by currency
+   * - `warnings` - Exchange rate warnings if conversion failed
+   *
+   * **Parameters:**
+   * - `period`: Time period (1m, 3m, 6m, 1y)
+   * - `granularity`: Data granularity (day, week, month)
+   *
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.period Time period
+   * @param data.granularity Data granularity
+   * @returns PortfolioTrendsResponseDto Trends retrieved successfully
+   * @throws ApiError
+   */
+  public static reportingControllerGetPortfolioTrends(
+    data: ReportingControllerGetPortfolioTrendsData
+  ): CancelablePromise<ReportingControllerGetPortfolioTrendsResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/reporting/portfolio/trends',
+      path: {
+        region: data.region
+      },
+      query: {
+        period: data.period,
+        granularity: data.granularity
+      },
+      errors: {
+        401: 'User not authenticated'
+      }
+    });
+  }
+
+  /**
+   * Get cash-flow trends
+   *
+   * Monthly income / expense / netSavings over a fixed N-month window
+   * (current month + N−1 prior). Missing months are zero-filled (flow metric).
+   *
+   * **Parameters:**
+   * - `period`: 1m | 3m | 6m | 1y (default 6m)
+   * - `granularity`: accepted for API symmetry; v1 returns month buckets
+   *
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.period Time period
+   * @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
+   * @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
+   * @throws ApiError
+   */
+  public static reportingControllerGetCashFlowTrends(
+    data: ReportingControllerGetCashFlowTrendsData
+  ): CancelablePromise<ReportingControllerGetCashFlowTrendsResponse> {
+    return __request(OpenAPI, {
+      method: 'GET',
+      url: '/api/v1/{region}/reporting/cash-flow/trends',
+      path: {
+        region: data.region
+      },
+      query: {
+        period: data.period,
+        granularity: data.granularity
+      },
+      errors: {
+        401: 'User not authenticated'
+      }
+    });
+  }
+
+  /**
+   * Generate portfolio snapshot
+   *
+   * Manually generate a portfolio snapshot for a specific date.
+   *
+   * **Multi-currency Support:**
+   * - Fetches balances grouped by currency
+   * - Uses user's baseCurrency setting for conversion
+   * - Stores exchange rates and warnings
+   *
+   * **Use Cases:**
+   * - Testing snapshot generation
+   * - Force regeneration after data correction
+   * - Initial setup for new users
+   *
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.requestBody Optional date (defaults to today)
+   * @returns GenerateSnapshotResponse Snapshot generated successfully
+   * @throws ApiError
+   */
+  public static reportingControllerGenerateSnapshot(
+    data: ReportingControllerGenerateSnapshotData
+  ): CancelablePromise<ReportingControllerGenerateSnapshotResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/reporting/snapshots/generate',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: 'Invalid date format',
+        401: 'User not authenticated'
+      }
+    });
+  }
+
+  /**
+   * Backfill portfolio snapshots
+   *
+   * Generate snapshots for a date range (historical data backfill).
+   *
+   * **Multi-currency Support:**
+   * - Each snapshot includes multi-currency data
+   * - Uses exchange rates available at generation time
+   * - Warnings stored for missing exchange rates
+   *
+   * **Best Practices:**
+   * - Use for initial setup after account configuration
+   * - Run during low-traffic periods for large date ranges
+   * - Existing snapshots are skipped (not regenerated)
+   *
+   * @param data The data for the request.
+   * @param data.region Region code for tenant context
+   * @param data.requestBody
+   * @returns BackfillSnapshotsResponse Backfill completed successfully
+   * @throws ApiError
+   */
+  public static reportingControllerBackfillSnapshots(
+    data: ReportingControllerBackfillSnapshotsData
+  ): CancelablePromise<ReportingControllerBackfillSnapshotsResponse> {
+    return __request(OpenAPI, {
+      method: 'POST',
+      url: '/api/v1/{region}/reporting/snapshots/backfill',
+      path: {
+        region: data.region
+      },
+      body: data.requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: 'Invalid date format or range',
+        401: 'User not authenticated',
+        409: 'Backfill already in progress for this user'
+      }
+    });
+  }
+}
+
 export class LifeEventsService {
   /**
    * Create a new life event
@@ -3538,7 +3726,7 @@ export class BeanPlatformsService {
 
   /**
    * Get platform list for current user
-   * @returns unknown List of platforms with user binding status
+   * @returns PlatformListItemDto List of platforms with user binding status
    * @throws ApiError
    */
   public static platformControllerGetPlatformList(): CancelablePromise<PlatformControllerGetPlatformListResponse> {
@@ -3553,7 +3741,7 @@ export class BeanPlatformsService {
    * @param data The data for the request.
    * @param data.q Search query — Chinese name, English name, or abbreviation
    * @param data.region Region code for category override lookup
-   * @returns unknown List of matching platforms with suggested segment names
+   * @returns PlatformMatchResponseDto Matching platforms with overall match type and truncation flag
    * @throws ApiError
    */
   public static platformControllerMatchPlatforms(
@@ -3771,163 +3959,6 @@ export class InvestmentService {
   }
 }
 
-export class ReportingService {
-  /**
-   * Get portfolio value trends
-   *
-   * Returns time series data of portfolio net worth.
-   *
-   * **Multi-currency Support:**
-   * - `series[].byCurrency` - Currency breakdown for each data point
-   * - `byCurrency` - Separate time series grouped by currency
-   * - `warnings` - Exchange rate warnings if conversion failed
-   *
-   * **Parameters:**
-   * - `period`: Time period (1m, 3m, 6m, 1y)
-   * - `granularity`: Data granularity (day, week, month)
-   *
-   * @param data The data for the request.
-   * @param data.region Region code for tenant context
-   * @param data.period Time period
-   * @param data.granularity Data granularity
-   * @returns PortfolioTrendsResponseDto Trends retrieved successfully
-   * @throws ApiError
-   */
-  public static reportingControllerGetPortfolioTrends(
-    data: ReportingControllerGetPortfolioTrendsData
-  ): CancelablePromise<ReportingControllerGetPortfolioTrendsResponse> {
-    return __request(OpenAPI, {
-      method: 'GET',
-      url: '/api/v1/{region}/reporting/portfolio/trends',
-      path: {
-        region: data.region
-      },
-      query: {
-        period: data.period,
-        granularity: data.granularity
-      },
-      errors: {
-        401: 'User not authenticated'
-      }
-    });
-  }
-
-  /**
-   * Get cash-flow trends
-   *
-   * Monthly income / expense / netSavings over a fixed N-month window
-   * (current month + N−1 prior). Missing months are zero-filled (flow metric).
-   *
-   * **Parameters:**
-   * - `period`: 1m | 3m | 6m | 1y (default 6m)
-   * - `granularity`: accepted for API symmetry; v1 returns month buckets
-   *
-   * @param data The data for the request.
-   * @param data.region Region code for tenant context
-   * @param data.period Time period
-   * @param data.granularity Data granularity (accepted for API symmetry; v1 returns month buckets)
-   * @returns CashFlowTrendsResponseDto Cash-flow trends retrieved successfully
-   * @throws ApiError
-   */
-  public static reportingControllerGetCashFlowTrends(
-    data: ReportingControllerGetCashFlowTrendsData
-  ): CancelablePromise<ReportingControllerGetCashFlowTrendsResponse> {
-    return __request(OpenAPI, {
-      method: 'GET',
-      url: '/api/v1/{region}/reporting/cash-flow/trends',
-      path: {
-        region: data.region
-      },
-      query: {
-        period: data.period,
-        granularity: data.granularity
-      },
-      errors: {
-        401: 'User not authenticated'
-      }
-    });
-  }
-
-  /**
-   * Generate portfolio snapshot
-   *
-   * Manually generate a portfolio snapshot for a specific date.
-   *
-   * **Multi-currency Support:**
-   * - Fetches balances grouped by currency
-   * - Uses user's baseCurrency setting for conversion
-   * - Stores exchange rates and warnings
-   *
-   * **Use Cases:**
-   * - Testing snapshot generation
-   * - Force regeneration after data correction
-   * - Initial setup for new users
-   *
-   * @param data The data for the request.
-   * @param data.region Region code for tenant context
-   * @param data.requestBody Optional date (defaults to today)
-   * @returns GenerateSnapshotResponse Snapshot generated successfully
-   * @throws ApiError
-   */
-  public static reportingControllerGenerateSnapshot(
-    data: ReportingControllerGenerateSnapshotData
-  ): CancelablePromise<ReportingControllerGenerateSnapshotResponse> {
-    return __request(OpenAPI, {
-      method: 'POST',
-      url: '/api/v1/{region}/reporting/snapshots/generate',
-      path: {
-        region: data.region
-      },
-      body: data.requestBody,
-      mediaType: 'application/json',
-      errors: {
-        400: 'Invalid date format',
-        401: 'User not authenticated'
-      }
-    });
-  }
-
-  /**
-   * Backfill portfolio snapshots
-   *
-   * Generate snapshots for a date range (historical data backfill).
-   *
-   * **Multi-currency Support:**
-   * - Each snapshot includes multi-currency data
-   * - Uses exchange rates available at generation time
-   * - Warnings stored for missing exchange rates
-   *
-   * **Best Practices:**
-   * - Use for initial setup after account configuration
-   * - Run during low-traffic periods for large date ranges
-   * - Existing snapshots are skipped (not regenerated)
-   *
-   * @param data The data for the request.
-   * @param data.region Region code for tenant context
-   * @param data.requestBody
-   * @returns BackfillSnapshotsResponse Backfill completed successfully
-   * @throws ApiError
-   */
-  public static reportingControllerBackfillSnapshots(
-    data: ReportingControllerBackfillSnapshotsData
-  ): CancelablePromise<ReportingControllerBackfillSnapshotsResponse> {
-    return __request(OpenAPI, {
-      method: 'POST',
-      url: '/api/v1/{region}/reporting/snapshots/backfill',
-      path: {
-        region: data.region
-      },
-      body: data.requestBody,
-      mediaType: 'application/json',
-      errors: {
-        400: 'Invalid date format or range',
-        401: 'User not authenticated',
-        409: 'Backfill already in progress for this user'
-      }
-    });
-  }
-}
-
 export class ApiKeysService {
   /**
    * Create API key
@@ -3951,7 +3982,7 @@ export class AuthService {
    * Anonymous login with access token
    * @param data The data for the request.
    * @param data.requestBody
-   * @returns unknown Login successful
+   * @returns AnonymousLoginResponseDto Login successful
    * @throws ApiError
    */
   public static authControllerAccessTokenLogin(