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

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,89 @@ 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
+ * Correct (supersede) a transaction
725
+ * Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
726
+ * @param data The data for the request.
727
+ * @param data.id Original transaction ID to correct
728
+ * @param data.region Region code for tenant context
729
+ * @param data.requestBody
730
+ * @returns TransactionDetailDto Corrected transaction created
731
+ * @throws ApiError
732
+ */
733
+ static transactionControllerCorrect(data) {
734
+ return request(OpenAPI, {
735
+ method: "POST",
736
+ url: "/api/v1/{region}/bean/transactions/{id}/correct",
737
+ path: {
738
+ id: data.id,
739
+ region: data.region
740
+ },
741
+ body: data.requestBody,
742
+ mediaType: "application/json",
743
+ errors: {
744
+ 404: "Original transaction not found",
745
+ 409: "Original no longer ACTIVE (concurrent modification)",
746
+ 422: "Pipeline validation failed (does not balance, invalid accounts)"
747
+ }
748
+ });
749
+ }
750
+ /**
751
+ * Suggest transaction tags
752
+ * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
753
+ * @param data The data for the request.
754
+ * @param data.region Region code for tenant context
755
+ * @param data.q Prefix match, case-insensitive (max 50 chars)
756
+ * @param data.sort usage (default) or name
757
+ * @param data.limit Max suggestions (1-100, default 10)
758
+ * @returns TagSuggestionsResponseDto Tag suggestions
759
+ * @throws ApiError
760
+ */
761
+ static transactionControllerSuggestTags(data) {
762
+ return request(OpenAPI, {
763
+ method: "GET",
764
+ url: "/api/v1/{region}/bean/transactions/tags",
765
+ path: {
766
+ region: data.region
767
+ },
768
+ query: {
769
+ q: data.q,
770
+ sort: data.sort,
771
+ limit: data.limit
772
+ },
773
+ errors: {
774
+ 400: "Validation failed",
775
+ 401: "Authentication required"
709
776
  }
710
777
  });
711
778
  }
@@ -760,17 +827,26 @@ var BeanTransactionsService = class {
760
827
  });
761
828
  }
762
829
  /**
830
+ * Void transaction
831
+ * Soft-deletes a transaction by marking it as VOIDED
763
832
  * @param data The data for the request.
833
+ * @param data.id Transaction ID
764
834
  * @param data.region Region code for tenant context
765
- * @returns void
835
+ * @returns void Transaction voided successfully
766
836
  * @throws ApiError
767
837
  */
