@firela/api-types 0.0.0-canary.209966 → 0.0.0-canary.32edff08

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