@firela/api-types 0.0.0-canary.5639ea2d → 0.0.0-canary.614ff760
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 +2135 -771
- package/dist/index.d.ts +2135 -771
- package/dist/index.js +156 -73
- package/dist/index.mjs +156 -73
- package/package.json +2 -3
- package/src/generated/schemas.gen.ts +1748 -251
- package/src/generated/services.gen.ts +1019 -636
- package/src/generated/types.gen.ts +2303 -802
package/dist/index.mjs
CHANGED
|
@@ -658,22 +658,89 @@ var BeanTransactionsService = class {
|
|
|
658
658
|
accountId: data.accountId
|
|
659
659
|
},
|
|
660
660
|
errors: {
|
|
661
|
+
400: "Validation failed",
|
|
661
662
|
401: "Authentication required"
|
|
662
663
|
}
|
|
663
664
|
});
|
|
664
665
|
}
|
|
665
666
|
/**
|
|
667
|
+
* @deprecated
|
|
668
|
+
* Batch create transactions (DEPRECATED)
|
|
669
|
+
* DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
|
|
666
670
|
* @param data The data for the request.
|
|
667
671
|
* @param data.region Region code for tenant context
|
|
668
|
-
* @
|
|
672
|
+
* @param data.requestBody
|
|
673
|
+
* @returns BatchTransactionResponseDto Transactions processed
|
|
669
674
|
* @throws ApiError
|
|
670
675
|
*/
|
|
671
|
-
static
|
|
676
|
+
static transactionControllerCreateBatch(data) {
|
|
672
677
|
return request(OpenAPI, {
|
|
673
678
|
method: "POST",
|
|
674
679
|
url: "/api/v1/{region}/bean/transactions/batch",
|
|
675
680
|
path: {
|
|
676
681
|
region: data.region
|
|
682
|
+
},
|
|
683
|
+
body: data.requestBody,
|
|
684
|
+
mediaType: "application/json",
|
|
685
|
+
errors: {
|
|
686
|
+
400: "Invalid input",
|
|
687
|
+
401: "Authentication required"
|
|
688
|
+
}
|
|
689
|
+
});
|
|
690
|
+
}
|
|
691
|
+
/**
|
|
692
|
+
* Correct (supersede) a transaction
|
|
693
|
+
* Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
|
|
694
|
+
* @param data The data for the request.
|
|
695
|
+
* @param data.id Original transaction ID to correct
|
|
696
|
+
* @param data.region Region code for tenant context
|
|
697
|
+
* @param data.requestBody
|
|
698
|
+
* @returns TransactionDetailDto Corrected transaction created
|
|
699
|
+
* @throws ApiError
|
|
700
|
+
*/
|
|
701
|
+
static transactionControllerCorrect(data) {
|
|
702
|
+
return request(OpenAPI, {
|
|
703
|
+
method: "POST",
|
|
704
|
+
url: "/api/v1/{region}/bean/transactions/{id}/correct",
|
|
705
|
+
path: {
|
|
706
|
+
id: data.id,
|
|
707
|
+
region: data.region
|
|
708
|
+
},
|
|
709
|
+
body: data.requestBody,
|
|
710
|
+
mediaType: "application/json",
|
|
711
|
+
errors: {
|
|
712
|
+
404: "Original transaction not found",
|
|
713
|
+
409: "Original no longer ACTIVE (concurrent modification)",
|
|
714
|
+
422: "Pipeline validation failed (does not balance, invalid accounts)"
|
|
715
|
+
}
|
|
716
|
+
});
|
|
717
|
+
}
|
|
718
|
+
/**
|
|
719
|
+
* Suggest transaction tags
|
|
720
|
+
* Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
|
|
721
|
+
* @param data The data for the request.
|
|
722
|
+
* @param data.region Region code for tenant context
|
|
723
|
+
* @param data.q Prefix match, case-insensitive (max 50 chars)
|
|
724
|
+
* @param data.sort usage (default) or name
|
|
725
|
+
* @param data.limit Max suggestions (1-100, default 10)
|
|
726
|
+
* @returns TagSuggestionsResponseDto Tag suggestions
|
|
727
|
+
* @throws ApiError
|
|
728
|
+
*/
|
|
729
|
+
static transactionControllerSuggestTags(data) {
|
|
730
|
+
return request(OpenAPI, {
|
|
731
|
+
method: "GET",
|
|
732
|
+
url: "/api/v1/{region}/bean/transactions/tags",
|
|
733
|
+
path: {
|
|
734
|
+
region: data.region
|
|
735
|
+
},
|
|
736
|
+
query: {
|
|
737
|
+
q: data.q,
|
|
738
|
+
sort: data.sort,
|
|
739
|
+
limit: data.limit
|
|
740
|
+
},
|
|
741
|
+
errors: {
|
|
742
|
+
400: "Validation failed",
|
|
743
|
+
401: "Authentication required"
|
|
677
744
|
}
|
|
678
745
|
});
|
|
679
746
|
}
|
|
@@ -728,17 +795,26 @@ var BeanTransactionsService = class {
|
|
|
728
795
|
});
|
|
729
796
|
}
|
|
730
797
|
/**
|
|
798
|
+
* Void transaction
|
|
799
|
+
* Soft-deletes a transaction by marking it as VOIDED
|
|
731
800
|
* @param data The data for the request.
|
|
801
|
+
* @param data.id Transaction ID
|
|
732
802
|
* @param data.region Region code for tenant context
|
|
733
|
-
* @returns void
|
|
803
|
+
* @returns void Transaction voided successfully
|
|
734
804
|
* @throws ApiError
|
|
735
805
|
*/
|
|
736
|
-
static
|
|
806
|
+
static transactionControllerDelete(data) {
|
|
737
807
|
return request(OpenAPI, {
|
|
738
808
|
method: "DELETE",
|
|
739
809
|
url: "/api/v1/{region}/bean/transactions/{id}",
|
|
740
810
|
path: {
|
|
811
|
+
id: data.id,
|
|
741
812
|
region: data.region
|
|
813
|
+
},
|
|
814
|
+
errors: {
|
|
815
|
+
400: "Transaction already voided",
|
|
816
|
+
401: "Authentication required",
|
|
817
|
+
404: "Transaction not found"
|
|
742
818
|
}
|
|
743
819
|
});
|
|
744
820
|
}
|
|
@@ -749,6 +825,7 @@ var BeanBalancesService = class {
|
|
|
749
825
|
* Calculate account balance at a specific date for a single currency
|
|
750
826
|
* @param data The data for the request.
|
|
751
827
|
* @param data.account Account name (e.g., "Assets:Bank:Checking")
|
|
828
|
+
* @param data.region Region code for tenant context
|
|
752
829
|
* @param data.date Date to calculate balance at (ISO 8601 format)
|
|
753
830
|
* @param data.currency Currency to query (e.g., "USD", "CNY")
|
|
754
831
|
* @returns BalanceResponseDto Balance calculated successfully
|
|
@@ -758,6 +835,9 @@ var BeanBalancesService = class {
|
|
|
758
835
|
return request(OpenAPI, {
|
|
759
836
|
method: "GET",
|
|
760
837
|
url: "/api/v1/{region}/bean/balances",
|
|
838
|
+
path: {
|
|
839
|
+
region: data.region
|
|
840
|
+
},
|
|
761
841
|
query: {
|
|
762
842
|
account: data.account,
|
|
763
843
|
date: data.date,
|
|
@@ -772,13 +852,18 @@ var BeanBalancesService = class {
|
|
|
772
852
|
/**
|
|
773
853
|
* Query multi-currency account balance
|
|
774
854
|
* Calculate account balances for all currencies at a specific date
|
|
855
|
+
* @param data The data for the request.
|
|
856
|
+
* @param data.region Region code for tenant context
|
|
775
857
|
* @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
|
|
776
858
|
* @throws ApiError
|
|
777
859
|
*/
|
|
778
|
-
static balanceControllerGetMultiCurrencyBalance() {
|
|
860
|
+
static balanceControllerGetMultiCurrencyBalance(data) {
|
|
779
861
|
return request(OpenAPI, {
|
|
780
862
|
method: "GET",
|
|
781
863
|
url: "/api/v1/{region}/bean/balances/multi-currency",
|
|
864
|
+
path: {
|
|
865
|
+
region: data.region
|
|
866
|
+
},
|
|
782
867
|
errors: {
|
|
783
868
|
400: "Invalid query parameters",
|
|
784
869
|
401: "User not authenticated"
|
|
@@ -788,17 +873,26 @@ var BeanBalancesService = class {
|
|
|
788
873
|
};
|
|
789
874
|
var BeanCommoditiesService = class {
|
|
790
875
|
/**
|
|
876
|
+
* Create a new commodity
|
|
877
|
+
* Creates a new commodity definition for the authenticated user
|
|
791
878
|
* @param data The data for the request.
|
|
792
879
|
* @param data.region Region code for tenant context
|
|
793
|
-
* @
|
|
880
|
+
* @param data.requestBody
|
|
881
|
+
* @returns CommodityResponseDto Commodity created successfully
|
|
794
882
|
* @throws ApiError
|
|
795
883
|
*/
|
|
796
|
-
static
|
|
884
|
+
static commodityControllerCreate(data) {
|
|
797
885
|
return request(OpenAPI, {
|
|
798
886
|
method: "POST",
|
|
799
887
|
url: "/api/v1/{region}/bean/commodities",
|
|
800
888
|
path: {
|
|
801
889
|
region: data.region
|
|
890
|
+
},
|
|
891
|
+
body: data.requestBody,
|
|
892
|
+
mediaType: "application/json",
|
|
893
|
+
errors: {
|
|
894
|
+
400: "Invalid input data",
|
|
895
|
+
409: "Commodity already exists"
|
|
802
896
|
}
|
|
803
897
|
});
|
|
804
898
|
}
|
|
@@ -848,57 +942,81 @@ var BeanCommoditiesService = class {
|
|
|
848
942
|
});
|
|
849
943
|
}
|
|
850
944
|
/**
|
|
945
|
+
* Update commodity
|
|
946
|
+
* Updates an existing commodity definition. Symbol cannot be changed.
|
|
851
947
|
* @param data The data for the request.
|
|
948
|
+
* @param data.symbol Commodity symbol
|
|
852
949
|
* @param data.region Region code for tenant context
|
|
853
|
-
* @
|
|
950
|
+
* @param data.requestBody
|
|
951
|
+
* @returns CommodityResponseDto Commodity updated successfully
|
|
854
952
|
* @throws ApiError
|
|
855
953
|
*/
|
|
856
|
-
static
|
|
954
|
+
static commodityControllerUpdate(data) {
|
|
857
955
|
return request(OpenAPI, {
|
|
858
956
|
method: "PUT",
|
|
859
957
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
860
958
|
path: {
|
|
959
|
+
symbol: data.symbol,
|
|
861
960
|
region: data.region
|
|
961
|
+
},
|
|
962
|
+
body: data.requestBody,
|
|
963
|
+
mediaType: "application/json",
|
|
964
|
+
errors: {
|
|
965
|
+
400: "Invalid input data",
|
|
966
|
+
404: "Commodity not found"
|
|
862
967
|
}
|
|
863
968
|
});
|
|
864
969
|
}
|
|
865
970
|
/**
|
|
971
|
+
* Delete commodity
|
|
972
|
+
* Deletes a commodity definition
|
|
866
973
|
* @param data The data for the request.
|
|
974
|
+
* @param data.symbol Commodity symbol
|
|
867
975
|
* @param data.region Region code for tenant context
|
|
868
|
-
* @returns void
|
|
976
|
+
* @returns void Commodity deleted successfully
|
|
869
977
|
* @throws ApiError
|
|
870
978
|
*/
|
|
871
|
-
static
|
|
979
|
+
static commodityControllerDelete(data) {
|
|
872
980
|
return request(OpenAPI, {
|
|
873
981
|
method: "DELETE",
|
|
874
982
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
875
983
|
path: {
|
|
984
|
+
symbol: data.symbol,
|
|
876
985
|
region: data.region
|
|
986
|
+
},
|
|
987
|
+
errors: {
|
|
988
|
+
404: "Commodity not found"
|
|
877
989
|
}
|
|
878
990
|
});
|
|
879
991
|
}
|
|
880
992
|
/**
|
|
993
|
+
* Ensure commodity exists
|
|
994
|
+
* Gets existing commodity or creates it with automatic initialization from OpenBB
|
|
881
995
|
* @param data The data for the request.
|
|
996
|
+
* @param data.symbol Commodity symbol
|
|
882
997
|
* @param data.region Region code for tenant context
|
|
883
|
-
* @returns
|
|
998
|
+
* @returns CommodityResponseDto Commodity retrieved or created
|
|
884
999
|
* @throws ApiError
|
|
885
1000
|
*/
|
|
886
|
-
static
|
|
1001
|
+
static commodityControllerGetOrCreate(data) {
|
|
887
1002
|
return request(OpenAPI, {
|
|
888
1003
|
method: "POST",
|
|
889
1004
|
url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
|
|
890
1005
|
path: {
|
|
1006
|
+
symbol: data.symbol,
|
|
891
1007
|
region: data.region
|
|
892
1008
|
}
|
|
893
1009
|
});
|
|
894
1010
|
}
|
|
895
1011
|
/**
|
|
1012
|
+
* Bulk create commodities
|
|
1013
|
+
* Creates multiple commodities from a list of symbols, useful for initialization
|
|
896
1014
|
* @param data The data for the request.
|
|
897
1015
|
* @param data.region Region code for tenant context
|
|
898
|
-
* @returns
|
|
1016
|
+
* @returns CommodityResponseDto Commodities created successfully
|
|
899
1017
|
* @throws ApiError
|
|
900
1018
|
*/
|
|
901
|
-
static
|
|
1019
|
+
static commodityControllerBulkCreate(data) {
|
|
902
1020
|
return request(OpenAPI, {
|
|
903
1021
|
method: "POST",
|
|
904
1022
|
url: "/api/v1/{region}/bean/commodities/bulk",
|
|
@@ -959,13 +1077,18 @@ var ProviderSyncService = class {
|
|
|
959
1077
|
/**
|
|
960
1078
|
* Get supported providers
|
|
961
1079
|
* Returns a list of all providers supported by the sync endpoint.
|
|
1080
|
+
* @param data The data for the request.
|
|
1081
|
+
* @param data.region Region code for tenant context
|
|
962
1082
|
* @returns SupportedProvidersResponseDto List of supported providers
|
|
963
1083
|
* @throws ApiError
|
|
964
1084
|
*/
|
|
965
|
-
static providerSyncControllerGetSupportedProviders() {
|
|
1085
|
+
static providerSyncControllerGetSupportedProviders(data) {
|
|
966
1086
|
return request(OpenAPI, {
|
|
967
1087
|
method: "GET",
|
|
968
1088
|
url: "/api/v1/{region}/bean/import/provider/supported",
|
|
1089
|
+
path: {
|
|
1090
|
+
region: data.region
|
|
1091
|
+
},
|
|
969
1092
|
errors: {
|
|
970
1093
|
401: "Missing or invalid authentication"
|
|
971
1094
|
}
|
|
@@ -976,6 +1099,7 @@ var ProviderSyncService = class {
|
|
|
976
1099
|
* Returns whether a specific provider is supported.
|
|
977
1100
|
* @param data The data for the request.
|
|
978
1101
|
* @param data.providerName Provider name to check
|
|
1102
|
+
* @param data.region Region code for tenant context
|
|
979
1103
|
* @returns unknown Provider support status
|
|
980
1104
|
* @throws ApiError
|
|
981
1105
|
*/
|
|
@@ -984,7 +1108,8 @@ var ProviderSyncService = class {
|
|
|
984
1108
|
method: "GET",
|
|
985
1109
|
url: "/api/v1/{region}/bean/import/provider/{providerName}/supported",
|
|
986
1110
|
path: {
|
|
987
|
-
providerName: data.providerName
|
|
1111
|
+
providerName: data.providerName,
|
|
1112
|
+
region: data.region
|
|
988
1113
|
},
|
|
989
1114
|
errors: {
|
|
990
1115
|
401: "Missing or invalid authentication"
|
|
@@ -1021,6 +1146,20 @@ var HealthService = class {
|
|
|
1021
1146
|
}
|
|
1022
1147
|
});
|
|
1023
1148
|
}
|
|
1149
|
+
/**
|
|
1150
|
+
* Check OpenBB schema status
|
|
1151
|
+
* @returns unknown OpenBB status
|
|
1152
|
+
* @throws ApiError
|
|
1153
|
+
*/
|
|
1154
|
+
static healthControllerCheckOpenBb() {
|
|
1155
|
+
return request(OpenAPI, {
|
|
1156
|
+
method: "GET",
|
|
1157
|
+
url: "/api/v1/health/openbb",
|
|
1158
|
+
errors: {
|
|
1159
|
+
503: "OpenBB unavailable"
|
|
1160
|
+
}
|
|
1161
|
+
});
|
|
1162
|
+
}
|
|
1024
1163
|
/**
|
|
1025
1164
|
* Check Redis connection health
|
|
1026
1165
|
* @returns unknown Redis is healthy
|
|
@@ -1084,62 +1223,6 @@ var HealthService = class {
|
|
|
1084
1223
|
}
|
|
1085
1224
|
});
|
|
1086
1225
|
}
|
|
1087
|
-
/**
|
|
1088
|
-
* Check health of a specific data enhancer
|
|
1089
|
-
* @param data The data for the request.
|
|
1090
|
-
* @param data.name Data enhancer name
|
|
1091
|
-
* @returns unknown Data enhancer is healthy
|
|
1092
|
-
* @throws ApiError
|
|
1093
|
-
*/
|
|
1094
|
-
static healthControllerGetHealthOfDataEnhancer(data) {
|
|
1095
|
-
return request(OpenAPI, {
|
|
1096
|
-
method: "GET",
|
|
1097
|
-
url: "/api/v1/health/data-enhancer/{name}",
|
|
1098
|
-
path: {
|
|
1099
|
-
name: data.name
|
|
1100
|
-
},
|
|
1101
|
-
errors: {
|
|
1102
|
-
401: "Unauthorized",
|
|
1103
|
-
503: "Data enhancer unavailable"
|
|
1104
|
-
}
|
|
1105
|
-
});
|
|
1106
|
-
}
|
|
1107
|
-
/**
|
|
1108
|
-
* Check health of all data providers
|
|
1109
|
-
* @returns unknown Data providers health status
|
|
1110
|
-
* @throws ApiError
|
|
1111
|
-
*/
|
|
1112
|
-
static healthControllerCheckDataProviders() {
|
|
1113
|
-
return request(OpenAPI, {
|
|
1114
|
-
method: "GET",
|
|
1115
|
-
url: "/api/v1/health/data-providers",
|
|
1116
|
-
errors: {
|
|
1117
|
-
401: "Unauthorized",
|
|
1118
|
-
503: "Data providers check failed"
|
|
1119
|
-
}
|
|
1120
|
-
});
|
|
1121
|
-
}
|
|
1122
|
-
/**
|
|
1123
|
-
* Check health of a specific data provider
|
|
1124
|
-
* @param data The data for the request.
|
|
1125
|
-
* @param data.dataSource Data source identifier
|
|
1126
|
-
* @returns unknown Data provider is healthy
|
|
1127
|
-
* @throws ApiError
|
|
1128
|
-
*/
|
|
1129
|
-
static healthControllerGetHealthOfDataProvider(data) {
|
|
1130
|
-
return request(OpenAPI, {
|
|
1131
|
-
method: "GET",
|
|
1132
|
-
url: "/api/v1/health/data-provider/{dataSource}",
|
|
1133
|
-
path: {
|
|
1134
|
-
dataSource: data.dataSource
|
|
1135
|
-
},
|
|
1136
|
-
errors: {
|
|
1137
|
-
400: "Invalid data source",
|
|
1138
|
-
401: "Unauthorized",
|
|
1139
|
-
503: "Data provider unavailable"
|
|
1140
|
-
}
|
|
1141
|
-
});
|
|
1142
|
-
}
|
|
1143
1226
|
};
|
|
1144
1227
|
export {
|
|
1145
1228
|
BeanAccountsService,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firela/api-types",
|
|
3
|
-
"version": "0.0.0-canary.
|
|
3
|
+
"version": "0.0.0-canary.614ff760",
|
|
4
4
|
"description": "TypeScript types generated from IGN OpenAPI specification",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "FireLa Team",
|
|
@@ -24,8 +24,7 @@
|
|
|
24
24
|
"src"
|
|
25
25
|
],
|
|
26
26
|
"scripts": {
|
|
27
|
-
"
|
|
28
|
-
"generate": "npm run sync && openapi-ts",
|
|
27
|
+
"generate": "openapi-ts",
|
|
29
28
|
"build": "tsup src/index.ts --format cjs,esm --dts --clean",
|
|
30
29
|
"lint": "spectral lint openapi.yaml",
|
|
31
30
|
"prepublishOnly": "npm run generate && npm run build"
|