768
- static transactionController1(data) {
838
+ static transactionControllerDelete(data) {
769
839
  return request(OpenAPI, {
770
840
  method: "DELETE",
771
841
  url: "/api/v1/{region}/bean/transactions/{id}",
772
842
  path: {
843
+ id: data.id,
773
844
  region: data.region
845
+ },
846
+ errors: {
847
+ 400: "Transaction already voided",
848
+ 401: "Authentication required",
849
+ 404: "Transaction not found"
774
850
  }
775
851
  });
776
852
  }
@@ -781,7 +857,7 @@ var BeanBalancesService = class {
781
857
  * Calculate account balance at a specific date for a single currency
782
858
  * @param data The data for the request.
783
859
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
784
- * @param data.region Region code (cn, us, de)
860
+ * @param data.region Region code for tenant context
785
861
  * @param data.date Date to calculate balance at (ISO 8601 format)
786
862
  * @param data.currency Currency to query (e.g., "USD", "CNY")
787
863
  * @returns BalanceResponseDto Balance calculated successfully
@@ -809,7 +885,7 @@ var BeanBalancesService = class {
809
885
  * Query multi-currency account balance
810
886
  * Calculate account balances for all currencies at a specific date
811
887
  * @param data The data for the request.
812
- * @param data.region Region code (cn, us, de)
888
+ * @param data.region Region code for tenant context
813
889
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
814
890
  * @throws ApiError
815
891
  */
@@ -829,17 +905,26 @@ var BeanBalancesService = class {
829
905
  };
830
906
  var BeanCommoditiesService = class {
831
907
  /**
908
+ * Create a new commodity
909
+ * Creates a new commodity definition for the authenticated user
832
910
  * @param data The data for the request.
833
- * @param data.region Region code (cn, us, de)
834
- * @returns unknown
911
+ * @param data.region Region code for tenant context
912
+ * @param data.requestBody
913
+ * @returns CommodityResponseDto Commodity created successfully
835
914
  * @throws ApiError
836
915
  */
837
- static commodityController(data) {
916
+ static commodityControllerCreate(data) {
838
917
  return request(OpenAPI, {
839
918
  method: "POST",
840
919
  url: "/api/v1/{region}/bean/commodities",
841
920
  path: {
842
921
  region: data.region
922
+ },
923
+ body: data.requestBody,
924
+ mediaType: "application/json",
925
+ errors: {
926
+ 400: "Invalid input data",
927
+ 409: "Commodity already exists"
843
928
  }
844
929
  });
845
930
  }
@@ -847,7 +932,7 @@ var BeanCommoditiesService = class {
847
932
  * List user commodities
848
933
  * Returns all commodity definitions for the authenticated user with optional filtering
849
934
  * @param data The data for the request.
850
- * @param data.region Region code (cn, us, de)
935
+ * @param data.region Region code for tenant context
851
936
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
852
937
  * @param data.symbol Filter by exact symbol match
853
938
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -871,7 +956,7 @@ var BeanCommoditiesService = class {
871
956
  * Returns a specific commodity definition by its symbol
872
957
  * @param data The data for the request.
873
958
  * @param data.symbol Commodity symbol
874
- * @param data.region Region code (cn, us, de)
959
+ * @param data.region Region code for tenant context
875
960
  * @returns CommodityResponseDto Commodity retrieved successfully
876
961
  * @throws ApiError
877
962
  */
@@ -889,57 +974,81 @@ var BeanCommoditiesService = class {
889
974
  });
890
975
  }
891
976
  /**
977
+ * Update commodity
978
+ * Updates an existing commodity definition. Symbol cannot be changed.
892
979
  * @param data The data for the request.
893
- * @param data.region Region code (cn, us, de)
894
- * @returns unknown
980
+ * @param data.symbol Commodity symbol
981
+ * @param data.region Region code for tenant context
982
+ * @param data.requestBody
983
+ * @returns CommodityResponseDto Commodity updated successfully
895
984
  * @throws ApiError
896
985
  */
897
- static commodityController1(data) {
986
+ static commodityControllerUpdate(data) {
898
987
  return request(OpenAPI, {
899
988
  method: "PUT",
900
989
  url: "/api/v1/{region}/bean/commodities/{symbol}",
901
990
  path: {
991
+ symbol: data.symbol,
902
992
  region: data.region
993
+ },
994
+ body: data.requestBody,
995
+ mediaType: "application/json",
996
+ errors: {
997
+ 400: "Invalid input data",
998
+ 404: "Commodity not found"
903
999
  }
904
1000
  });
905
1001
  }
906
1002
  /**
1003
+ * Delete commodity
1004
+ * Deletes a commodity definition
907
1005
  * @param data The data for the request.
908
- * @param data.region Region code (cn, us, de)
909
- * @returns void
1006
+ * @param data.symbol Commodity symbol
1007
+ * @param data.region Region code for tenant context
1008
+ * @returns void Commodity deleted successfully
910
1009
  * @throws ApiError
911
1010
  */
912
- static commodityController2(data) {
1011
+ static commodityControllerDelete(data) {
913
1012
  return request(OpenAPI, {
914
1013
  method: "DELETE",
915
1014
  url: "/api/v1/{region}/bean/commodities/{symbol}",
916
1015
  path: {
1016
+ symbol: data.symbol,
917
1017
  region: data.region
1018
+ },
1019
+ errors: {
1020
+ 404: "Commodity not found"
918
1021
  }
919
1022
  });
920
1023
  }
921
1024
  /**
1025
+ * Ensure commodity exists
1026
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
922
1027
  * @param data The data for the request.
923
- * @param data.region Region code (cn, us, de)
924
- * @returns unknown
1028
+ * @param data.symbol Commodity symbol
1029
+ * @param data.region Region code for tenant context
1030
+ * @returns CommodityResponseDto Commodity retrieved or created
925
1031
  * @throws ApiError
926
1032
  */
927
- static commodityController3(data) {
1033
+ static commodityControllerGetOrCreate(data) {
928
1034
  return request(OpenAPI, {
929
1035
  method: "POST",
930
1036
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
931
1037
  path: {
1038
+ symbol: data.symbol,
932
1039
  region: data.region
933
1040
  }
934
1041
  });
935
1042
  }
936
1043
  /**
1044
+ * Bulk create commodities
1045
+ * Creates multiple commodities from a list of symbols, useful for initialization
937
1046
  * @param data The data for the request.
938
- * @param data.region Region code (cn, us, de)
939
- * @returns unknown
1047
+ * @param data.region Region code for tenant context
1048
+ * @returns CommodityResponseDto Commodities created successfully
940
1049
  * @throws ApiError
941
1050
  */
942
- static commodityController4(data) {
1051
+ static commodityControllerBulkCreate(data) {
943
1052
  return request(OpenAPI, {
944
1053
  method: "POST",
945
1054
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -1001,7 +1110,7 @@ var ProviderSyncService = class {
1001
1110
  * Get supported providers
1002
1111
  * Returns a list of all providers supported by the sync endpoint.
1003
1112
  * @param data The data for the request.
1004
- * @param data.region Region code (cn, us, de)
1113
+ * @param data.region Region code for tenant context
1005
1114
  * @returns SupportedProvidersResponseDto List of supported providers
1006
1115
  * @throws ApiError
1007
1116
  */
@@ -1022,7 +1131,7 @@ var ProviderSyncService = class {
1022
1131
  * Returns whether a specific provider is supported.
1023
1132
  * @param data The data for the request.
1024
1133
  * @param data.providerName Provider name to check
1025
- * @param data.region Region code (cn, us, de)
1134
+ * @param data.region Region code for tenant context
1026
1135
  * @returns unknown Provider support status
1027
1136
  * @throws ApiError
1028
1137
  */
@@ -1043,18 +1152,13 @@ var ProviderSyncService = class {
1043
1152
  var HealthService = class {
1044
1153
  /**
1045
1154
  * 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
1155
  * @returns unknown Service is healthy
1049
1156
  * @throws ApiError
1050
1157
  */
1051
- static healthControllerGetHealth(data) {
1158
+ static healthControllerGetHealth() {
1052
1159
  return request(OpenAPI, {
1053
1160
  method: "GET",
1054
1161
  url: "/api/v1/health",
1055
- path: {
1056
- region: data.region
1057
- },
1058
1162
  errors: {
1059
1163
  503: "Service unavailable"
1060
1164
  }
@@ -1062,37 +1166,41 @@ var HealthService = class {
1062
1166
  }
1063
1167
  /**
1064
1168
  * Check database connection health
1065
- * @param data The data for the request.
1066
- * @param data.region Region code (cn, us, de)
1067
1169
  * @returns unknown Database is healthy
1068
1170
  * @throws ApiError
1069
1171
  */
1070
- static healthControllerCheckDatabase(data) {
1172
+ static healthControllerCheckDatabase() {
1071
1173
  return request(OpenAPI, {
1072
1174
  method: "GET",
1073
1175
  url: "/api/v1/health/database",
1074
- path: {
1075
- region: data.region
1076
- },
1077
1176
  errors: {
1078
1177
  503: "Database unavailable"
1079
1178
  }
1080
1179
  });
1081
1180
  }
1181
+ /**
1182
+ * Check OpenBB schema status
1183
+ * @returns unknown OpenBB status
1184
+ * @throws ApiError
1185
+ */
1186
+ static healthControllerCheckOpenBb() {
1187
+ return request(OpenAPI, {
1188
+ method: "GET",
1189
+ url: "/api/v1/health/openbb",
1190
+ errors: {
1191
+ 503: "OpenBB unavailable"
1192
+ }
1193
+ });
1194
+ }
1082
1195
  /**
1083
1196
  * Check Redis connection health
1084
- * @param data The data for the request.
1085
- * @param data.region Region code (cn, us, de)
1086
1197
  * @returns unknown Redis is healthy
1087
1198
  * @throws ApiError
1088
1199
  */
1089
- static healthControllerCheckRedis(data) {
1200
+ static healthControllerCheckRedis() {
1090
1201
  return request(OpenAPI, {
1091
1202
  method: "GET",
1092
1203
  url: "/api/v1/health/redis",
1093
- path: {
1094
- region: data.region
1095
- },
1096
1204
  errors: {
1097
1205
  503: "Redis unavailable"
1098
1206
  }
@@ -1100,18 +1208,13 @@ var HealthService = class {
1100
1208
  }
1101
1209
  /**
1102
1210
  * Get status of all circuit breakers
1103
- * @param data The data for the request.
1104
- * @param data.region Region code (cn, us, de)
1105
1211
  * @returns unknown Circuit breaker status
1106
1212
  * @throws ApiError
1107
1213
  */
1108
- static healthControllerGetCircuitBreakersHealth(data) {
1214
+ static healthControllerGetCircuitBreakersHealth() {
1109
1215
  return request(OpenAPI, {
1110
1216
  method: "GET",
1111
1217
  url: "/api/v1/health/circuit-breakers",
1112
- path: {
1113
- region: data.region
1114
- },
1115
1218
  errors: {
1116
1219
  401: "Unauthorized",
1117
1220
  500: "Internal error"
@@ -1122,7 +1225,6 @@ var HealthService = class {
1122
1225
  * Reset a circuit breaker to CLOSED state
1123
1226
  * @param data The data for the request.
1124
1227
  * @param data.name Circuit breaker name to reset
1125
- * @param data.region Region code (cn, us, de)
1126
1228
  * @returns unknown Circuit breaker reset successfully
1127
1229
  * @throws ApiError
1128
1230
  */
@@ -1131,8 +1233,7 @@ var HealthService = class {
1131
1233
  method: "POST",
1132
1234
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1133
1235
  path: {
1134
- name: data.name,
1135
- region: data.region
1236
+ name: data.name
1136
1237
  },
1137
1238
  errors: {
1138
1239
  401: "Unauthorized",
@@ -1142,88 +1243,18 @@ var HealthService = class {
1142
1243
  }
1143
1244
  /**
1144
1245
  * Get health check metrics and statistics
1145
- * @param data The data for the request.
1146
- * @param data.region Region code (cn, us, de)
1147
1246
  * @returns unknown Health metrics
1148
1247
  * @throws ApiError
1149
1248
  */
1150
- static healthControllerGetMetrics(data) {
1249
+ static healthControllerGetMetrics() {
1151
1250
  return request(OpenAPI, {
1152
1251
  method: "GET",
1153
1252
  url: "/api/v1/health/metrics",
1154
- path: {
1155
- region: data.region
1156
- },
1157
1253
  errors: {
1158
1254
  401: "Unauthorized"
1159
1255
  }
1160
1256
  });
1161
1257
  }
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
1258
  };
1228
1259
  // Annotate the CommonJS export names for ESM import in node:
1229
1260
  0 && (module.exports = {