@firela/api-types 0.0.0-canary.209967 → 0.0.0-canary.52154bb3

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
@@ -632,8 +632,9 @@ var BeanAccountsService = class {
632
632
  };
633
633
  var BeanTransactionsService = class {
634
634
  /**
635
- * Create transaction
636
- * Creates a new double-entry transaction. Missing accounts are auto-created by default.
635
+ * @deprecated
636
+ * Create transaction (DEPRECATED)
637
+ * DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
637
638
  * @param data The data for the request.
638
639
  * @param data.region Region code for tenant context
639
640
  * @param data.requestBody Transaction data with postings
@@ -689,22 +690,89 @@ var BeanTransactionsService = class {
689
690
  accountId: data.accountId
690
691
  },
691
692
  errors: {
693
+ 400: "Validation failed",
692
694
  401: "Authentication required"
693
695
  }
694
696
  });
695
697
  }
696
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.
697
702
  * @param data The data for the request.
698
703
  * @param data.region Region code for tenant context
699
- * @returns unknown
704
+ * @param data.requestBody
705
+ * @returns BatchTransactionResponseDto Transactions processed
700
706
  * @throws ApiError
701
707
  */
702
- static transactionController(data) {
708
+ static transactionControllerCreateBatch(data) {
703
709
  return request(OpenAPI, {
704
710
  method: "POST",
705
711
  url: "/api/v1/{region}/bean/transactions/batch",
706
712
  path: {
707
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"
708
776
  }
709
777
  });
710
778
  }
@@ -759,17 +827,26 @@ var BeanTransactionsService = class {
759
827
  });
760
828
  }
761
829
  /**
830
+ * Void transaction
831
+ * Soft-deletes a transaction by marking it as VOIDED
762
832
  * @param data The data for the request.
833
+ * @param data.id Transaction ID
763
834
  * @param data.region Region code for tenant context
764
- * @returns void
835
+ * @returns void Transaction voided successfully
765
836
  * @throws ApiError
766
837
  */
