@firela/api-types 0.0.0-canary.ebb51de2 → 0.0.0-canary.efbd2b9a

package/src/generated/services.gen.ts

@@ -257,10 +257,12 @@ import type {
 
 export class BeanAccountsService {
   /**
+   * Create a new account
+   * Creates a new account (Beancount Open directive)
    * @param data The data for the request.
    * @param data.region Region code for tenant context
    * @param data.requestBody
-   * @returns unknown
+   * @returns AccountResponseDto Account created successfully
    * @throws ApiError
    */
   public static accountControllerCreate(
@@ -273,7 +275,10 @@ export class BeanAccountsService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        409: 'Account already exists'
+      }
     });
   }
 
@@ -337,11 +342,13 @@ export class BeanAccountsService {
   }
 
   /**
+   * Update account
+   * Updates account metadata (path cannot be changed)
    * @param data The data for the request.
-   * @param data.id
+   * @param data.id Account UUID
    * @param data.region Region code for tenant context
    * @param data.requestBody
-   * @returns unknown
+   * @returns AccountResponseDto Account updated successfully
    * @throws ApiError
    */
   public static accountControllerUpdate(
@@ -355,15 +362,20 @@ export class BeanAccountsService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        404: 'Account not found'
+      }
     });
   }
 
   /**
+   * Delete account
+   * Deletes an account (only if no transactions)
    * @param data The data for the request.
-   * @param data.id
+   * @param data.id Account UUID
    * @param data.region Region code for tenant context
-   * @returns unknown
+   * @returns void Account deleted successfully
    * @throws ApiError
    */
   public static accountControllerDelete(
@@ -375,16 +387,22 @@ export class BeanAccountsService {
       path: {
         id: data.id,
         region: data.region
+      },
+      errors: {
+        404: 'Account not found',
+        409: 'Account has transactions and cannot be deleted'
       }
     });
   }
 
   /**
+   * Close account
+   * Closes an account (Beancount Close directive)
    * @param data The data for the request.
-   * @param data.id
+   * @param data.id Account UUID
    * @param data.region Region code for tenant context
    * @param data.requestBody
-   * @returns unknown
+   * @returns AccountResponseDto Account closed successfully
    * @throws ApiError
    */
   public static accountControllerClose(
@@ -398,16 +416,22 @@ export class BeanAccountsService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        400: 'Account is already closed',
+        404: 'Account not found'
+      }
     });
   }
 
   /**
+   * Reopen account
+   * Reopens a previously closed account
    * @param data The data for the request.
-   * @param data.id
+   * @param data.id Account UUID
    * @param data.region Region code for tenant context
    * @param data.requestBody
-   * @returns unknown
+   * @returns AccountResponseDto Account reopened successfully
    * @throws ApiError
    */
   public static accountControllerReopen(
@@ -421,7 +445,11 @@ export class BeanAccountsService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        400: 'Account is not closed',
+        404: 'Account not found'
+      }
     });
   }
 }
@@ -2504,9 +2532,12 @@ export class BeanImportService {
   }
 
   /**
+   * Import a Beancount file in community format
+   * Upload a .beancount file to import. The system parses community-format paths, converts to internal format using category metadata, auto-creates accounts, and imports transactions with deduplication. Maximum file size: 50MB. Only 1 import per user at a time.
    * @param data The data for the request.
    * @param data.region Region code for tenant context
-   * @returns unknown
+   * @param data.formData Beancount file to import
+   * @returns unknown Beancount file imported successfully
    * @throws ApiError
    */
   public static fileImportControllerImportBeancount(
@@ -2517,6 +2548,11 @@ export class BeanImportService {
       url: '/api/v1/{region}/bean/import/beancount',
       path: {
         region: data.region
+      },
+      formData: data.formData,
+      mediaType: 'multipart/form-data',
+      errors: {
+        400: 'Bad request - invalid file or no file uploaded'
       }
     });
   }
@@ -2719,11 +2755,33 @@ export class BeanPlatformsService {
 
 export class ProviderSyncService {
   /**
+   * Sync transactions from financial data provider
+   *
+   * Accepts raw transactions from external financial data providers, transforms them to Beancount format, and processes them through the ingestion pipeline.
+   *
+   * **Supported Providers:**
+   * - **plaid**: Plaid API (US, Canada, Europe)
+   * - **teller**: Teller API (US)
+   * - **truelayer**: TrueLayer Open Banking (UK, Europe)
+   * - **gocardless**: GoCardless Bank Account Data (Europe)
+   * - **simplefin**: SimpleFIN (Self-hosted)
+   * - **yodlee**: Yodlee (Global)
+   * - **beancount-direct**: Beancount format transactions
+   * - **parsed-bill**: Client-side parsed bill transactions
+   *
+   * **Processing Flow:**
+   * 1. Transform raw data via provider adapter
+   * 2. Validate transaction format
+   * 3. Deduplicate using originalId
+   * 4. Classify using rule engine
+   * 5. Route low-confidence to Review Center
+   * 6. Persist validated transactions
+   *
    * @param data The data for the request.
-   * @param data.providerName
+   * @param data.providerName Provider name
    * @param data.region Region code for tenant context
    * @param data.requestBody
-   * @returns unknown
+   * @returns ProviderSyncResponseDto Sync completed successfully
    * @throws ApiError
    */
   public static providerSyncControllerSync(
@@ -2737,7 +2795,12 @@ export class ProviderSyncService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        400: 'Invalid request data',
+        401: 'Missing or invalid authentication',
+        404: 'Provider not supported'
+      }
     });
   }
 
@@ -2867,10 +2930,12 @@ export class ImportTelemetryService {
 
 export class BeanNlpService {
   /**
+   * Process natural language input
+   * Parse natural language text (Chinese/English) describing a transaction. Supports multi-turn dialogue for collecting missing information. When confidence < 0.75, returns "confirm" action requiring user verification. User can reply with confirmation words (确认/yes/ok) or provide corrections. Examples: "yesterday Starbucks spent 35 yuan", "today lunch 28 yuan", "spent $50 at Walmart"
    * @param data The data for the request.
    * @param data.region Region code for tenant context
-   * @param data.requestBody
-   * @returns unknown
+   * @param data.requestBody Natural language transaction input with optional session ID
+   * @returns NlpResponseDto NLP processing result - either created transaction or asking for more info
    * @throws ApiError
    */
   public static nlpControllerProcessNaturalLanguage(
@@ -2883,7 +2948,11 @@ export class BeanNlpService {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: 'application/json'
+      mediaType: 'application/json',
+      errors: {
+        400: 'Invalid input',
+        401: 'Unauthorized'
+      }
     });
   }