@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.mjs CHANGED
@@ -600,8 +600,9 @@ var BeanAccountsService = class {
600
600
  };
601
601
  var BeanTransactionsService = class {
602
602
  /**
603
- * Create transaction
604
- * Creates a new double-entry transaction. Missing accounts are auto-created by default.
603
+ * @deprecated
604
+ * Create transaction (DEPRECATED)
605
+ * DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
605
606
  * @param data The data for the request.
606
607
  * @param data.region Region code for tenant context
607
608
  * @param data.requestBody Transaction data with postings
@@ -657,22 +658,89 @@ var BeanTransactionsService = class {
657
658
  accountId: data.accountId
658
659
  },
659
660
  errors: {
661
+ 400: "Validation failed",
660
662
  401: "Authentication required"
661
663
  }
662
664
  });
663
665
  }
664
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.
665
670
  * @param data The data for the request.
666
671
  * @param data.region Region code for tenant context
667
- * @returns unknown
672
+ * @param data.requestBody
673
+ * @returns BatchTransactionResponseDto Transactions processed
668
674
  * @throws ApiError
669
675
  */
670
- static transactionController(data) {
676
+ static transactionControllerCreateBatch(data) {
671
677
  return request(OpenAPI, {
672
678
  method: "POST",
673
679
  url: "/api/v1/{region}/bean/transactions/batch",
674
680
  path: {
675
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"
676
744
  }
677
745
  });
678
746
  }
@@ -727,17 +795,26 @@ var BeanTransactionsService = class {
727
795
  });
728
796
  }
729
797
  /**
798
+ * Void transaction
799
+ * Soft-deletes a transaction by marking it as VOIDED
730
800
  * @param data The data for the request.
801
+ * @param data.id Transaction ID
731
802
  * @param data.region Region code for tenant context
732
- * @returns void
803
+ * @returns void Transaction voided successfully
733
804
  * @throws ApiError
734
805
  */
