@firela/api-types 0.0.0-canary.b3b7767b → 0.0.0-canary.da5984a1

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.js CHANGED
@@ -690,22 +690,62 @@ 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
- * @returns unknown
704
+ * @param data.requestBody
705
+ * @returns BatchTransactionResponseDto Transactions processed
701
706
  * @throws ApiError
702
707
  */
703
- static transactionController(data) {
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"
720
+ }
721
+ });
722
+ }
723
+ /**
724
+ * Suggest transaction tags
725
+ * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
726
+ * @param data The data for the request.
727
+ * @param data.region Region code for tenant context
728
+ * @param data.q Prefix match, case-insensitive (max 50 chars)
729
+ * @param data.sort usage (default) or name
730
+ * @param data.limit Max suggestions (1-100, default 10)
731
+ * @returns TagSuggestionsResponseDto Tag suggestions
732
+ * @throws ApiError
733
+ */
734
+ static transactionControllerSuggestTags(data) {
735
+ return request(OpenAPI, {
736
+ method: "GET",
737
+ url: "/api/v1/{region}/bean/transactions/tags",
738
+ path: {
739
+ region: data.region
740
+ },
741
+ query: {
742
+ q: data.q,
743
+ sort: data.sort,
744
+ limit: data.limit
745
+ },
746
+ errors: {
747
+ 400: "Validation failed",
748
+ 401: "Authentication required"
709
749
  }
710
750
  });
711
751
  }
@@ -760,17 +800,26 @@ var BeanTransactionsService = class {
760
800
  });
761
801
  }
762
802
  /**
803
+ * Void transaction
804
+ * Soft-deletes a transaction by marking it as VOIDED
763
805
  * @param data The data for the request.
806
+ * @param data.id Transaction ID
764
807
  * @param data.region Region code for tenant context
765
- * @returns void
808
+ * @returns void Transaction voided successfully
766
809
  * @throws ApiError
767
810
  */
