@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.mjs
CHANGED
|
@@ -658,22 +658,33 @@ 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"
|
|
677
688
|
}
|
|
678
689
|
});
|
|
679
690
|
}
|
|
@@ -728,17 +739,26 @@ var BeanTransactionsService = class {
|
|
|
728
739
|
});
|
|
729
740
|
}
|
|
730
741
|
/**
|
|
742
|
+
* Void transaction
|
|
743
|
+
* Soft-deletes a transaction by marking it as VOIDED
|
|
731
744
|
* @param data The data for the request.
|
|
745
|
+
* @param data.id Transaction ID
|
|
732
746
|
* @param data.region Region code for tenant context
|
|
733
|
-
* @returns void
|
|
747
|
+
* @returns void Transaction voided successfully
|
|
734
748
|
* @throws ApiError
|
|
735
749
|
*/
|
|
736
|
-
static
|
|
750
|
+
static transactionControllerDelete(data) {
|
|
737
751
|
return request(OpenAPI, {
|
|
738
752
|
method: "DELETE",
|
|
739
753
|
url: "/api/v1/{region}/bean/transactions/{id}",
|
|
740
754
|
path: {
|
|
755
|
+
id: data.id,
|
|
741
756
|
region: data.region
|
|
757
|
+
},
|
|
758
|
+
errors: {
|
|
759
|
+
400: "Transaction already voided",
|
|
760
|
+
401: "Authentication required",
|
|
761
|
+
404: "Transaction not found"
|
|
742
762
|
}
|
|
743
763
|
});
|
|
744
764
|
}
|
|
@@ -749,7 +769,7 @@ var BeanBalancesService = class {
|
|
|
749
769
|
* Calculate account balance at a specific date for a single currency
|
|
750
770
|
* @param data The data for the request.
|
|
751
771
|
* @param data.account Account name (e.g., "Assets:Bank:Checking")
|
|
752
|
-
* @param data.region Region code
|
|
772
|
+
* @param data.region Region code for tenant context
|
|
753
773
|
* @param data.date Date to calculate balance at (ISO 8601 format)
|
|
754
774
|
* @param data.currency Currency to query (e.g., "USD", "CNY")
|
|
755
775
|
* @returns BalanceResponseDto Balance calculated successfully
|
|
@@ -777,7 +797,7 @@ var BeanBalancesService = class {
|
|
|
777
797
|
* Query multi-currency account balance
|
|
778
798
|
* Calculate account balances for all currencies at a specific date
|
|
779
799
|
* @param data The data for the request.
|
|
780
|
-
* @param data.region Region code
|
|
800
|
+
* @param data.region Region code for tenant context
|
|
781
801
|
* @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
|
|
782
802
|
* @throws ApiError
|
|
783
803
|
*/
|
|
@@ -797,17 +817,26 @@ var BeanBalancesService = class {
|
|
|
797
817
|
};
|
|
798
818
|
var BeanCommoditiesService = class {
|
|
799
819
|
/**
|
|
820
|
+
* Create a new commodity
|
|
821
|
+
* Creates a new commodity definition for the authenticated user
|
|
800
822
|
* @param data The data for the request.
|
|
801
|
-
* @param data.region Region code
|
|
802
|
-
* @
|
|
823
|
+
* @param data.region Region code for tenant context
|
|
824
|
+
* @param data.requestBody
|
|
825
|
+
* @returns CommodityResponseDto Commodity created successfully
|
|
803
826
|
* @throws ApiError
|
|
804
827
|
*/
|
|
805
|
-
static
|
|
828
|
+
static commodityControllerCreate(data) {
|
|
806
829
|
return request(OpenAPI, {
|
|
807
830
|
method: "POST",
|
|
808
831
|
url: "/api/v1/{region}/bean/commodities",
|
|
809
832
|
path: {
|
|
810
833
|
region: data.region
|
|
834
|
+
},
|
|
835
|
+
body: data.requestBody,
|
|
836
|
+
mediaType: "application/json",
|
|
837
|
+
errors: {
|
|
838
|
+
400: "Invalid input data",
|
|
839
|
+
409: "Commodity already exists"
|
|
811
840
|
}
|
|
812
841
|
});
|
|
813
842
|
}
|
|
@@ -815,7 +844,7 @@ var BeanCommoditiesService = class {
|
|
|
815
844
|
* List user commodities
|
|
816
845
|
* Returns all commodity definitions for the authenticated user with optional filtering
|
|
817
846
|
* @param data The data for the request.
|
|
818
|
-
* @param data.region Region code
|
|
847
|
+
* @param data.region Region code for tenant context
|
|
819
848
|
* @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
|
|
820
849
|
* @param data.symbol Filter by exact symbol match
|
|
821
850
|
* @returns CommodityListResponseDto Commodities retrieved successfully
|
|
@@ -839,7 +868,7 @@ var BeanCommoditiesService = class {
|
|
|
839
868
|
* Returns a specific commodity definition by its symbol
|
|
840
869
|
* @param data The data for the request.
|
|
841
870
|
* @param data.symbol Commodity symbol
|
|
842
|
-
* @param data.region Region code
|
|
871
|
+
* @param data.region Region code for tenant context
|
|
843
872
|
* @returns CommodityResponseDto Commodity retrieved successfully
|
|
844
873
|
* @throws ApiError
|
|
845
874
|
*/
|
|
@@ -857,57 +886,81 @@ var BeanCommoditiesService = class {
|
|
|
857
886
|
});
|
|
858
887
|
}
|
|
859
888
|
/**
|
|
889
|
+
* Update commodity
|
|
890
|
+
* Updates an existing commodity definition. Symbol cannot be changed.
|
|
860
891
|
* @param data The data for the request.
|
|
861
|
-
* @param data.
|
|
862
|
-
* @
|
|
892
|
+
* @param data.symbol Commodity symbol
|
|
893
|
+
* @param data.region Region code for tenant context
|
|
894
|
+
* @param data.requestBody
|
|
895
|
+
* @returns CommodityResponseDto Commodity updated successfully
|
|
863
896
|
* @throws ApiError
|
|
864
897
|
*/
|
|
865
|
-
static
|
|
898
|
+
static commodityControllerUpdate(data) {
|
|
866
899
|
return request(OpenAPI, {
|
|
867
900
|
method: "PUT",
|
|
868
901
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
869
902
|
path: {
|
|
903
|
+
symbol: data.symbol,
|
|
870
904
|
region: data.region
|
|
905
|
+
},
|
|
906
|
+
body: data.requestBody,
|
|
907
|
+
mediaType: "application/json",
|
|
908
|
+
errors: {
|
|
909
|
+
400: "Invalid input data",
|
|
910
|
+
404: "Commodity not found"
|
|
871
911
|
}
|
|
872
912
|
});
|
|
873
913
|
}
|
|
874
914
|
/**
|
|
915
|
+
* Delete commodity
|
|
916
|
+
* Deletes a commodity definition
|
|
875
917
|
* @param data The data for the request.
|
|
876
|
-
* @param data.
|
|
877
|
-
* @
|
|
918
|
+
* @param data.symbol Commodity symbol
|
|
919
|
+
* @param data.region Region code for tenant context
|
|
920
|
+
* @returns void Commodity deleted successfully
|
|
878
921
|
* @throws ApiError
|
|
879
922
|
*/
|
|
880
|
-
static
|
|
923
|
+
static commodityControllerDelete(data) {
|
|
881
924
|
return request(OpenAPI, {
|
|
882
925
|
method: "DELETE",
|
|
883
926
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
884
927
|
path: {
|
|
928
|
+
symbol: data.symbol,
|
|
885
929
|
region: data.region
|
|
930
|
+
},
|
|
931
|
+
errors: {
|
|
932
|
+
404: "Commodity not found"
|
|
886
933
|
}
|
|
887
934
|
});
|
|
888
935
|
}
|
|
889
936
|
/**
|
|
937
|
+
* Ensure commodity exists
|
|
938
|
+
* Gets existing commodity or creates it with automatic initialization from OpenBB
|
|
890
939
|
* @param data The data for the request.
|
|
891
|
-
* @param data.
|
|
892
|
-
* @
|
|
940
|
+
* @param data.symbol Commodity symbol
|
|
941
|
+
* @param data.region Region code for tenant context
|
|
942
|
+
* @returns CommodityResponseDto Commodity retrieved or created
|
|
893
943
|
* @throws ApiError
|
|
894
944
|
*/
|
|
895
|
-
static
|
|
945
|
+
static commodityControllerGetOrCreate(data) {
|
|
896
946
|
return request(OpenAPI, {
|
|
897
947
|
method: "POST",
|
|
898
948
|
url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
|
|
899
949
|
path: {
|
|
950
|
+
symbol: data.symbol,
|
|
900
951
|
region: data.region
|
|
901
952
|
}
|
|
902
953
|
});
|
|
903
954
|
}
|
|
904
955
|
/**
|
|
956
|
+
* Bulk create commodities
|
|
957
|
+
* Creates multiple commodities from a list of symbols, useful for initialization
|
|
905
958
|
* @param data The data for the request.
|
|
906
|
-
* @param data.region Region code
|
|
907
|
-
* @returns
|
|
959
|
+
* @param data.region Region code for tenant context
|
|
960
|
+
* @returns CommodityResponseDto Commodities created successfully
|
|
908
961
|
* @throws ApiError
|
|
909
962
|
*/
|
|
910
|
-
static
|
|
963
|
+
static commodityControllerBulkCreate(data) {
|
|
911
964
|
return request(OpenAPI, {
|
|
912
965
|
method: "POST",
|
|
913
966
|
url: "/api/v1/{region}/bean/commodities/bulk",
|
|
@@ -969,7 +1022,7 @@ var ProviderSyncService = class {
|
|
|
969
1022
|
* Get supported providers
|
|
970
1023
|
* Returns a list of all providers supported by the sync endpoint.
|
|
971
1024
|
* @param data The data for the request.
|
|
972
|
-
* @param data.region Region code
|
|
1025
|
+
* @param data.region Region code for tenant context
|
|
973
1026
|
* @returns SupportedProvidersResponseDto List of supported providers
|
|
974
1027
|
* @throws ApiError
|
|
975
1028
|
*/
|
|
@@ -990,7 +1043,7 @@ var ProviderSyncService = class {
|
|
|
990
1043
|
* Returns whether a specific provider is supported.
|
|
991
1044
|
* @param data The data for the request.
|
|
992
1045
|
* @param data.providerName Provider name to check
|
|
993
|
-
* @param data.region Region code
|
|
1046
|
+
* @param data.region Region code for tenant context
|
|
994
1047
|
* @returns unknown Provider support status
|
|
995
1048
|
* @throws ApiError
|
|
996
1049
|
*/
|
|
@@ -1011,18 +1064,13 @@ var ProviderSyncService = class {
|
|
|
1011
1064
|
var HealthService = class {
|
|
1012
1065
|
/**
|
|
1013
1066
|
* Basic health check for K8s/load balancer probes
|
|
1014
|
-
* @param data The data for the request.
|
|
1015
|
-
* @param data.region Region code (cn, us, de)
|
|
1016
1067
|
* @returns unknown Service is healthy
|
|
1017
1068
|
* @throws ApiError
|
|
1018
1069
|
*/
|
|
1019
|
-
static healthControllerGetHealth(
|
|
1070
|
+
static healthControllerGetHealth() {
|
|
1020
1071
|
return request(OpenAPI, {
|
|
1021
1072
|
method: "GET",
|
|
1022
1073
|
url: "/api/v1/health",
|
|
1023
|
-
path: {
|
|
1024
|
-
region: data.region
|
|
1025
|
-
},
|
|
1026
1074
|
errors: {
|
|
1027
1075
|
503: "Service unavailable"
|
|
1028
1076
|
}
|
|
@@ -1030,37 +1078,41 @@ var HealthService = class {
|
|
|
1030
1078
|
}
|
|
1031
1079
|
/**
|
|
1032
1080
|
* Check database connection health
|
|
1033
|
-
* @param data The data for the request.
|
|
1034
|
-
* @param data.region Region code (cn, us, de)
|
|
1035
1081
|
* @returns unknown Database is healthy
|
|
1036
1082
|
* @throws ApiError
|
|
1037
1083
|
*/
|
|
1038
|
-
static healthControllerCheckDatabase(
|
|
1084
|
+
static healthControllerCheckDatabase() {
|
|
1039
1085
|
return request(OpenAPI, {
|
|
1040
1086
|
method: "GET",
|
|
1041
1087
|
url: "/api/v1/health/database",
|
|
1042
|
-
path: {
|
|
1043
|
-
region: data.region
|
|
1044
|
-
},
|
|
1045
1088
|
errors: {
|
|
1046
1089
|
503: "Database unavailable"
|
|
1047
1090
|
}
|
|
1048
1091
|
});
|
|
1049
1092
|
}
|
|
1093
|
+
/**
|
|
1094
|
+
* Check OpenBB schema status
|
|
1095
|
+
* @returns unknown OpenBB status
|
|
1096
|
+
* @throws ApiError
|
|
1097
|
+
*/
|
|
1098
|
+
static healthControllerCheckOpenBb() {
|
|
1099
|
+
return request(OpenAPI, {
|
|
1100
|
+
method: "GET",
|
|
1101
|
+
url: "/api/v1/health/openbb",
|
|
1102
|
+
errors: {
|
|
1103
|
+
503: "OpenBB unavailable"
|
|
1104
|
+
}
|
|
1105
|
+
});
|
|
1106
|
+
}
|
|
1050
1107
|
/**
|
|
1051
1108
|
* Check Redis connection health
|
|
1052
|
-
* @param data The data for the request.
|
|
1053
|
-
* @param data.region Region code (cn, us, de)
|
|
1054
1109
|
* @returns unknown Redis is healthy
|
|
1055
1110
|
* @throws ApiError
|
|
1056
1111
|
*/
|
|
1057
|
-
static healthControllerCheckRedis(
|
|
1112
|
+
static healthControllerCheckRedis() {
|
|
1058
1113
|
return request(OpenAPI, {
|
|
1059
1114
|
method: "GET",
|
|
1060
1115
|
url: "/api/v1/health/redis",
|
|
1061
|
-
path: {
|
|
1062
|
-
region: data.region
|
|
1063
|
-
},
|
|
1064
1116
|
errors: {
|
|
1065
1117
|
503: "Redis unavailable"
|
|
1066
1118
|
}
|
|
@@ -1068,18 +1120,13 @@ var HealthService = class {
|
|
|
1068
1120
|
}
|
|
1069
1121
|
/**
|
|
1070
1122
|
* Get status of all circuit breakers
|
|
1071
|
-
* @param data The data for the request.
|
|
1072
|
-
* @param data.region Region code (cn, us, de)
|
|
1073
1123
|
* @returns unknown Circuit breaker status
|
|
1074
1124
|
* @throws ApiError
|
|
1075
1125
|
*/
|
|
1076
|
-
static healthControllerGetCircuitBreakersHealth(
|
|
1126
|
+
static healthControllerGetCircuitBreakersHealth() {
|
|
1077
1127
|
return request(OpenAPI, {
|
|
1078
1128
|
method: "GET",
|
|
1079
1129
|
url: "/api/v1/health/circuit-breakers",
|
|
1080
|
-
path: {
|
|
1081
|
-
region: data.region
|
|
1082
|
-
},
|
|
1083
1130
|
errors: {
|
|
1084
1131
|
401: "Unauthorized",
|
|
1085
1132
|
500: "Internal error"
|
|
@@ -1090,7 +1137,6 @@ var HealthService = class {
|
|
|
1090
1137
|
* Reset a circuit breaker to CLOSED state
|
|
1091
1138
|
* @param data The data for the request.
|
|
1092
1139
|
* @param data.name Circuit breaker name to reset
|
|
1093
|
-
* @param data.region Region code (cn, us, de)
|
|
1094
1140
|
* @returns unknown Circuit breaker reset successfully
|
|
1095
1141
|
* @throws ApiError
|
|
1096
1142
|
*/
|
|
@@ -1099,8 +1145,7 @@ var HealthService = class {
|
|
|
1099
1145
|
method: "POST",
|
|
1100
1146
|
url: "/api/v1/health/circuit-breakers/{name}/reset",
|
|
1101
1147
|
path: {
|
|
1102
|
-
name: data.name
|
|
1103
|
-
region: data.region
|
|
1148
|
+
name: data.name
|
|
1104
1149
|
},
|
|
1105
1150
|
errors: {
|
|
1106
1151
|
401: "Unauthorized",
|
|
@@ -1110,88 +1155,18 @@ var HealthService = class {
|
|
|
1110
1155
|
}
|
|
1111
1156
|
/**
|
|
1112
1157
|
* Get health check metrics and statistics
|
|
1113
|
-
* @param data The data for the request.
|
|
1114
|
-
* @param data.region Region code (cn, us, de)
|
|
1115
1158
|
* @returns unknown Health metrics
|
|
1116
1159
|
* @throws ApiError
|
|
1117
1160
|
*/
|
|
1118
|
-
static healthControllerGetMetrics(
|
|
1161
|
+
static healthControllerGetMetrics() {
|
|
1119
1162
|
return request(OpenAPI, {
|
|
1120
1163
|
method: "GET",
|
|
1121
1164
|
url: "/api/v1/health/metrics",
|
|
1122
|
-
path: {
|
|
1123
|
-
region: data.region
|
|
1124
|
-
},
|
|
1125
1165
|
errors: {
|
|
1126
1166
|
401: "Unauthorized"
|
|
1127
1167
|
}
|
|
1128
1168
|
});
|
|
1129
1169
|
}
|
|
1130
|
-
/**
|
|
1131
|
-
* Check health of a specific data enhancer
|
|
1132
|
-
* @param data The data for the request.
|
|
1133
|
-
* @param data.name Data enhancer name
|
|
1134
|
-
* @param data.region Region code (cn, us, de)
|
|
1135
|
-
* @returns unknown Data enhancer is healthy
|
|
1136
|
-
* @throws ApiError
|
|
1137
|
-
*/
|
|
1138
|
-
static healthControllerGetHealthOfDataEnhancer(data) {
|
|
1139
|
-
return request(OpenAPI, {
|
|
1140
|
-
method: "GET",
|
|
1141
|
-
url: "/api/v1/health/data-enhancer/{name}",
|
|
1142
|
-
path: {
|
|
1143
|
-
name: data.name,
|
|
1144
|
-
region: data.region
|
|
1145
|
-
},
|
|
1146
|
-
errors: {
|
|
1147
|
-
401: "Unauthorized",
|
|
1148
|
-
503: "Data enhancer unavailable"
|
|
1149
|
-
}
|
|
1150
|
-
});
|
|
1151
|
-
}
|
|
1152
|
-
/**
|
|
1153
|
-
* Check health of all data providers
|
|
1154
|
-
* @param data The data for the request.
|
|
1155
|
-
* @param data.region Region code (cn, us, de)
|
|
1156
|
-
* @returns unknown Data providers health status
|
|
1157
|
-
* @throws ApiError
|
|
1158
|
-
*/
|
|
1159
|
-
static healthControllerCheckDataProviders(data) {
|
|
1160
|
-
return request(OpenAPI, {
|
|
1161
|
-
method: "GET",
|
|
1162
|
-
url: "/api/v1/health/data-providers",
|
|
1163
|
-
path: {
|
|
1164
|
-
region: data.region
|
|
1165
|
-
},
|
|
1166
|
-
errors: {
|
|
1167
|
-
401: "Unauthorized",
|
|
1168
|
-
503: "Data providers check failed"
|
|
1169
|
-
}
|
|
1170
|
-
});
|
|
1171
|
-
}
|
|
1172
|
-
/**
|
|
1173
|
-
* Check health of a specific data provider
|
|
1174
|
-
* @param data The data for the request.
|
|
1175
|
-
* @param data.dataSource Data source identifier
|
|
1176
|
-
* @param data.region Region code (cn, us, de)
|
|
1177
|
-
* @returns unknown Data provider is healthy
|
|
1178
|
-
* @throws ApiError
|
|
1179
|
-
*/
|
|
1180
|
-
static healthControllerGetHealthOfDataProvider(data) {
|
|
1181
|
-
return request(OpenAPI, {
|
|
1182
|
-
method: "GET",
|
|
1183
|
-
url: "/api/v1/health/data-provider/{dataSource}",
|
|
1184
|
-
path: {
|
|
1185
|
-
dataSource: data.dataSource,
|
|
1186
|
-
region: data.region
|
|
1187
|
-
},
|
|
1188
|
-
errors: {
|
|
1189
|
-
400: "Invalid data source",
|
|
1190
|
-
401: "Unauthorized",
|
|
1191
|
-
503: "Data provider unavailable"
|
|
1192
|
-
}
|
|
1193
|
-
});
|
|
1194
|
-
}
|
|
1195
1170
|
};
|
|
1196
1171
|
export {
|
|
1197
1172
|
BeanAccountsService,
|