@firela/api-types 0.0.0-canary.f2efa2bf → 0.0.0-canary.fb3ac1dd

package/dist/index.js

@@ -454,10 +454,12 @@ var request = (config, options) => {
 // src/generated/services.gen.ts
 var BeanAccountsService = class {
   /**
+   * 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
    */
   static accountControllerCreate(data) {
@@ -468,7 +470,10 @@ var BeanAccountsService = class {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: "application/json"
+      mediaType: "application/json",
+      errors: {
+        409: "Account already exists"
+      }
     });
   }
   /**
@@ -479,7 +484,7 @@ var BeanAccountsService = class {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for path or i18nKey
+   * @param data.search Search term for account path
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully
@@ -525,11 +530,13 @@ var BeanAccountsService = class {
     });
   }
   /**
+   * 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
    */
   static accountControllerUpdate(data) {
@@ -541,14 +548,19 @@ var BeanAccountsService = class {
         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 active transactions; voided/superseded residual postings are cleaned up)
    * @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
    */
   static accountControllerDelete(data) {
@@ -558,15 +570,21 @@ var BeanAccountsService = class {
       path: {
         id: data.id,
         region: data.region
+      },
+      errors: {
+        404: "Account not found",
+        409: "Account has active 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
    */
   static accountControllerClose(data) {
@@ -578,15 +596,21 @@ var BeanAccountsService = class {
         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
    */
   static accountControllerReopen(data) {
@@ -598,7 +622,37 @@ var BeanAccountsService = class {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: "application/json"
+      mediaType: "application/json",
+      errors: {
+        400: "Account is not closed",
+        404: "Account not found"
+      }
+    });
+  }
+  /**
+   * 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
+   */
+  static accountControllerAddOpeningBalance(data) {
+    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"
+      }
     });
   }
 };
@@ -642,6 +696,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
    */
@@ -659,7 +714,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",
@@ -828,7 +884,7 @@ var BeanBalancesService = class {
    * Query account balance
    * Calculate account balance at a specific date for a single currency
    * @param data The data for the request.
-   * @param data.account Account name (e.g., "Assets:Bank:Checking")
+   * @param data.account Account name (e.g., "Assets:Checking")
    * @param data.region Region code for tenant context
    * @param data.date Date to calculate balance at (ISO 8601 format)
    * @param data.currency Currency to query (e.g., "USD", "CNY")
@@ -1032,11 +1088,33 @@ var BeanCommoditiesService = class {
 };
 var ProviderSyncService = class {
   /**
+   * 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
    */
   static providerSyncControllerSync(data) {
@@ -1048,7 +1126,12 @@ var ProviderSyncService = class {
         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"
+      }
     });
   }
   /**

package/dist/index.mjs

@@ -422,10 +422,12 @@ var request = (config, options) => {
 // src/generated/services.gen.ts
 var BeanAccountsService = class {
   /**
+   * 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
    */
   static accountControllerCreate(data) {
@@ -436,7 +438,10 @@ var BeanAccountsService = class {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: "application/json"
+      mediaType: "application/json",
+      errors: {
+        409: "Account already exists"
+      }
     });
   }
   /**
@@ -447,7 +452,7 @@ var BeanAccountsService = class {
    * @param data.type Filter by account type
    * @param data.status Filter by status
    * @param data.isCustom Filter by custom (user-created) accounts only
-   * @param data.search Search term for path or i18nKey
+   * @param data.search Search term for account path
    * @param data.limit Maximum number of results
    * @param data.offset Number of results to skip
    * @returns AccountListResponseDto Accounts retrieved successfully
@@ -493,11 +498,13 @@ var BeanAccountsService = class {
     });
   }
   /**
+   * 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
    */
   static accountControllerUpdate(data) {
@@ -509,14 +516,19 @@ var BeanAccountsService = class {
         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 active transactions; voided/superseded residual postings are cleaned up)
    * @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
    */
   static accountControllerDelete(data) {
@@ -526,15 +538,21 @@ var BeanAccountsService = class {
       path: {
         id: data.id,
         region: data.region
+      },
+      errors: {
+        404: "Account not found",
+        409: "Account has active 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
    */
   static accountControllerClose(data) {
@@ -546,15 +564,21 @@ var BeanAccountsService = class {
         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
    */
   static accountControllerReopen(data) {
@@ -566,7 +590,37 @@ var BeanAccountsService = class {
         region: data.region
       },
       body: data.requestBody,
-      mediaType: "application/json"
+      mediaType: "application/json",
+      errors: {
+        400: "Account is not closed",
+        404: "Account not found"
+      }
+    });
+  }
+  /**
+   * 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
+   */
+  static accountControllerAddOpeningBalance(data) {
+    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"
+      }
     });
   }
 };
@@ -610,6 +664,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
    */
@@ -627,7 +682,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",
@@ -796,7 +852,7 @@ var BeanBalancesService = class {
    * Query account balance
    * Calculate account balance at a specific date for a single currency
    * @param data The data for the request.
-   * @param data.account Account name (e.g., "Assets:Bank:Checking")
+   * @param data.account Account name (e.g., "Assets:Checking")
    * @param data.region Region code for tenant context
    * @param data.date Date to calculate balance at (ISO 8601 format)
    * @param data.currency Currency to query (e.g., "USD", "CNY")
@@ -1000,11 +1056,33 @@ var BeanCommoditiesService = class {
 };
 var ProviderSyncService = class {
   /**
+   * 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
    */
   static providerSyncControllerSync(data) {
@@ -1016,7 +1094,12 @@ var ProviderSyncService = class {
         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"
+      }
     });
   }
   /**

package/package.json

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