735
- static transactionController1(data) {
806
+ static transactionControllerDelete(data) {
736
807
  return request(OpenAPI, {
737
808
  method: "DELETE",
738
809
  url: "/api/v1/{region}/bean/transactions/{id}",
739
810
  path: {
811
+ id: data.id,
740
812
  region: data.region
813
+ },
814
+ errors: {
815
+ 400: "Transaction already voided",
816
+ 401: "Authentication required",
817
+ 404: "Transaction not found"
741
818
  }
742
819
  });
743
820
  }
@@ -748,7 +825,7 @@ var BeanBalancesService = class {
748
825
  * Calculate account balance at a specific date for a single currency
749
826
  * @param data The data for the request.
750
827
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
751
- * @param data.region Region code (cn, us, de)
828
+ * @param data.region Region code for tenant context
752
829
  * @param data.date Date to calculate balance at (ISO 8601 format)
753
830
  * @param data.currency Currency to query (e.g., "USD", "CNY")
754
831
  * @returns BalanceResponseDto Balance calculated successfully
@@ -776,7 +853,7 @@ var BeanBalancesService = class {
776
853
  * Query multi-currency account balance
777
854
  * Calculate account balances for all currencies at a specific date
778
855
  * @param data The data for the request.
779
- * @param data.region Region code (cn, us, de)
856
+ * @param data.region Region code for tenant context
780
857
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
781
858
  * @throws ApiError
782
859
  */
@@ -796,17 +873,26 @@ var BeanBalancesService = class {
796
873
  };
797
874
  var BeanCommoditiesService = class {
798
875
  /**
876
+ * Create a new commodity
877
+ * Creates a new commodity definition for the authenticated user
799
878
  * @param data The data for the request.
800
- * @param data.region Region code (cn, us, de)
801
- * @returns unknown
879
+ * @param data.region Region code for tenant context
880
+ * @param data.requestBody
881
+ * @returns CommodityResponseDto Commodity created successfully
802
882
  * @throws ApiError
803
883
  */
804
- static commodityController(data) {
884
+ static commodityControllerCreate(data) {
805
885
  return request(OpenAPI, {
806
886
  method: "POST",
807
887
  url: "/api/v1/{region}/bean/commodities",
808
888
  path: {
809
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"
810
896
  }
811
897
  });
812
898
  }
@@ -814,7 +900,7 @@ var BeanCommoditiesService = class {
814
900
  * List user commodities
815
901
  * Returns all commodity definitions for the authenticated user with optional filtering
816
902
  * @param data The data for the request.
817
- * @param data.region Region code (cn, us, de)
903
+ * @param data.region Region code for tenant context
818
904
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
819
905
  * @param data.symbol Filter by exact symbol match
820
906
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -838,7 +924,7 @@ var BeanCommoditiesService = class {
838
924
  * Returns a specific commodity definition by its symbol
839
925
  * @param data The data for the request.
840
926
  * @param data.symbol Commodity symbol
841
- * @param data.region Region code (cn, us, de)
927
+ * @param data.region Region code for tenant context
842
928
  * @returns CommodityResponseDto Commodity retrieved successfully
843
929
  * @throws ApiError
844
930
  */
@@ -856,57 +942,81 @@ var BeanCommoditiesService = class {
856
942
  });
857
943
  }
858
944
  /**
945
+ * Update commodity
946
+ * Updates an existing commodity definition. Symbol cannot be changed.
859
947
  * @param data The data for the request.
860
- * @param data.region Region code (cn, us, de)
861
- * @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
862
952
  * @throws ApiError
863
953
  */
864
- static commodityController1(data) {
954
+ static commodityControllerUpdate(data) {
865
955
  return request(OpenAPI, {
866
956
  method: "PUT",
867
957
  url: "/api/v1/{region}/bean/commodities/{symbol}",
868
958
  path: {
959
+ symbol: data.symbol,
869
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"
870
967
  }
871
968
  });
872
969
  }
873
970
  /**
971
+ * Delete commodity
972
+ * Deletes a commodity definition
874
973
  * @param data The data for the request.
875
- * @param data.region Region code (cn, us, de)
876
- * @returns void
974
+ * @param data.symbol Commodity symbol
975
+ * @param data.region Region code for tenant context
976
+ * @returns void Commodity deleted successfully
877
977
  * @throws ApiError
878
978
  */
879
- static commodityController2(data) {
979
+ static commodityControllerDelete(data) {
880
980
  return request(OpenAPI, {
881
981
  method: "DELETE",
882
982
  url: "/api/v1/{region}/bean/commodities/{symbol}",
883
983
  path: {
984
+ symbol: data.symbol,
884
985
  region: data.region
986
+ },
987
+ errors: {
988
+ 404: "Commodity not found"
885
989
  }
886
990
  });
887
991
  }
888
992
  /**
993
+ * Ensure commodity exists
994
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
889
995
  * @param data The data for the request.
890
- * @param data.region Region code (cn, us, de)
891
- * @returns unknown
996
+ * @param data.symbol Commodity symbol
997
+ * @param data.region Region code for tenant context
998
+ * @returns CommodityResponseDto Commodity retrieved or created
892
999
  * @throws ApiError
893
1000
  */
894
- static commodityController3(data) {
1001
+ static commodityControllerGetOrCreate(data) {
895
1002
  return request(OpenAPI, {
896
1003
  method: "POST",
897
1004
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
898
1005
  path: {
1006
+ symbol: data.symbol,
899
1007
  region: data.region
900
1008
  }
901
1009
  });
902
1010
  }
903
1011
  /**
1012
+ * Bulk create commodities
1013
+ * Creates multiple commodities from a list of symbols, useful for initialization
904
1014
  * @param data The data for the request.
905
- * @param data.region Region code (cn, us, de)
906
- * @returns unknown
1015
+ * @param data.region Region code for tenant context
1016
+ * @returns CommodityResponseDto Commodities created successfully
907
1017
  * @throws ApiError
908
1018
  */
909
- static commodityController4(data) {
1019
+ static commodityControllerBulkCreate(data) {
910
1020
  return request(OpenAPI, {
911
1021
  method: "POST",
912
1022
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -930,6 +1040,7 @@ var ProviderSyncService = class {
930
1040
  * - **simplefin**: SimpleFIN (Self-hosted)
931
1041
  * - **yodlee**: Yodlee (Global)
932
1042
  * - **beancount-direct**: Beancount format transactions
1043
+ * - **parsed-bill**: Client-side parsed bill transactions
933
1044
  *
934
1045
  * **Processing Flow:**
935
1046
  * 1. Transform raw data via provider adapter
@@ -941,7 +1052,7 @@ var ProviderSyncService = class {
941
1052
  *
942
1053
  * @param data The data for the request.
943
1054
  * @param data.providerName Provider name
944
- * @param data.region Region code
1055
+ * @param data.region Region code for tenant context
945
1056
  * @param data.requestBody
946
1057
  * @returns ProviderSyncResponseDto Sync completed successfully
947
1058
  * @throws ApiError
@@ -967,7 +1078,7 @@ var ProviderSyncService = class {
967
1078
  * Get supported providers
968
1079
  * Returns a list of all providers supported by the sync endpoint.
969
1080
  * @param data The data for the request.
970
- * @param data.region Region code (cn, us, de)
1081
+ * @param data.region Region code for tenant context
971
1082
  * @returns SupportedProvidersResponseDto List of supported providers
972
1083
  * @throws ApiError
973
1084
  */
@@ -988,7 +1099,7 @@ var ProviderSyncService = class {
988
1099
  * Returns whether a specific provider is supported.
989
1100
  * @param data The data for the request.
990
1101
  * @param data.providerName Provider name to check
991
- * @param data.region Region code (cn, us, de)
1102
+ * @param data.region Region code for tenant context
992
1103
  * @returns unknown Provider support status
993
1104
  * @throws ApiError
994
1105
  */
@@ -1009,18 +1120,13 @@ var ProviderSyncService = class {
1009
1120
  var HealthService = class {
1010
1121
  /**
1011
1122
  * Basic health check for K8s/load balancer probes
1012
- * @param data The data for the request.
1013
- * @param data.region Region code (cn, us, de)
1014
1123
  * @returns unknown Service is healthy
1015
1124
  * @throws ApiError
1016
1125
  */
1017
- static healthControllerGetHealth(data) {
1126
+ static healthControllerGetHealth() {
1018
1127
  return request(OpenAPI, {
1019
1128
  method: "GET",
1020
1129
  url: "/api/v1/health",
1021
- path: {
1022
- region: data.region
1023
- },
1024
1130
  errors: {
1025
1131
  503: "Service unavailable"
1026
1132
  }
@@ -1028,37 +1134,41 @@ var HealthService = class {
1028
1134
  }
1029
1135
  /**
1030
1136
  * Check database connection health
1031
- * @param data The data for the request.
1032
- * @param data.region Region code (cn, us, de)
1033
1137
  * @returns unknown Database is healthy
1034
1138
  * @throws ApiError
1035
1139
  */
1036
- static healthControllerCheckDatabase(data) {
1140
+ static healthControllerCheckDatabase() {
1037
1141
  return request(OpenAPI, {
1038
1142
  method: "GET",
1039
1143
  url: "/api/v1/health/database",
1040
- path: {
1041
- region: data.region
1042
- },
1043
1144
  errors: {
1044
1145
  503: "Database unavailable"
1045
1146
  }
1046
1147
  });
1047
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
+ }
1048
1163
  /**
1049
1164
  * Check Redis connection health
1050
- * @param data The data for the request.
1051
- * @param data.region Region code (cn, us, de)
1052
1165
  * @returns unknown Redis is healthy
1053
1166
  * @throws ApiError
1054
1167
  */
1055
- static healthControllerCheckRedis(data) {
1168
+ static healthControllerCheckRedis() {
1056
1169
  return request(OpenAPI, {
1057
1170
  method: "GET",
1058
1171
  url: "/api/v1/health/redis",
1059
- path: {
1060
- region: data.region
1061
- },
1062
1172
  errors: {
1063
1173
  503: "Redis unavailable"
1064
1174
  }
@@ -1066,18 +1176,13 @@ var HealthService = class {
1066
1176
  }
1067
1177
  /**
1068
1178
  * Get status of all circuit breakers
1069
- * @param data The data for the request.
1070
- * @param data.region Region code (cn, us, de)
1071
1179
  * @returns unknown Circuit breaker status
1072
1180
  * @throws ApiError
1073
1181
  */
1074
- static healthControllerGetCircuitBreakersHealth(data) {
1182
+ static healthControllerGetCircuitBreakersHealth() {
1075
1183
  return request(OpenAPI, {
1076
1184
  method: "GET",
1077
1185
  url: "/api/v1/health/circuit-breakers",
1078
- path: {
1079
- region: data.region
1080
- },
1081
1186
  errors: {
1082
1187
  401: "Unauthorized",
1083
1188
  500: "Internal error"
@@ -1088,7 +1193,6 @@ var HealthService = class {
1088
1193
  * Reset a circuit breaker to CLOSED state
1089
1194
  * @param data The data for the request.
1090
1195
  * @param data.name Circuit breaker name to reset
1091
- * @param data.region Region code (cn, us, de)
1092
1196
  * @returns unknown Circuit breaker reset successfully
1093
1197
  * @throws ApiError
1094
1198
  */
@@ -1097,8 +1201,7 @@ var HealthService = class {
1097
1201
  method: "POST",
1098
1202
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1099
1203
  path: {
1100
- name: data.name,
1101
- region: data.region
1204
+ name: data.name
1102
1205
  },
1103
1206
  errors: {
1104
1207
  401: "Unauthorized",
@@ -1108,88 +1211,18 @@ var HealthService = class {
1108
1211
  }
1109
1212
  /**
1110
1213
  * Get health check metrics and statistics
1111
- * @param data The data for the request.
1112
- * @param data.region Region code (cn, us, de)
1113
1214
  * @returns unknown Health metrics
1114
1215
  * @throws ApiError
1115
1216
  */
1116
- static healthControllerGetMetrics(data) {
1217
+ static healthControllerGetMetrics() {
1117
1218
  return request(OpenAPI, {
1118
1219
  method: "GET",
1119
1220
  url: "/api/v1/health/metrics",
1120
- path: {
1121
- region: data.region
1122
- },
1123
1221
  errors: {
1124
1222
  401: "Unauthorized"
1125
1223
  }
1126
1224
  });
1127
1225
  }
1128
- /**
1129
- * Check health of a specific data enhancer
1130
- * @param data The data for the request.
1131
- * @param data.name Data enhancer name
1132
- * @param data.region Region code (cn, us, de)
1133
- * @returns unknown Data enhancer is healthy
1134
- * @throws ApiError
1135
- */
1136
- static healthControllerGetHealthOfDataEnhancer(data) {
1137
- return request(OpenAPI, {
1138
- method: "GET",
1139
- url: "/api/v1/health/data-enhancer/{name}",
1140
- path: {
1141
- name: data.name,
1142
- region: data.region
1143
- },
1144
- errors: {
1145
- 401: "Unauthorized",
1146
- 503: "Data enhancer unavailable"
1147
- }
1148
- });
1149
- }
1150
- /**
1151
- * Check health of all data providers
1152
- * @param data The data for the request.
1153
- * @param data.region Region code (cn, us, de)
1154
- * @returns unknown Data providers health status
1155
- * @throws ApiError
1156
- */
1157
- static healthControllerCheckDataProviders(data) {
1158
- return request(OpenAPI, {
1159
- method: "GET",
1160
- url: "/api/v1/health/data-providers",
1161
- path: {
1162
- region: data.region
1163
- },
1164
- errors: {
1165
- 401: "Unauthorized",
1166
- 503: "Data providers check failed"
1167
- }
1168
- });
1169
- }
1170
- /**
1171
- * Check health of a specific data provider
1172
- * @param data The data for the request.
1173
- * @param data.dataSource Data source identifier
1174
- * @param data.region Region code (cn, us, de)
1175
- * @returns unknown Data provider is healthy
1176
- * @throws ApiError
1177
- */
1178
- static healthControllerGetHealthOfDataProvider(data) {
1179
- return request(OpenAPI, {
1180
- method: "GET",
1181
- url: "/api/v1/health/data-provider/{dataSource}",
1182
- path: {
1183
- dataSource: data.dataSource,
1184
- region: data.region
1185
- },
1186
- errors: {
1187
- 400: "Invalid data source",
1188
- 401: "Unauthorized",
1189
- 503: "Data provider unavailable"
1190
- }
1191
- });
1192
- }
1193
1226
  };
1194
1227
  export {
1195
1228
  BeanAccountsService,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.209967",
3
+ "version": "0.0.0-canary.52154bb3",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
@@ -17,11 +17,6 @@
17
17
  "import": "./dist/index.mjs",
18
18
  "require": "./dist/index.js",
19
19
  "types": "./dist/index.d.ts"
20
- },
21
- "./client": {
22
- "types": "./dist/generated/sdk.gen.d.ts",
23
- "import": "./dist/generated/sdk.gen.mjs",
24
- "default": "./dist/generated/sdk.gen.js"
25
20
  }
26
21
  },
27
22
  "files": [
@@ -29,8 +24,7 @@
29
24
  "src"
30
25
  ],
31
26
  "scripts": {
32
- "sync": "npx ts-node scripts/sync-spec.ts",
33
- "generate": "npm run sync && openapi-ts",
27
+ "generate": "openapi-ts",
34
28
  "build": "tsup src/index.ts --format cjs,esm --dts --clean",
35
29
  "lint": "spectral lint openapi.yaml",
36
30
  "prepublishOnly": "npm run generate && npm run build"