@firela/api-types 0.0.0-canary.b3b7767b → 0.0.0-canary.ba0a88d9
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 +1839 -1059
- package/dist/index.d.ts +1839 -1059
- package/dist/index.js +98 -123
- package/dist/index.mjs +98 -123
- package/package.json +1 -1
- package/src/generated/schemas.gen.ts +1593 -283
- package/src/generated/services.gen.ts +875 -938
- package/src/generated/types.gen.ts +2187 -1319
package/dist/index.js
CHANGED
|
@@ -690,22 +690,33 @@ var BeanTransactionsService = class {
|
|
|
690
690
|
accountId: data.accountId
|
|
691
691
|
},
|
|
692
692
|
errors: {
|
|
693
|
+
400: "Validation failed",
|
|
693
694
|
401: "Authentication required"
|
|
694
695
|
}
|
|
695
696
|
});
|
|
696
697
|
}
|
|
697
698
|
/**
|
|
699
|
+
* @deprecated
|
|
700
|
+
* Batch create transactions (DEPRECATED)
|
|
701
|
+
* DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
|
|
698
702
|
* @param data The data for the request.
|
|
699
703
|
* @param data.region Region code for tenant context
|
|
700
|
-
* @
|
|
704
|
+
* @param data.requestBody
|
|
705
|
+
* @returns BatchTransactionResponseDto Transactions processed
|
|
701
706
|
* @throws ApiError
|
|
702
707
|
*/
|
|
703
|
-
static
|
|
708
|
+
static transactionControllerCreateBatch(data) {
|
|
704
709
|
return request(OpenAPI, {
|
|
705
710
|
method: "POST",
|
|
706
711
|
url: "/api/v1/{region}/bean/transactions/batch",
|
|
707
712
|
path: {
|
|
708
713
|
region: data.region
|
|
714
|
+
},
|
|
715
|
+
body: data.requestBody,
|
|
716
|
+
mediaType: "application/json",
|
|
717
|
+
errors: {
|
|
718
|
+
400: "Invalid input",
|
|
719
|
+
401: "Authentication required"
|
|
709
720
|
}
|
|
710
721
|
});
|
|
711
722
|
}
|
|
@@ -760,17 +771,26 @@ var BeanTransactionsService = class {
|
|
|
760
771
|
});
|
|
761
772
|
}
|
|
762
773
|
/**
|
|
774
|
+
* Void transaction
|
|
775
|
+
* Soft-deletes a transaction by marking it as VOIDED
|
|
763
776
|
* @param data The data for the request.
|
|
777
|
+
* @param data.id Transaction ID
|
|
764
778
|
* @param data.region Region code for tenant context
|
|
765
|
-
* @returns void
|
|
779
|
+
* @returns void Transaction voided successfully
|
|
766
780
|
* @throws ApiError
|
|
767
781
|
*/
|
|
768
|
-
static
|
|
782
|
+
static transactionControllerDelete(data) {
|
|
769
783
|
return request(OpenAPI, {
|
|
770
784
|
method: "DELETE",
|
|
771
785
|
url: "/api/v1/{region}/bean/transactions/{id}",
|
|
772
786
|
path: {
|
|
787
|
+
id: data.id,
|
|
773
788
|
region: data.region
|
|
789
|
+
},
|
|
790
|
+
errors: {
|
|
791
|
+
400: "Transaction already voided",
|
|
792
|
+
401: "Authentication required",
|
|
793
|
+
404: "Transaction not found"
|
|
774
794
|
}
|
|
775
795
|
});
|
|
776
796
|
}
|
|
@@ -781,7 +801,7 @@ var BeanBalancesService = class {
|
|
|
781
801
|
* Calculate account balance at a specific date for a single currency
|
|
782
802
|
* @param data The data for the request.
|
|
783
803
|
* @param data.account Account name (e.g., "Assets:Bank:Checking")
|
|
784
|
-
* @param data.region Region code
|
|
804
|
+
* @param data.region Region code for tenant context
|
|
785
805
|
* @param data.date Date to calculate balance at (ISO 8601 format)
|
|
786
806
|
* @param data.currency Currency to query (e.g., "USD", "CNY")
|
|
787
807
|
* @returns BalanceResponseDto Balance calculated successfully
|
|
@@ -809,7 +829,7 @@ var BeanBalancesService = class {
|
|
|
809
829
|
* Query multi-currency account balance
|
|
810
830
|
* Calculate account balances for all currencies at a specific date
|
|
811
831
|
* @param data The data for the request.
|
|
812
|
-
* @param data.region Region code
|
|
832
|
+
* @param data.region Region code for tenant context
|
|
813
833
|
* @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
|
|
814
834
|
* @throws ApiError
|
|
815
835
|
*/
|
|
@@ -829,17 +849,26 @@ var BeanBalancesService = class {
|
|
|
829
849
|
};
|
|
830
850
|
var BeanCommoditiesService = class {
|
|
831
851
|
/**
|
|
852
|
+
* Create a new commodity
|
|
853
|
+
* Creates a new commodity definition for the authenticated user
|
|
832
854
|
* @param data The data for the request.
|
|
833
|
-
* @param data.region Region code
|
|
834
|
-
* @
|
|
855
|
+
* @param data.region Region code for tenant context
|
|
856
|
+
* @param data.requestBody
|
|
857
|
+
* @returns CommodityResponseDto Commodity created successfully
|
|
835
858
|
* @throws ApiError
|
|
836
859
|
*/
|
|
837
|
-
static
|
|
860
|
+
static commodityControllerCreate(data) {
|
|
838
861
|
return request(OpenAPI, {
|
|
839
862
|
method: "POST",
|
|
840
863
|
url: "/api/v1/{region}/bean/commodities",
|
|
841
864
|
path: {
|
|
842
865
|
region: data.region
|
|
866
|
+
},
|
|
867
|
+
body: data.requestBody,
|
|
868
|
+
mediaType: "application/json",
|
|
869
|
+
errors: {
|
|
870
|
+
400: "Invalid input data",
|
|
871
|
+
409: "Commodity already exists"
|
|
843
872
|
}
|
|
844
873
|
});
|
|
845
874
|
}
|
|
@@ -847,7 +876,7 @@ var BeanCommoditiesService = class {
|
|
|
847
876
|
* List user commodities
|
|
848
877
|
* Returns all commodity definitions for the authenticated user with optional filtering
|
|
849
878
|
* @param data The data for the request.
|
|
850
|
-
* @param data.region Region code
|
|
879
|
+
* @param data.region Region code for tenant context
|
|
851
880
|
* @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
|
|
852
881
|
* @param data.symbol Filter by exact symbol match
|
|
853
882
|
* @returns CommodityListResponseDto Commodities retrieved successfully
|
|
@@ -871,7 +900,7 @@ var BeanCommoditiesService = class {
|
|
|
871
900
|
* Returns a specific commodity definition by its symbol
|
|
872
901
|
* @param data The data for the request.
|
|
873
902
|
* @param data.symbol Commodity symbol
|
|
874
|
-
* @param data.region Region code
|
|
903
|
+
* @param data.region Region code for tenant context
|
|
875
904
|
* @returns CommodityResponseDto Commodity retrieved successfully
|
|
876
905
|
* @throws ApiError
|
|
877
906
|
*/
|
|
@@ -889,57 +918,81 @@ var BeanCommoditiesService = class {
|
|
|
889
918
|
});
|
|
890
919
|
}
|
|
891
920
|
/**
|
|
921
|
+
* Update commodity
|
|
922
|
+
* Updates an existing commodity definition. Symbol cannot be changed.
|
|
892
923
|
* @param data The data for the request.
|
|
893
|
-
* @param data.
|
|
894
|
-
* @
|
|
924
|
+
* @param data.symbol Commodity symbol
|
|
925
|
+
* @param data.region Region code for tenant context
|
|
926
|
+
* @param data.requestBody
|
|
927
|
+
* @returns CommodityResponseDto Commodity updated successfully
|
|
895
928
|
* @throws ApiError
|
|
896
929
|
*/
|
|
897
|
-
static
|
|
930
|
+
static commodityControllerUpdate(data) {
|
|
898
931
|
return request(OpenAPI, {
|
|
899
932
|
method: "PUT",
|
|
900
933
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
901
934
|
path: {
|
|
935
|
+
symbol: data.symbol,
|
|
902
936
|
region: data.region
|
|
937
|
+
},
|
|
938
|
+
body: data.requestBody,
|
|
939
|
+
mediaType: "application/json",
|
|
940
|
+
errors: {
|
|
941
|
+
400: "Invalid input data",
|
|
942
|
+
404: "Commodity not found"
|
|
903
943
|
}
|
|
904
944
|
});
|
|
905
945
|
}
|
|
906
946
|
/**
|
|
947
|
+
* Delete commodity
|
|
948
|
+
* Deletes a commodity definition
|
|
907
949
|
* @param data The data for the request.
|
|
908
|
-
* @param data.
|
|
909
|
-
* @
|
|
950
|
+
* @param data.symbol Commodity symbol
|
|
951
|
+
* @param data.region Region code for tenant context
|
|
952
|
+
* @returns void Commodity deleted successfully
|
|
910
953
|
* @throws ApiError
|
|
911
954
|
*/
|
|
912
|
-
static
|
|
955
|
+
static commodityControllerDelete(data) {
|
|
913
956
|
return request(OpenAPI, {
|
|
914
957
|
method: "DELETE",
|
|
915
958
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
916
959
|
path: {
|
|
960
|
+
symbol: data.symbol,
|
|
917
961
|
region: data.region
|
|
962
|
+
},
|
|
963
|
+
errors: {
|
|
964
|
+
404: "Commodity not found"
|
|
918
965
|
}
|
|
919
966
|
});
|
|
920
967
|
}
|
|
921
968
|
/**
|
|
969
|
+
* Ensure commodity exists
|
|
970
|
+
* Gets existing commodity or creates it with automatic initialization from OpenBB
|
|
922
971
|
* @param data The data for the request.
|
|
923
|
-
* @param data.
|
|
924
|
-
* @
|
|
972
|
+
* @param data.symbol Commodity symbol
|
|
973
|
+
* @param data.region Region code for tenant context
|
|
974
|
+
* @returns CommodityResponseDto Commodity retrieved or created
|
|
925
975
|
* @throws ApiError
|
|
926
976
|
*/
|
|
927
|
-
static
|
|
977
|
+
static commodityControllerGetOrCreate(data) {
|
|
928
978
|
return request(OpenAPI, {
|
|
929
979
|
method: "POST",
|
|
930
980
|
url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
|
|
931
981
|
path: {
|
|
982
|
+
symbol: data.symbol,
|
|
932
983
|
region: data.region
|
|
933
984
|
}
|
|
934
985
|
});
|
|
935
986
|
}
|
|
936
987
|
/**
|
|
988
|
+
* Bulk create commodities
|
|
989
|
+
* Creates multiple commodities from a list of symbols, useful for initialization
|
|
937
990
|
* @param data The data for the request.
|
|
938
|
-
* @param data.region Region code
|
|
939
|
-
* @returns
|
|
991
|
+
* @param data.region Region code for tenant context
|
|
992
|
+
* @returns CommodityResponseDto Commodities created successfully
|
|
940
993
|
* @throws ApiError
|
|
941
994
|
*/
|
|
942
|
-
static
|
|
995
|
+
static commodityControllerBulkCreate(data) {
|
|
943
996
|
return request(OpenAPI, {
|
|
944
997
|
method: "POST",
|
|
945
998
|
url: "/api/v1/{region}/bean/commodities/bulk",
|
|
@@ -1001,7 +1054,7 @@ var ProviderSyncService = class {
|
|
|
1001
1054
|
* Get supported providers
|
|
1002
1055
|
* Returns a list of all providers supported by the sync endpoint.
|
|
1003
1056
|
* @param data The data for the request.
|
|
1004
|
-
* @param data.region Region code
|
|
1057
|
+
* @param data.region Region code for tenant context
|
|
1005
1058
|
* @returns SupportedProvidersResponseDto List of supported providers
|
|
1006
1059
|
* @throws ApiError
|
|
1007
1060
|
*/
|
|
@@ -1022,7 +1075,7 @@ var ProviderSyncService = class {
|
|
|
1022
1075
|
* Returns whether a specific provider is supported.
|
|
1023
1076
|
* @param data The data for the request.
|
|
1024
1077
|
* @param data.providerName Provider name to check
|
|
1025
|
-
* @param data.region Region code
|
|
1078
|
+
* @param data.region Region code for tenant context
|
|
1026
1079
|
* @returns unknown Provider support status
|
|
1027
1080
|
* @throws ApiError
|
|
1028
1081
|
*/
|
|
@@ -1043,18 +1096,13 @@ var ProviderSyncService = class {
|
|
|
1043
1096
|
var HealthService = class {
|
|
1044
1097
|
/**
|
|
1045
1098
|
* Basic health check for K8s/load balancer probes
|
|
1046
|
-
* @param data The data for the request.
|
|
1047
|
-
* @param data.region Region code (cn, us, de)
|
|
1048
1099
|
* @returns unknown Service is healthy
|
|
1049
1100
|
* @throws ApiError
|
|
1050
1101
|
*/
|
|
1051
|
-
static healthControllerGetHealth(
|
|
1102
|
+
static healthControllerGetHealth() {
|
|
1052
1103
|
return request(OpenAPI, {
|
|
1053
1104
|
method: "GET",
|
|
1054
1105
|
url: "/api/v1/health",
|
|
1055
|
-
path: {
|
|
1056
|
-
region: data.region
|
|
1057
|
-
},
|
|
1058
1106
|
errors: {
|
|
1059
1107
|
503: "Service unavailable"
|
|
1060
1108
|
}
|
|
@@ -1062,37 +1110,41 @@ var HealthService = class {
|
|
|
1062
1110
|
}
|
|
1063
1111
|
/**
|
|
1064
1112
|
* Check database connection health
|
|
1065
|
-
* @param data The data for the request.
|
|
1066
|
-
* @param data.region Region code (cn, us, de)
|
|
1067
1113
|
* @returns unknown Database is healthy
|
|
1068
1114
|
* @throws ApiError
|
|
1069
1115
|
*/
|
|
1070
|
-
static healthControllerCheckDatabase(
|
|
1116
|
+
static healthControllerCheckDatabase() {
|
|
1071
1117
|
return request(OpenAPI, {
|
|
1072
1118
|
method: "GET",
|
|
1073
1119
|
url: "/api/v1/health/database",
|
|
1074
|
-
path: {
|
|
1075
|
-
region: data.region
|
|
1076
|
-
},
|
|
1077
1120
|
errors: {
|
|
1078
1121
|
503: "Database unavailable"
|
|
1079
1122
|
}
|
|
1080
1123
|
});
|
|
1081
1124
|
}
|
|
1125
|
+
/**
|
|
1126
|
+
* Check OpenBB schema status
|
|
1127
|
+
* @returns unknown OpenBB status
|
|
1128
|
+
* @throws ApiError
|
|
1129
|
+
*/
|
|
1130
|
+
static healthControllerCheckOpenBb() {
|
|
1131
|
+
return request(OpenAPI, {
|
|
1132
|
+
method: "GET",
|
|
1133
|
+
url: "/api/v1/health/openbb",
|
|
1134
|
+
errors: {
|
|
1135
|
+
503: "OpenBB unavailable"
|
|
1136
|
+
}
|
|
1137
|
+
});
|
|
1138
|
+
}
|
|
1082
1139
|
/**
|
|
1083
1140
|
* Check Redis connection health
|
|
1084
|
-
* @param data The data for the request.
|
|
1085
|
-
* @param data.region Region code (cn, us, de)
|
|
1086
1141
|
* @returns unknown Redis is healthy
|
|
1087
1142
|
* @throws ApiError
|
|
1088
1143
|
*/
|
|
1089
|
-
static healthControllerCheckRedis(
|
|
1144
|
+
static healthControllerCheckRedis() {
|
|
1090
1145
|
return request(OpenAPI, {
|
|
1091
1146
|
method: "GET",
|
|
1092
1147
|
url: "/api/v1/health/redis",
|
|
1093
|
-
path: {
|
|
1094
|
-
region: data.region
|
|
1095
|
-
},
|
|
1096
1148
|
errors: {
|
|
1097
1149
|
503: "Redis unavailable"
|
|
1098
1150
|
}
|
|
@@ -1100,18 +1152,13 @@ var HealthService = class {
|
|
|
1100
1152
|
}
|
|
1101
1153
|
/**
|
|
1102
1154
|
* Get status of all circuit breakers
|
|
1103
|
-
* @param data The data for the request.
|
|
1104
|
-
* @param data.region Region code (cn, us, de)
|
|
1105
1155
|
* @returns unknown Circuit breaker status
|
|
1106
1156
|
* @throws ApiError
|
|
1107
1157
|
*/
|
|
1108
|
-
static healthControllerGetCircuitBreakersHealth(
|
|
1158
|
+
static healthControllerGetCircuitBreakersHealth() {
|
|
1109
1159
|
return request(OpenAPI, {
|
|
1110
1160
|
method: "GET",
|
|
1111
1161
|
url: "/api/v1/health/circuit-breakers",
|
|
1112
|
-
path: {
|
|
1113
|
-
region: data.region
|
|
1114
|
-
},
|
|
1115
1162
|
errors: {
|
|
1116
1163
|
401: "Unauthorized",
|
|
1117
1164
|
500: "Internal error"
|
|
@@ -1122,7 +1169,6 @@ var HealthService = class {
|
|
|
1122
1169
|
* Reset a circuit breaker to CLOSED state
|
|
1123
1170
|
* @param data The data for the request.
|
|
1124
1171
|
* @param data.name Circuit breaker name to reset
|
|
1125
|
-
* @param data.region Region code (cn, us, de)
|
|
1126
1172
|
* @returns unknown Circuit breaker reset successfully
|
|
1127
1173
|
* @throws ApiError
|
|
1128
1174
|
*/
|
|
@@ -1131,8 +1177,7 @@ var HealthService = class {
|
|
|
1131
1177
|
method: "POST",
|
|
1132
1178
|
url: "/api/v1/health/circuit-breakers/{name}/reset",
|
|
1133
1179
|
path: {
|
|
1134
|
-
name: data.name
|
|
1135
|
-
region: data.region
|
|
1180
|
+
name: data.name
|
|
1136
1181
|
},
|
|
1137
1182
|
errors: {
|
|
1138
1183
|
401: "Unauthorized",
|
|
@@ -1142,88 +1187,18 @@ var HealthService = class {
|
|
|
1142
1187
|
}
|
|
1143
1188
|
/**
|
|
1144
1189
|
* Get health check metrics and statistics
|
|
1145
|
-
* @param data The data for the request.
|
|
1146
|
-
* @param data.region Region code (cn, us, de)
|
|
1147
1190
|
* @returns unknown Health metrics
|
|
1148
1191
|
* @throws ApiError
|
|
1149
1192
|
*/
|
|
1150
|
-
static healthControllerGetMetrics(
|
|
1193
|
+
static healthControllerGetMetrics() {
|
|
1151
1194
|
return request(OpenAPI, {
|
|
1152
1195
|
method: "GET",
|
|
1153
1196
|
url: "/api/v1/health/metrics",
|
|
1154
|
-
path: {
|
|
1155
|
-
region: data.region
|
|
1156
|
-
},
|
|
1157
1197
|
errors: {
|
|
1158
1198
|
401: "Unauthorized"
|
|
1159
1199
|
}
|
|
1160
1200
|
});
|
|
1161
1201
|
}
|
|
1162
|
-
/**
|
|
1163
|
-
* Check health of a specific data enhancer
|
|
1164
|
-
* @param data The data for the request.
|
|
1165
|
-
* @param data.name Data enhancer name
|
|
1166
|
-
* @param data.region Region code (cn, us, de)
|
|
1167
|
-
* @returns unknown Data enhancer is healthy
|
|
1168
|
-
* @throws ApiError
|
|
1169
|
-
*/
|
|
1170
|
-
static healthControllerGetHealthOfDataEnhancer(data) {
|
|
1171
|
-
return request(OpenAPI, {
|
|
1172
|
-
method: "GET",
|
|
1173
|
-
url: "/api/v1/health/data-enhancer/{name}",
|
|
1174
|
-
path: {
|
|
1175
|
-
name: data.name,
|
|
1176
|
-
region: data.region
|
|
1177
|
-
},
|
|
1178
|
-
errors: {
|
|
1179
|
-
401: "Unauthorized",
|
|
1180
|
-
503: "Data enhancer unavailable"
|
|
1181
|
-
}
|
|
1182
|
-
});
|
|
1183
|
-
}
|
|
1184
|
-
/**
|
|
1185
|
-
* Check health of all data providers
|
|
1186
|
-
* @param data The data for the request.
|
|
1187
|
-
* @param data.region Region code (cn, us, de)
|
|
1188
|
-
* @returns unknown Data providers health status
|
|
1189
|
-
* @throws ApiError
|
|
1190
|
-
*/
|
|
1191
|
-
static healthControllerCheckDataProviders(data) {
|
|
1192
|
-
return request(OpenAPI, {
|
|
1193
|
-
method: "GET",
|
|
1194
|
-
url: "/api/v1/health/data-providers",
|
|
1195
|
-
path: {
|
|
1196
|
-
region: data.region
|
|
1197
|
-
},
|
|
1198
|
-
errors: {
|
|
1199
|
-
401: "Unauthorized",
|
|
1200
|
-
503: "Data providers check failed"
|
|
1201
|
-
}
|
|
1202
|
-
});
|
|
1203
|
-
}
|
|
1204
|
-
/**
|
|
1205
|
-
* Check health of a specific data provider
|
|
1206
|
-
* @param data The data for the request.
|
|
1207
|
-
* @param data.dataSource Data source identifier
|
|
1208
|
-
* @param data.region Region code (cn, us, de)
|
|
1209
|
-
* @returns unknown Data provider is healthy
|
|
1210
|
-
* @throws ApiError
|
|
1211
|
-
*/
|
|
1212
|
-
static healthControllerGetHealthOfDataProvider(data) {
|
|
1213
|
-
return request(OpenAPI, {
|
|
1214
|
-
method: "GET",
|
|
1215
|
-
url: "/api/v1/health/data-provider/{dataSource}",
|
|
1216
|
-
path: {
|
|
1217
|
-
dataSource: data.dataSource,
|
|
1218
|
-
region: data.region
|
|
1219
|
-
},
|
|
1220
|
-
errors: {
|
|
1221
|
-
400: "Invalid data source",
|
|
1222
|
-
401: "Unauthorized",
|
|
1223
|
-
503: "Data provider unavailable"
|
|
1224
|
-
}
|
|
1225
|
-
});
|
|
1226
|
-
}
|
|
1227
1202
|
};
|
|
1228
1203
|
// Annotate the CommonJS export names for ESM import in node:
|
|
1229
1204
|
0 && (module.exports = {
|