@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.mjs CHANGED
@@ -658,22 +658,89 @@ var BeanTransactionsService = class {
658
658
  accountId: data.accountId
659
659
  },
660
660
  errors: {
661
+ 400: "Validation failed",
661
662
  401: "Authentication required"
662
663
  }
663
664
  });
664
665
  }
665
666
  /**
667
+ * @deprecated
668
+ * Batch create transactions (DEPRECATED)
669
+ * DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
666
670
  * @param data The data for the request.
667
671
  * @param data.region Region code for tenant context
668
- * @returns unknown
672
+ * @param data.requestBody
673
+ * @returns BatchTransactionResponseDto Transactions processed
669
674
  * @throws ApiError
670
675
  */
671
- static transactionController(data) {
676
+ static transactionControllerCreateBatch(data) {
672
677
  return request(OpenAPI, {
673
678
  method: "POST",
674
679
  url: "/api/v1/{region}/bean/transactions/batch",
675
680
  path: {
676
681
  region: data.region
682
+ },
683
+ body: data.requestBody,
684
+ mediaType: "application/json",
685
+ errors: {
686
+ 400: "Invalid input",
687
+ 401: "Authentication required"
688
+ }
689
+ });
690
+ }
691
+ /**
692
+ * Correct (supersede) a transaction
693
+ * Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
694
+ * @param data The data for the request.
695
+ * @param data.id Original transaction ID to correct
696
+ * @param data.region Region code for tenant context
697
+ * @param data.requestBody
698
+ * @returns TransactionDetailDto Corrected transaction created
699
+ * @throws ApiError
700
+ */
701
+ static transactionControllerCorrect(data) {
702
+ return request(OpenAPI, {
703
+ method: "POST",
704
+ url: "/api/v1/{region}/bean/transactions/{id}/correct",
705
+ path: {
706
+ id: data.id,
707
+ region: data.region
708
+ },
709
+ body: data.requestBody,
710
+ mediaType: "application/json",
711
+ errors: {
712
+ 404: "Original transaction not found",
713
+ 409: "Original no longer ACTIVE (concurrent modification)",
714
+ 422: "Pipeline validation failed (does not balance, invalid accounts)"
715
+ }
716
+ });
717
+ }
718
+ /**
719
+ * Suggest transaction tags
720
+ * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
721
+ * @param data The data for the request.
722
+ * @param data.region Region code for tenant context
723
+ * @param data.q Prefix match, case-insensitive (max 50 chars)
724
+ * @param data.sort usage (default) or name
725
+ * @param data.limit Max suggestions (1-100, default 10)
726
+ * @returns TagSuggestionsResponseDto Tag suggestions
727
+ * @throws ApiError
728
+ */
729
+ static transactionControllerSuggestTags(data) {
730
+ return request(OpenAPI, {
731
+ method: "GET",
732
+ url: "/api/v1/{region}/bean/transactions/tags",
733
+ path: {
734
+ region: data.region
735
+ },
736
+ query: {
737
+ q: data.q,
738
+ sort: data.sort,
739
+ limit: data.limit
740
+ },
741
+ errors: {
742
+ 400: "Validation failed",
743
+ 401: "Authentication required"
677
744
  }
678
745
  });
679
746
  }
@@ -728,17 +795,26 @@ var BeanTransactionsService = class {
728
795
  });
729
796
  }
730
797
  /**
798
+ * Void transaction
799
+ * Soft-deletes a transaction by marking it as VOIDED
731
800
  * @param data The data for the request.
801
+ * @param data.id Transaction ID
732
802
  * @param data.region Region code for tenant context
733
- * @returns void
803
+ * @returns void Transaction voided successfully
734
804
  * @throws ApiError
735
805
  */