768
- static transactionController1(data) {
811
+ static transactionControllerDelete(data) {
769
812
  return request(OpenAPI, {
770
813
  method: "DELETE",
771
814
  url: "/api/v1/{region}/bean/transactions/{id}",
772
815
  path: {
816
+ id: data.id,
773
817
  region: data.region
818
+ },
819
+ errors: {
820
+ 400: "Transaction already voided",
821
+ 401: "Authentication required",
822
+ 404: "Transaction not found"
774
823
  }
775
824
  });
776
825
  }
@@ -781,7 +830,7 @@ var BeanBalancesService = class {
781
830
  * Calculate account balance at a specific date for a single currency
782
831
  * @param data The data for the request.
783
832
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
784
- * @param data.region Region code (cn, us, de)
833
+ * @param data.region Region code for tenant context
785
834
  * @param data.date Date to calculate balance at (ISO 8601 format)
786
835
  * @param data.currency Currency to query (e.g., "USD", "CNY")
787
836
  * @returns BalanceResponseDto Balance calculated successfully
@@ -809,7 +858,7 @@ var BeanBalancesService = class {
809
858
  * Query multi-currency account balance
810
859
  * Calculate account balances for all currencies at a specific date
811
860
  * @param data The data for the request.
812
- * @param data.region Region code (cn, us, de)
861
+ * @param data.region Region code for tenant context
813
862
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
814
863
  * @throws ApiError
815
864
  */
@@ -829,17 +878,26 @@ var BeanBalancesService = class {
829
878
  };
830
879
  var BeanCommoditiesService = class {
831
880
  /**
881
+ * Create a new commodity
882
+ * Creates a new commodity definition for the authenticated user
832
883
  * @param data The data for the request.
833
- * @param data.region Region code (cn, us, de)
834
- * @returns unknown
884
+ * @param data.region Region code for tenant context
885
+ * @param data.requestBody
886
+ * @returns CommodityResponseDto Commodity created successfully
835
887
  * @throws ApiError
836
888
  */
837
- static commodityController(data) {
889
+ static commodityControllerCreate(data) {
838
890
  return request(OpenAPI, {
839
891
  method: "POST",
840
892
  url: "/api/v1/{region}/bean/commodities",
841
893
  path: {
842
894
  region: data.region
895
+ },
896
+ body: data.requestBody,
897
+ mediaType: "application/json",
898
+ errors: {
899
+ 400: "Invalid input data",
900
+ 409: "Commodity already exists"
843
901
  }
844
902
  });
845
903
  }
@@ -847,7 +905,7 @@ var BeanCommoditiesService = class {
847
905
  * List user commodities
848
906
  * Returns all commodity definitions for the authenticated user with optional filtering
849
907
  * @param data The data for the request.
850
- * @param data.region Region code (cn, us, de)
908
+ * @param data.region Region code for tenant context
851
909
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
852
910
  * @param data.symbol Filter by exact symbol match
853
911
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -871,7 +929,7 @@ var BeanCommoditiesService = class {
871
929
  * Returns a specific commodity definition by its symbol
872
930
  * @param data The data for the request.
873
931
  * @param data.symbol Commodity symbol
874
- * @param data.region Region code (cn, us, de)
932
+ * @param data.region Region code for tenant context
875
933
  * @returns CommodityResponseDto Commodity retrieved successfully
876
934
  * @throws ApiError
877
935
  */
@@ -889,57 +947,81 @@ var BeanCommoditiesService = class {
889
947
  });
890
948
  }
891
949
  /**
950
+ * Update commodity
951
+ * Updates an existing commodity definition. Symbol cannot be changed.
892
952
  * @param data The data for the request.
893
- * @param data.region Region code (cn, us, de)
894
- * @returns unknown
953
+ * @param data.symbol Commodity symbol
954
+ * @param data.region Region code for tenant context
955
+ * @param data.requestBody
956
+ * @returns CommodityResponseDto Commodity updated successfully
895
957
  * @throws ApiError
896
958
  */
897
- static commodityController1(data) {
959
+ static commodityControllerUpdate(data) {
898
960
  return request(OpenAPI, {
899
961
  method: "PUT",
900
962
  url: "/api/v1/{region}/bean/commodities/{symbol}",
901
963
  path: {
964
+ symbol: data.symbol,
902
965
  region: data.region
966
+ },
967
+ body: data.requestBody,
968
+ mediaType: "application/json",
969
+ errors: {
970
+ 400: "Invalid input data",
971
+ 404: "Commodity not found"
903
972
  }
904
973
  });
905
974
  }
906
975
  /**
976
+ * Delete commodity
977
+ * Deletes a commodity definition
907
978
  * @param data The data for the request.
908
- * @param data.region Region code (cn, us, de)
909
- * @returns void
979
+ * @param data.symbol Commodity symbol
980
+ * @param data.region Region code for tenant context
981
+ * @returns void Commodity deleted successfully
910
982
  * @throws ApiError
911
983
  */
912
- static commodityController2(data) {
984
+ static commodityControllerDelete(data) {
913
985
  return request(OpenAPI, {
914
986
  method: "DELETE",
915
987
  url: "/api/v1/{region}/bean/commodities/{symbol}",
916
988
  path: {
989
+ symbol: data.symbol,
917
990
  region: data.region
991
+ },
992
+ errors: {
993
+ 404: "Commodity not found"
918
994
  }
919
995
  });
920
996
  }
921
997
  /**
998
+ * Ensure commodity exists
999
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
922
1000
  * @param data The data for the request.
923
- * @param data.region Region code (cn, us, de)
924
- * @returns unknown
1001
+ * @param data.symbol Commodity symbol
1002
+ * @param data.region Region code for tenant context
1003
+ * @returns CommodityResponseDto Commodity retrieved or created
925
1004
  * @throws ApiError
926
1005
  */
927
- static commodityController3(data) {
1006
+ static commodityControllerGetOrCreate(data) {
928
1007
  return request(OpenAPI, {
929
1008
  method: "POST",
930
1009
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
931
1010
  path: {
1011
+ symbol: data.symbol,
932
1012
  region: data.region
933
1013
  }
934
1014
  });
935
1015
  }
936
1016
  /**
1017
+ * Bulk create commodities
1018
+ * Creates multiple commodities from a list of symbols, useful for initialization
937
1019
  * @param data The data for the request.
938
- * @param data.region Region code (cn, us, de)
939
- * @returns unknown
1020
+ * @param data.region Region code for tenant context
1021
+ * @returns CommodityResponseDto Commodities created successfully
940
1022
  * @throws ApiError
941
1023
  */
942
- static commodityController4(data) {
1024
+ static commodityControllerBulkCreate(data) {
943
1025
  return request(OpenAPI, {
944
1026
  method: "POST",
945
1027
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -1001,7 +1083,7 @@ var ProviderSyncService = class {
1001
1083
  * Get supported providers
1002
1084
  * Returns a list of all providers supported by the sync endpoint.
1003
1085
  * @param data The data for the request.
1004
- * @param data.region Region code (cn, us, de)
1086
+ * @param data.region Region code for tenant context
1005
1087
  * @returns SupportedProvidersResponseDto List of supported providers
1006
1088
  * @throws ApiError
1007
1089
  */
@@ -1022,7 +1104,7 @@ var ProviderSyncService = class {
1022
1104
  * Returns whether a specific provider is supported.
1023
1105
  * @param data The data for the request.
1024
1106
  * @param data.providerName Provider name to check
1025
- * @param data.region Region code (cn, us, de)
1107
+ * @param data.region Region code for tenant context
1026
1108
  * @returns unknown Provider support status
1027
1109
  * @throws ApiError
1028
1110
  */
@@ -1043,18 +1125,13 @@ var ProviderSyncService = class {
1043
1125
  var HealthService = class {
1044
1126
  /**
1045
1127
  * 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
1128
  * @returns unknown Service is healthy
1049
1129
  * @throws ApiError
1050
1130
  */
1051
- static healthControllerGetHealth(data) {
1131
+ static healthControllerGetHealth() {
1052
1132
  return request(OpenAPI, {
1053
1133
  method: "GET",
1054
1134
  url: "/api/v1/health",
1055
- path: {
1056
- region: data.region
1057
- },
1058
1135
  errors: {
1059
1136
  503: "Service unavailable"
1060
1137
  }
@@ -1062,37 +1139,41 @@ var HealthService = class {
1062
1139
  }
1063
1140
  /**
1064
1141
  * Check database connection health
1065
- * @param data The data for the request.
1066
- * @param data.region Region code (cn, us, de)
1067
1142
  * @returns unknown Database is healthy
1068
1143
  * @throws ApiError
1069
1144
  */
1070
- static healthControllerCheckDatabase(data) {
1145
+ static healthControllerCheckDatabase() {
1071
1146
  return request(OpenAPI, {
1072
1147
  method: "GET",
1073
1148
  url: "/api/v1/health/database",
1074
- path: {
1075
- region: data.region
1076
- },
1077
1149
  errors: {
1078
1150
  503: "Database unavailable"
1079
1151
  }
1080
1152
  });
1081
1153
  }
1154
+ /**
1155
+ * Check OpenBB schema status
1156
+ * @returns unknown OpenBB status
1157
+ * @throws ApiError
1158
+ */
1159
+ static healthControllerCheckOpenBb() {
1160
+ return request(OpenAPI, {
1161
+ method: "GET",
1162
+ url: "/api/v1/health/openbb",
1163
+ errors: {
1164
+ 503: "OpenBB unavailable"
1165
+ }
1166
+ });
1167
+ }
1082
1168
  /**
1083
1169
  * Check Redis connection health
1084
- * @param data The data for the request.
1085
- * @param data.region Region code (cn, us, de)
1086
1170
  * @returns unknown Redis is healthy
1087
1171
  * @throws ApiError
1088
1172
  */
1089
- static healthControllerCheckRedis(data) {
1173
+ static healthControllerCheckRedis() {
1090
1174
  return request(OpenAPI, {
1091
1175
  method: "GET",
1092
1176
  url: "/api/v1/health/redis",
1093
- path: {
1094
- region: data.region
1095
- },
1096
1177
  errors: {
1097
1178
  503: "Redis unavailable"
1098
1179
  }
@@ -1100,18 +1181,13 @@ var HealthService = class {
1100
1181
  }
1101
1182
  /**
1102
1183
  * Get status of all circuit breakers
1103
- * @param data The data for the request.
1104
- * @param data.region Region code (cn, us, de)
1105
1184
  * @returns unknown Circuit breaker status
1106
1185
  * @throws ApiError
1107
1186
  */
1108
- static healthControllerGetCircuitBreakersHealth(data) {
1187
+ static healthControllerGetCircuitBreakersHealth() {
1109
1188
  return request(OpenAPI, {
1110
1189
  method: "GET",
1111
1190
  url: "/api/v1/health/circuit-breakers",
1112
- path: {
1113
- region: data.region
1114
- },
1115
1191
  errors: {
1116
1192
  401: "Unauthorized",
1117
1193
  500: "Internal error"
@@ -1122,7 +1198,6 @@ var HealthService = class {
1122
1198
  * Reset a circuit breaker to CLOSED state
1123
1199
  * @param data The data for the request.
1124
1200
  * @param data.name Circuit breaker name to reset
1125
- * @param data.region Region code (cn, us, de)
1126
1201
  * @returns unknown Circuit breaker reset successfully
1127
1202
  * @throws ApiError
1128
1203
  */
@@ -1131,8 +1206,7 @@ var HealthService = class {
1131
1206
  method: "POST",
1132
1207
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1133
1208
  path: {
1134
- name: data.name,
1135
- region: data.region
1209
+ name: data.name
1136
1210
  },
1137
1211
  errors: {
1138
1212
  401: "Unauthorized",
@@ -1142,88 +1216,18 @@ var HealthService = class {
1142
1216
  }
1143
1217
  /**
1144
1218
  * Get health check metrics and statistics
1145
- * @param data The data for the request.
1146
- * @param data.region Region code (cn, us, de)
1147
1219
  * @returns unknown Health metrics
1148
1220
  * @throws ApiError
1149
1221
  */
1150
- static healthControllerGetMetrics(data) {
1222
+ static healthControllerGetMetrics() {
1151
1223
  return request(OpenAPI, {
1152
1224
  method: "GET",
1153
1225
  url: "/api/v1/health/metrics",
1154
- path: {
1155
- region: data.region
1156
- },
1157
1226
  errors: {
1158
1227
  401: "Unauthorized"
1159
1228
  }
1160
1229
  });
1161
1230
  }
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
1231
  };
1228
1232
  // Annotate the CommonJS export names for ESM import in node:
1229
1233
  0 && (module.exports = {