@firela/api-types 0.0.0-canary.2fbeefe9 → 0.0.0-canary.30542238
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1739 -944
- package/dist/index.d.ts +1739 -944
- package/dist/index.js +33 -5
- package/dist/index.mjs +33 -5
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +1480 -394
- package/src/generated/services.gen.ts +607 -448
- package/src/generated/types.gen.ts +4556 -874
package/dist/index.js
CHANGED
|
@@ -556,7 +556,7 @@ var BeanAccountsService = class {
|
|
|
556
556
|
}
|
|
557
557
|
/**
|
|
558
558
|
* Delete account
|
|
559
|
-
* Deletes an account (only if no transactions)
|
|
559
|
+
* Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
|
|
560
560
|
* @param data The data for the request.
|
|
561
561
|
* @param data.id Account UUID
|
|
562
562
|
* @param data.region Region code for tenant context
|
|
@@ -573,7 +573,7 @@ var BeanAccountsService = class {
|
|
|
573
573
|
},
|
|
574
574
|
errors: {
|
|
575
575
|
404: "Account not found",
|
|
576
|
-
409: "Account has transactions and cannot be deleted"
|
|
576
|
+
409: "Account has active transactions and cannot be deleted"
|
|
577
577
|
}
|
|
578
578
|
});
|
|
579
579
|
}
|
|
@@ -629,6 +629,32 @@ var BeanAccountsService = class {
|
|
|
629
629
|
}
|
|
630
630
|
});
|
|
631
631
|
}
|
|
632
|
+
/**
|
|
633
|
+
* Post an opening-balance transaction
|
|
634
|
+
* 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.
|
|
635
|
+
* @param data The data for the request.
|
|
636
|
+
* @param data.id Account UUID
|
|
637
|
+
* @param data.region Region code for tenant context
|
|
638
|
+
* @param data.requestBody
|
|
639
|
+
* @returns OpeningBalanceResultDto Opening-balance transaction created
|
|
640
|
+
* @throws ApiError
|
|
641
|
+
*/
|
|
642
|
+
static accountControllerAddOpeningBalance(data) {
|
|
643
|
+
return request(OpenAPI, {
|
|
644
|
+
method: "POST",
|
|
645
|
+
url: "/api/v1/{region}/bean/accounts/{id}/opening-balance",
|
|
646
|
+
path: {
|
|
647
|
+
id: data.id,
|
|
648
|
+
region: data.region
|
|
649
|
+
},
|
|
650
|
+
body: data.requestBody,
|
|
651
|
+
mediaType: "application/json",
|
|
652
|
+
errors: {
|
|
653
|
+
404: "Account not found",
|
|
654
|
+
409: "An opening balance already exists for this account"
|
|
655
|
+
}
|
|
656
|
+
});
|
|
657
|
+
}
|
|
632
658
|
};
|
|
633
659
|
var BeanTransactionsService = class {
|
|
634
660
|
/**
|
|
@@ -667,10 +693,11 @@ var BeanTransactionsService = class {
|
|
|
667
693
|
* @param data.offset Number of items to skip (default: 0)
|
|
668
694
|
* @param data.dateFrom Filter by start date (inclusive), format: YYYY-MM-DD
|
|
669
695
|
* @param data.dateTo Filter by end date (inclusive), format: YYYY-MM-DD
|
|
670
|
-
* @param data.status Filter by transaction status
|
|
696
|
+
* @param data.status Filter by transaction status: single value, comma-separated multi-value (e.g. VOIDED,SUPERSEDED), or ALL to include audit rows. Defaults to ACTIVE-only (ADR-0128; previously unfiltered — breaking change).
|
|
671
697
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
672
698
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
673
|
-
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an
|
|
699
|
+
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an account whose derived Group segment equals this value. Must be accompanied by flow (ADR-0126).
|
|
700
|
+
* @param data.flow Required when category is present (400 otherwise) and vice versa (ADR-0126). Restricts the category account set to the flow root (income → Income:, expense → Expenses:) and drives the per-leg sign normalization of row viewpointAmount and the summary. OpenAPI cannot express conditional requiredness — the pairing is enforced at runtime.
|
|
674
701
|
* @returns TransactionListResponseDto Transaction list
|
|
675
702
|
* @throws ApiError
|
|
676
703
|
*/
|
|
@@ -689,7 +716,8 @@ var BeanTransactionsService = class {
|
|
|
689
716
|
status: data.status,
|
|
690
717
|
search: data.search,
|
|
691
718
|
accountId: data.accountId,
|
|
692
|
-
category: data.category
|
|
719
|
+
category: data.category,
|
|
720
|
+
flow: data.flow
|
|
693
721
|
},
|
|
694
722
|
errors: {
|
|
695
723
|
400: "Validation failed",
|
package/dist/index.mjs
CHANGED
|
@@ -524,7 +524,7 @@ var BeanAccountsService = class {
|
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
526
|
* Delete account
|
|
527
|
-
* Deletes an account (only if no transactions)
|
|
527
|
+
* Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
|
|
528
528
|
* @param data The data for the request.
|
|
529
529
|
* @param data.id Account UUID
|
|
530
530
|
* @param data.region Region code for tenant context
|
|
@@ -541,7 +541,7 @@ var BeanAccountsService = class {
|
|
|
541
541
|
},
|
|
542
542
|
errors: {
|
|
543
543
|
404: "Account not found",
|
|
544
|
-
409: "Account has transactions and cannot be deleted"
|
|
544
|
+
409: "Account has active transactions and cannot be deleted"
|
|
545
545
|
}
|
|
546
546
|
});
|
|
547
547
|
}
|
|
@@ -597,6 +597,32 @@ var BeanAccountsService = class {
|
|
|
597
597
|
}
|
|
598
598
|
});
|
|
599
599
|
}
|
|
600
|
+
/**
|
|
601
|
+
* Post an opening-balance transaction
|
|
602
|
+
* 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.
|
|
603
|
+
* @param data The data for the request.
|
|
604
|
+
* @param data.id Account UUID
|
|
605
|
+
* @param data.region Region code for tenant context
|
|
606
|
+
* @param data.requestBody
|
|
607
|
+
* @returns OpeningBalanceResultDto Opening-balance transaction created
|
|
608
|
+
* @throws ApiError
|
|
609
|
+
*/
|
|
610
|
+
static accountControllerAddOpeningBalance(data) {
|
|
611
|
+
return request(OpenAPI, {
|
|
612
|
+
method: "POST",
|
|
613
|
+
url: "/api/v1/{region}/bean/accounts/{id}/opening-balance",
|
|
614
|
+
path: {
|
|
615
|
+
id: data.id,
|
|
616
|
+
region: data.region
|
|
617
|
+
},
|
|
618
|
+
body: data.requestBody,
|
|
619
|
+
mediaType: "application/json",
|
|
620
|
+
errors: {
|
|
621
|
+
404: "Account not found",
|
|
622
|
+
409: "An opening balance already exists for this account"
|
|
623
|
+
}
|
|
624
|
+
});
|
|
625
|
+
}
|
|
600
626
|
};
|
|
601
627
|
var BeanTransactionsService = class {
|
|
602
628
|
/**
|
|
@@ -635,10 +661,11 @@ var BeanTransactionsService = class {
|
|
|
635
661
|
* @param data.offset Number of items to skip (default: 0)
|
|
636
662
|
* @param data.dateFrom Filter by start date (inclusive), format: YYYY-MM-DD
|
|
637
663
|
* @param data.dateTo Filter by end date (inclusive), format: YYYY-MM-DD
|
|
638
|
-
* @param data.status Filter by transaction status
|
|
664
|
+
* @param data.status Filter by transaction status: single value, comma-separated multi-value (e.g. VOIDED,SUPERSEDED), or ALL to include audit rows. Defaults to ACTIVE-only (ADR-0128; previously unfiltered — breaking change).
|
|
639
665
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
640
666
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
641
|
-
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an
|
|
667
|
+
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an account whose derived Group segment equals this value. Must be accompanied by flow (ADR-0126).
|
|
668
|
+
* @param data.flow Required when category is present (400 otherwise) and vice versa (ADR-0126). Restricts the category account set to the flow root (income → Income:, expense → Expenses:) and drives the per-leg sign normalization of row viewpointAmount and the summary. OpenAPI cannot express conditional requiredness — the pairing is enforced at runtime.
|
|
642
669
|
* @returns TransactionListResponseDto Transaction list
|
|
643
670
|
* @throws ApiError
|
|
644
671
|
*/
|
|
@@ -657,7 +684,8 @@ var BeanTransactionsService = class {
|
|
|
657
684
|
status: data.status,
|
|
658
685
|
search: data.search,
|
|
659
686
|
accountId: data.accountId,
|
|
660
|
-
category: data.category
|
|
687
|
+
category: data.category,
|
|
688
|
+
flow: data.flow
|
|
661
689
|
},
|
|
662
690
|
errors: {
|
|
663
691
|
400: "Validation failed",
|