736
- static transactionController1(data) {
806
+ static transactionControllerDelete(data) {
737
807
  return request(OpenAPI, {
738
808
  method: "DELETE",
739
809
  url: "/api/v1/{region}/bean/transactions/{id}",
740
810
  path: {
811
+ id: data.id,
741
812
  region: data.region
813
+ },
814
+ errors: {
815
+ 400: "Transaction already voided",
816
+ 401: "Authentication required",
817
+ 404: "Transaction not found"
742
818
  }
743
819
  });
744
820
  }
@@ -749,7 +825,7 @@ var BeanBalancesService = class {
749
825
  * Calculate account balance at a specific date for a single currency
750
826
  * @param data The data for the request.
751
827
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
752
- * @param data.region Region code (cn, us, de)
828
+ * @param data.region Region code for tenant context
753
829
  * @param data.date Date to calculate balance at (ISO 8601 format)
754
830
  * @param data.currency Currency to query (e.g., "USD", "CNY")
755
831
  * @returns BalanceResponseDto Balance calculated successfully
@@ -777,7 +853,7 @@ var BeanBalancesService = class {
777
853
  * Query multi-currency account balance
778
854
  * Calculate account balances for all currencies at a specific date
779
855
  * @param data The data for the request.
780
- * @param data.region Region code (cn, us, de)
856
+ * @param data.region Region code for tenant context
781
857
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
782
858
  * @throws ApiError
783
859
  */
@@ -797,17 +873,26 @@ var BeanBalancesService = class {
797
873
  };
798
874
  var BeanCommoditiesService = class {
799
875
  /**
876
+ * Create a new commodity
877
+ * Creates a new commodity definition for the authenticated user
800
878
  * @param data The data for the request.
801
- * @param data.region Region code (cn, us, de)
802
- * @returns unknown
879
+ * @param data.region Region code for tenant context
880
+ * @param data.requestBody
881
+ * @returns CommodityResponseDto Commodity created successfully
803
882
  * @throws ApiError
804
883
  */
805
- static commodityController(data) {
884
+ static commodityControllerCreate(data) {
806
885
  return request(OpenAPI, {
807
886
  method: "POST",
808
887
  url: "/api/v1/{region}/bean/commodities",
809
888
  path: {
810
889
  region: data.region
890
+ },
891
+ body: data.requestBody,
892
+ mediaType: "application/json",
893
+ errors: {
894
+ 400: "Invalid input data",
895
+ 409: "Commodity already exists"
811
896
  }
812
897
  });
813
898
  }
@@ -815,7 +900,7 @@ var BeanCommoditiesService = class {
815
900
  * List user commodities
816
901
  * Returns all commodity definitions for the authenticated user with optional filtering
817
902
  * @param data The data for the request.
818
- * @param data.region Region code (cn, us, de)
903
+ * @param data.region Region code for tenant context
819
904
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
820
905
  * @param data.symbol Filter by exact symbol match
821
906
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -839,7 +924,7 @@ var BeanCommoditiesService = class {
839
924
  * Returns a specific commodity definition by its symbol
840
925
  * @param data The data for the request.
841
926
  * @param data.symbol Commodity symbol
842
- * @param data.region Region code (cn, us, de)
927
+ * @param data.region Region code for tenant context
843
928
  * @returns CommodityResponseDto Commodity retrieved successfully
844
929
  * @throws ApiError
845
930
  */
@@ -857,57 +942,81 @@ var BeanCommoditiesService = class {
857
942
  });
858
943
  }
859
944
  /**
945
+ * Update commodity
946
+ * Updates an existing commodity definition. Symbol cannot be changed.
860
947
  * @param data The data for the request.
861
- * @param data.region Region code (cn, us, de)
862
- * @returns unknown
948
+ * @param data.symbol Commodity symbol
949
+ * @param data.region Region code for tenant context
950
+ * @param data.requestBody
951
+ * @returns CommodityResponseDto Commodity updated successfully
863
952
  * @throws ApiError
864
953
  */
865
- static commodityController1(data) {
954
+ static commodityControllerUpdate(data) {
866
955
  return request(OpenAPI, {
867
956
  method: "PUT",
868
957
  url: "/api/v1/{region}/bean/commodities/{symbol}",
869
958
  path: {
959
+ symbol: data.symbol,
870
960
  region: data.region
961
+ },
962
+ body: data.requestBody,
963
+ mediaType: "application/json",
964
+ errors: {
965
+ 400: "Invalid input data",
966
+ 404: "Commodity not found"
871
967
  }
872
968
  });
873
969
  }
874
970
  /**
971
+ * Delete commodity
972
+ * Deletes a commodity definition
875
973
  * @param data The data for the request.
876
- * @param data.region Region code (cn, us, de)
877
- * @returns void
974
+ * @param data.symbol Commodity symbol
975
+ * @param data.region Region code for tenant context
976
+ * @returns void Commodity deleted successfully
878
977
  * @throws ApiError
879
978
  */
880
- static commodityController2(data) {
979
+ static commodityControllerDelete(data) {
881
980
  return request(OpenAPI, {
882
981
  method: "DELETE",
883
982
  url: "/api/v1/{region}/bean/commodities/{symbol}",
884
983
  path: {
984
+ symbol: data.symbol,
885
985
  region: data.region
986
+ },
987
+ errors: {
988
+ 404: "Commodity not found"
886
989
  }
887
990
  });
888
991
  }
889
992
  /**
993
+ * Ensure commodity exists
994
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
890
995
  * @param data The data for the request.
891
- * @param data.region Region code (cn, us, de)
892
- * @returns unknown
996
+ * @param data.symbol Commodity symbol
997
+ * @param data.region Region code for tenant context
998
+ * @returns CommodityResponseDto Commodity retrieved or created
893
999
  * @throws ApiError
894
1000
  */
895
- static commodityController3(data) {
1001
+ static commodityControllerGetOrCreate(data) {
896
1002
  return request(OpenAPI, {
897
1003
  method: "POST",
898
1004
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
899
1005
  path: {
1006
+ symbol: data.symbol,
900
1007
  region: data.region
901
1008
  }
902
1009
  });
903
1010
  }
904
1011
  /**
1012
+ * Bulk create commodities
1013
+ * Creates multiple commodities from a list of symbols, useful for initialization
905
1014
  * @param data The data for the request.
906
- * @param data.region Region code (cn, us, de)
907
- * @returns unknown
1015
+ * @param data.region Region code for tenant context
1016
+ * @returns CommodityResponseDto Commodities created successfully
908
1017
  * @throws ApiError
909
1018
  */
910
- static commodityController4(data) {
1019
+ static commodityControllerBulkCreate(data) {
911
1020
  return request(OpenAPI, {
912
1021
  method: "POST",
913
1022
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -969,7 +1078,7 @@ var ProviderSyncService = class {
969
1078
  * Get supported providers
970
1079
  * Returns a list of all providers supported by the sync endpoint.
971
1080
  * @param data The data for the request.
972
- * @param data.region Region code (cn, us, de)
1081
+ * @param data.region Region code for tenant context
973
1082
  * @returns SupportedProvidersResponseDto List of supported providers
974
1083
  * @throws ApiError
975
1084
  */
@@ -990,7 +1099,7 @@ var ProviderSyncService = class {
990
1099
  * Returns whether a specific provider is supported.
991
1100
  * @param data The data for the request.
992
1101
  * @param data.providerName Provider name to check
993
- * @param data.region Region code (cn, us, de)
1102
+ * @param data.region Region code for tenant context
994
1103
  * @returns unknown Provider support status
995
1104
  * @throws ApiError
996
1105
  */
@@ -1011,18 +1120,13 @@ var ProviderSyncService = class {
1011
1120
  var HealthService = class {
1012
1121
  /**
1013
1122
  * Basic health check for K8s/load balancer probes
1014
- * @param data The data for the request.
1015
- * @param data.region Region code (cn, us, de)
1016
1123
  * @returns unknown Service is healthy
1017
1124
  * @throws ApiError
1018
1125
  */
1019
- static healthControllerGetHealth(data) {
1126
+ static healthControllerGetHealth() {
1020
1127
  return request(OpenAPI, {
1021
1128
  method: "GET",
1022
1129
  url: "/api/v1/health",
1023
- path: {
1024
- region: data.region
1025
- },
1026
1130
  errors: {
1027
1131
  503: "Service unavailable"
1028
1132
  }
@@ -1030,37 +1134,41 @@ var HealthService = class {
1030
1134
  }
1031
1135
  /**
1032
1136
  * Check database connection health
1033
- * @param data The data for the request.
1034
- * @param data.region Region code (cn, us, de)
1035
1137
  * @returns unknown Database is healthy
1036
1138
  * @throws ApiError
1037
1139
  */
1038
- static healthControllerCheckDatabase(data) {
1140
+ static healthControllerCheckDatabase() {
1039
1141
  return request(OpenAPI, {
1040
1142
  method: "GET",
1041
1143
  url: "/api/v1/health/database",
1042
- path: {
1043
- region: data.region
1044
- },
1045
1144
  errors: {
1046
1145
  503: "Database unavailable"
1047
1146
  }
1048
1147
  });
1049
1148
  }
1149
+ /**
1150
+ * Check OpenBB schema status
1151
+ * @returns unknown OpenBB status
1152
+ * @throws ApiError
1153
+ */
1154
+ static healthControllerCheckOpenBb() {
1155
+ return request(OpenAPI, {
1156
+ method: "GET",
1157
+ url: "/api/v1/health/openbb",
1158
+ errors: {
1159
+ 503: "OpenBB unavailable"
1160
+ }
1161
+ });
1162
+ }
1050
1163
  /**
1051
1164
  * Check Redis connection health
1052
- * @param data The data for the request.
1053
- * @param data.region Region code (cn, us, de)
1054
1165
  * @returns unknown Redis is healthy
1055
1166
  * @throws ApiError
1056
1167
  */
1057
- static healthControllerCheckRedis(data) {
1168
+ static healthControllerCheckRedis() {
1058
1169
  return request(OpenAPI, {
1059
1170
  method: "GET",
1060
1171
  url: "/api/v1/health/redis",
1061
- path: {
1062
- region: data.region
1063
- },
1064
1172
  errors: {
1065
1173
  503: "Redis unavailable"
1066
1174
  }
@@ -1068,18 +1176,13 @@ var HealthService = class {
1068
1176
  }
1069
1177
  /**
1070
1178
  * Get status of all circuit breakers
1071
- * @param data The data for the request.
1072
- * @param data.region Region code (cn, us, de)
1073
1179
  * @returns unknown Circuit breaker status
1074
1180
  * @throws ApiError
1075
1181
  */
1076
- static healthControllerGetCircuitBreakersHealth(data) {
1182
+ static healthControllerGetCircuitBreakersHealth() {
1077
1183
  return request(OpenAPI, {
1078
1184
  method: "GET",
1079
1185
  url: "/api/v1/health/circuit-breakers",
1080
- path: {
1081
- region: data.region
1082
- },
1083
1186
  errors: {
1084
1187
  401: "Unauthorized",
1085
1188
  500: "Internal error"
@@ -1090,7 +1193,6 @@ var HealthService = class {
1090
1193
  * Reset a circuit breaker to CLOSED state
1091
1194
  * @param data The data for the request.
1092
1195
  * @param data.name Circuit breaker name to reset
1093
- * @param data.region Region code (cn, us, de)
1094
1196
  * @returns unknown Circuit breaker reset successfully
1095
1197
  * @throws ApiError
1096
1198
  */
@@ -1099,8 +1201,7 @@ var HealthService = class {
1099
1201
  method: "POST",
1100
1202
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1101
1203
  path: {
1102
- name: data.name,
1103
- region: data.region
1204
+ name: data.name
1104
1205
  },
1105
1206
  errors: {
1106
1207
  401: "Unauthorized",
@@ -1110,88 +1211,18 @@ var HealthService = class {
1110
1211
  }
1111
1212
  /**
1112
1213
  * Get health check metrics and statistics
1113
- * @param data The data for the request.
1114
- * @param data.region Region code (cn, us, de)
1115
1214
  * @returns unknown Health metrics
1116
1215
  * @throws ApiError
1117
1216
  */
1118
- static healthControllerGetMetrics(data) {
1217
+ static healthControllerGetMetrics() {
1119
1218
  return request(OpenAPI, {
1120
1219
  method: "GET",
1121
1220
  url: "/api/v1/health/metrics",
1122
- path: {
1123
- region: data.region
1124
- },
1125
1221
  errors: {
1126
1222
  401: "Unauthorized"
1127
1223
  }
1128
1224
  });
1129
1225
  }
1130
- /**
1131
- * Check health of a specific data enhancer
1132
- * @param data The data for the request.
1133
- * @param data.name Data enhancer name
1134
- * @param data.region Region code (cn, us, de)
1135
- * @returns unknown Data enhancer is healthy
1136
- * @throws ApiError
1137
- */
1138
- static healthControllerGetHealthOfDataEnhancer(data) {
1139
- return request(OpenAPI, {
1140
- method: "GET",
1141
- url: "/api/v1/health/data-enhancer/{name}",
1142
- path: {
1143
- name: data.name,
1144
- region: data.region
1145
- },
1146
- errors: {
1147
- 401: "Unauthorized",
1148
- 503: "Data enhancer unavailable"
1149
- }
1150
- });
1151
- }
1152
- /**
1153
- * Check health of all data providers
1154
- * @param data The data for the request.
1155
- * @param data.region Region code (cn, us, de)
1156
- * @returns unknown Data providers health status
1157
- * @throws ApiError
1158
- */
1159
- static healthControllerCheckDataProviders(data) {
1160
- return request(OpenAPI, {
1161
- method: "GET",
1162
- url: "/api/v1/health/data-providers",
1163
- path: {
1164
- region: data.region
1165
- },
1166
- errors: {
1167
- 401: "Unauthorized",
1168
- 503: "Data providers check failed"
1169
- }
1170
- });
1171
- }
1172
- /**
1173
- * Check health of a specific data provider
1174
- * @param data The data for the request.
1175
- * @param data.dataSource Data source identifier
1176
- * @param data.region Region code (cn, us, de)
1177
- * @returns unknown Data provider is healthy
1178
- * @throws ApiError
1179
- */
1180
- static healthControllerGetHealthOfDataProvider(data) {
1181
- return request(OpenAPI, {
1182
- method: "GET",
1183
- url: "/api/v1/health/data-provider/{dataSource}",
1184
- path: {
1185
- dataSource: data.dataSource,
1186
- region: data.region
1187
- },
1188
- errors: {
1189
- 400: "Invalid data source",
1190
- 401: "Unauthorized",
1191
- 503: "Data provider unavailable"
1192
- }
1193
- });
1194
- }
1195
1226
  };
1196
1227
  export {
1197
1228
  BeanAccountsService,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.b3b7767b",
3
+ "version": "0.0.0-canary.cf050c09",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -24,8 +24,7 @@
24
24
  "src"
25
25
  ],
26
26
  "scripts": {
27
- "sync": "npx ts-node scripts/sync-spec.ts",
28
- "generate": "npm run sync && openapi-ts",
27
+ "generate": "openapi-ts",
29
28
  "build": "tsup src/index.ts --format cjs,esm --dts --clean",
30
29
  "lint": "spectral lint openapi.yaml",
31
30
  "prepublishOnly": "npm run generate && npm run build"