@firela/api-types 0.0.0-canary.209967 → 0.0.0-canary.6feee68d

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