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

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"
+      }
     });
   }
   /**
@@ -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 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
    */
   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 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,11 @@ 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"
+      }
     });
   }
 };
@@ -1032,11 +1060,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 +1098,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"
+      }
     });
   }
   /**
@@ -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 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
    */
   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 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,11 @@ 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"
+      }
     });
   }
 };
@@ -1000,11 +1028,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 +1066,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.ebb51de2",
+  "version": "0.0.0-canary.efbd2b9a",
   "description": "TypeScript types generated from IGN OpenAPI specification",
   "license": "MIT",
   "author": "FireLa Team",