767
- static transactionController1(data) {
838
+ static transactionControllerDelete(data) {
768
839
  return request(OpenAPI, {
769
840
  method: "DELETE",
770
841
  url: "/api/v1/{region}/bean/transactions/{id}",
771
842
  path: {
843
+ id: data.id,
772
844
  region: data.region
845
+ },
846
+ errors: {
847
+ 400: "Transaction already voided",
848
+ 401: "Authentication required",
849
+ 404: "Transaction not found"
773
850
  }
774
851
  });
775
852
  }
@@ -780,7 +857,7 @@ var BeanBalancesService = class {
780
857
  * Calculate account balance at a specific date for a single currency
781
858
  * @param data The data for the request.
782
859
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
783
- * @param data.region Region code (cn, us, de)
860
+ * @param data.region Region code for tenant context
784
861
  * @param data.date Date to calculate balance at (ISO 8601 format)
785
862
  * @param data.currency Currency to query (e.g., "USD", "CNY")
786
863
  * @returns BalanceResponseDto Balance calculated successfully
@@ -808,7 +885,7 @@ var BeanBalancesService = class {
808
885
  * Query multi-currency account balance
809
886
  * Calculate account balances for all currencies at a specific date
810
887
  * @param data The data for the request.
811
- * @param data.region Region code (cn, us, de)
888
+ * @param data.region Region code for tenant context
812
889
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
813
890
  * @throws ApiError
814
891
  */
@@ -828,17 +905,26 @@ var BeanBalancesService = class {
828
905
  };
829
906
  var BeanCommoditiesService = class {
830
907
  /**
908
+ * Create a new commodity
909
+ * Creates a new commodity definition for the authenticated user
831
910
  * @param data The data for the request.
832
- * @param data.region Region code (cn, us, de)
833
- * @returns unknown
911
+ * @param data.region Region code for tenant context
912
+ * @param data.requestBody
913
+ * @returns CommodityResponseDto Commodity created successfully
834
914
  * @throws ApiError
835
915
  */
836
- static commodityController(data) {
916
+ static commodityControllerCreate(data) {
837
917
  return request(OpenAPI, {
838
918
  method: "POST",
839
919
  url: "/api/v1/{region}/bean/commodities",
840
920
  path: {
841
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"
842
928
  }
843
929
  });
844
930
  }
@@ -846,7 +932,7 @@ var BeanCommoditiesService = class {
846
932
  * List user commodities
847
933
  * Returns all commodity definitions for the authenticated user with optional filtering
848
934
  * @param data The data for the request.
849
- * @param data.region Region code (cn, us, de)
935
+ * @param data.region Region code for tenant context
850
936
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
851
937
  * @param data.symbol Filter by exact symbol match
852
938
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -870,7 +956,7 @@ var BeanCommoditiesService = class {
870
956
  * Returns a specific commodity definition by its symbol
871
957
  * @param data The data for the request.
872
958
  * @param data.symbol Commodity symbol
873
- * @param data.region Region code (cn, us, de)
959
+ * @param data.region Region code for tenant context
874
960
  * @returns CommodityResponseDto Commodity retrieved successfully
875
961
  * @throws ApiError
876
962
  */
@@ -888,57 +974,81 @@ var BeanCommoditiesService = class {
888
974
  });
889
975
  }
890
976
  /**
977
+ * Update commodity
978
+ * Updates an existing commodity definition. Symbol cannot be changed.
891
979
  * @param data The data for the request.
892
- * @param data.region Region code (cn, us, de)
893
- * @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
894
984
  * @throws ApiError
895
985
  */
896
- static commodityController1(data) {
986
+ static commodityControllerUpdate(data) {
897
987
  return request(OpenAPI, {
898
988
  method: "PUT",
899
989
  url: "/api/v1/{region}/bean/commodities/{symbol}",
900
990
  path: {
991
+ symbol: data.symbol,
901
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"
902
999
  }
903
1000
  });
904
1001
  }
905
1002
  /**
1003
+ * Delete commodity
1004
+ * Deletes a commodity definition
906
1005
  * @param data The data for the request.
907
- * @param data.region Region code (cn, us, de)
908
- * @returns void
1006
+ * @param data.symbol Commodity symbol
1007
+ * @param data.region Region code for tenant context
1008
+ * @returns void Commodity deleted successfully
909
1009
  * @throws ApiError
910
1010
  */
911
- static commodityController2(data) {
1011
+ static commodityControllerDelete(data) {
912
1012
  return request(OpenAPI, {
913
1013
  method: "DELETE",
914
1014
  url: "/api/v1/{region}/bean/commodities/{symbol}",
915
1015
  path: {
1016
+ symbol: data.symbol,
916
1017
  region: data.region
1018
+ },
1019
+ errors: {
1020
+ 404: "Commodity not found"
917
1021
  }
918
1022
  });
919
1023
  }
920
1024
  /**
1025
+ * Ensure commodity exists
1026
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
921
1027
  * @param data The data for the request.
922
- * @param data.region Region code (cn, us, de)
923
- * @returns unknown
1028
+ * @param data.symbol Commodity symbol
1029
+ * @param data.region Region code for tenant context
1030
+ * @returns CommodityResponseDto Commodity retrieved or created
924
1031
  * @throws ApiError
925
1032
  */
926
- static commodityController3(data) {
1033
+ static commodityControllerGetOrCreate(data) {
927
1034
  return request(OpenAPI, {
928
1035
  method: "POST",
929
1036
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
930
1037
  path: {
1038
+ symbol: data.symbol,
931
1039
  region: data.region
932
1040
  }
933
1041
  });
934
1042
  }
935
1043
  /**
1044
+ * Bulk create commodities
1045
+ * Creates multiple commodities from a list of symbols, useful for initialization
936
1046
  * @param data The data for the request.
937
- * @param data.region Region code (cn, us, de)
938
- * @returns unknown
1047
+ * @param data.region Region code for tenant context
1048
+ * @returns CommodityResponseDto Commodities created successfully
939
1049
  * @throws ApiError
940
1050
  */
941
- static commodityController4(data) {
1051
+ static commodityControllerBulkCreate(data) {
942
1052
  return request(OpenAPI, {
943
1053
  method: "POST",
944
1054
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -962,6 +1072,7 @@ var ProviderSyncService = class {
962
1072
  * - **simplefin**: SimpleFIN (Self-hosted)
963
1073
  * - **yodlee**: Yodlee (Global)
964
1074
  * - **beancount-direct**: Beancount format transactions
1075
+ * - **parsed-bill**: Client-side parsed bill transactions
965
1076
  *
966
1077
  * **Processing Flow:**
967
1078
  * 1. Transform raw data via provider adapter
@@ -973,7 +1084,7 @@ var ProviderSyncService = class {
973
1084
  *
974
1085
  * @param data The data for the request.
975
1086
  * @param data.providerName Provider name
976
- * @param data.region Region code
1087
+ * @param data.region Region code for tenant context
977
1088
  * @param data.requestBody
978
1089
  * @returns ProviderSyncResponseDto Sync completed successfully
979
1090
  * @throws ApiError
@@ -999,7 +1110,7 @@ var ProviderSyncService = class {
999
1110
  * Get supported providers
1000
1111
  * Returns a list of all providers supported by the sync endpoint.
1001
1112
  * @param data The data for the request.
1002
- * @param data.region Region code (cn, us, de)
1113
+ * @param data.region Region code for tenant context
1003
1114
  * @returns SupportedProvidersResponseDto List of supported providers
1004
1115
  * @throws ApiError
1005
1116
  */
@@ -1020,7 +1131,7 @@ var ProviderSyncService = class {
1020
1131
  * Returns whether a specific provider is supported.
1021
1132
  * @param data The data for the request.
1022
1133
  * @param data.providerName Provider name to check
1023
- * @param data.region Region code (cn, us, de)
1134
+ * @param data.region Region code for tenant context
1024
1135
  * @returns unknown Provider support status
1025
1136
  * @throws ApiError
1026
1137
  */
@@ -1041,18 +1152,13 @@ var ProviderSyncService = class {
1041
1152
  var HealthService = class {
1042
1153
  /**
1043
1154
  * Basic health check for K8s/load balancer probes
1044
- * @param data The data for the request.
1045
- * @param data.region Region code (cn, us, de)
1046
1155
  * @returns unknown Service is healthy
1047
1156
  * @throws ApiError
1048
1157
  */
1049
- static healthControllerGetHealth(data) {
1158
+ static healthControllerGetHealth() {
1050
1159
  return request(OpenAPI, {
1051
1160
  method: "GET",
1052
1161
  url: "/api/v1/health",
1053
- path: {
1054
- region: data.region
1055
- },
1056
1162
  errors: {
1057
1163
  503: "Service unavailable"
1058
1164
  }
@@ -1060,37 +1166,41 @@ var HealthService = class {
1060
1166
  }
1061
1167
  /**
1062
1168
  * Check database connection health
1063
- * @param data The data for the request.
1064
- * @param data.region Region code (cn, us, de)
1065
1169
  * @returns unknown Database is healthy
1066
1170
  * @throws ApiError
1067
1171
  */
1068
- static healthControllerCheckDatabase(data) {
1172
+ static healthControllerCheckDatabase() {
1069
1173
  return request(OpenAPI, {
1070
1174
  method: "GET",
1071
1175
  url: "/api/v1/health/database",
1072
- path: {
1073
- region: data.region
1074
- },
1075
1176
  errors: {
1076
1177
  503: "Database unavailable"
1077
1178
  }
1078
1179
  });
1079
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
+ }
1080
1195
  /**
1081
1196
  * Check Redis connection health
1082
- * @param data The data for the request.
1083
- * @param data.region Region code (cn, us, de)
1084
1197
  * @returns unknown Redis is healthy
1085
1198
  * @throws ApiError
1086
1199
  */
1087
- static healthControllerCheckRedis(data) {
1200
+ static healthControllerCheckRedis() {
1088
1201
  return request(OpenAPI, {
1089
1202
  method: "GET",
1090
1203
  url: "/api/v1/health/redis",
1091
- path: {
1092
- region: data.region
1093
- },
1094
1204
  errors: {
1095
1205
  503: "Redis unavailable"
1096
1206
  }
@@ -1098,18 +1208,13 @@ var HealthService = class {
1098
1208
  }
1099
1209
  /**
1100
1210
  * Get status of all circuit breakers
1101
- * @param data The data for the request.
1102
- * @param data.region Region code (cn, us, de)
1103
1211
  * @returns unknown Circuit breaker status
1104
1212
  * @throws ApiError
1105
1213
  */
1106
- static healthControllerGetCircuitBreakersHealth(data) {
1214
+ static healthControllerGetCircuitBreakersHealth() {
1107
1215
  return request(OpenAPI, {
1108
1216
  method: "GET",
1109
1217
  url: "/api/v1/health/circuit-breakers",
1110
- path: {
1111
- region: data.region
1112
- },
1113
1218
  errors: {
1114
1219
  401: "Unauthorized",
1115
1220
  500: "Internal error"
@@ -1120,7 +1225,6 @@ var HealthService = class {
1120
1225
  * Reset a circuit breaker to CLOSED state
1121
1226
  * @param data The data for the request.
1122
1227
  * @param data.name Circuit breaker name to reset
1123
- * @param data.region Region code (cn, us, de)
1124
1228
  * @returns unknown Circuit breaker reset successfully
1125
1229
  * @throws ApiError
1126
1230
  */
@@ -1129,8 +1233,7 @@ var HealthService = class {
1129
1233
  method: "POST",
1130
1234
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1131
1235
  path: {
1132
- name: data.name,
1133
- region: data.region
1236
+ name: data.name
1134
1237
  },
1135
1238
  errors: {
1136
1239
  401: "Unauthorized",
@@ -1140,88 +1243,18 @@ var HealthService = class {
1140
1243
  }
1141
1244
  /**
1142
1245
  * Get health check metrics and statistics
1143
- * @param data The data for the request.
1144
- * @param data.region Region code (cn, us, de)
1145
1246
  * @returns unknown Health metrics
1146
1247
  * @throws ApiError
1147
1248
  */
1148
- static healthControllerGetMetrics(data) {
1249
+ static healthControllerGetMetrics() {
1149
1250
  return request(OpenAPI, {
1150
1251
  method: "GET",
1151
1252
  url: "/api/v1/health/metrics",
1152
- path: {
1153
- region: data.region
1154
- },
1155
1253
  errors: {
1156
1254
  401: "Unauthorized"
1157
1255
  }
1158
1256
  });
1159
1257
  }
1160
- /**
1161
- * Check health of a specific data enhancer
1162
- * @param data The data for the request.
1163
- * @param data.name Data enhancer name
1164
- * @param data.region Region code (cn, us, de)
1165
- * @returns unknown Data enhancer is healthy
1166
- * @throws ApiError
1167
- */
1168
- static healthControllerGetHealthOfDataEnhancer(data) {
1169
- return request(OpenAPI, {
1170
- method: "GET",
1171
- url: "/api/v1/health/data-enhancer/{name}",
1172
- path: {
1173
- name: data.name,
1174
- region: data.region
1175
- },
1176
- errors: {
1177
- 401: "Unauthorized",
1178
- 503: "Data enhancer unavailable"
1179
- }
1180
- });
1181
- }
1182
- /**
1183
- * Check health of all data providers
1184
- * @param data The data for the request.
1185
- * @param data.region Region code (cn, us, de)
1186
- * @returns unknown Data providers health status
1187
- * @throws ApiError
1188
- */
1189
- static healthControllerCheckDataProviders(data) {
1190
- return request(OpenAPI, {
1191
- method: "GET",
1192
- url: "/api/v1/health/data-providers",
1193
- path: {
1194
- region: data.region
1195
- },
1196
- errors: {
1197
- 401: "Unauthorized",
1198
- 503: "Data providers check failed"
1199
- }
1200
- });
1201
- }
1202
- /**
1203
- * Check health of a specific data provider
1204
- * @param data The data for the request.
1205
- * @param data.dataSource Data source identifier
1206
- * @param data.region Region code (cn, us, de)
1207
- * @returns unknown Data provider is healthy
1208
- * @throws ApiError
1209
- */
1210
- static healthControllerGetHealthOfDataProvider(data) {
1211
- return request(OpenAPI, {
1212
- method: "GET",
1213
- url: "/api/v1/health/data-provider/{dataSource}",
1214
- path: {
1215
- dataSource: data.dataSource,
1216
- region: data.region
1217
- },
1218
- errors: {
1219
- 400: "Invalid data source",
1220
- 401: "Unauthorized",
1221
- 503: "Data provider unavailable"
1222
- }
1223
- });
1224
- }
1225
1258
  };
1226
1259
  // Annotate the CommonJS export names for ESM import in node:
1227
1260
  0 && (module.exports = {