@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.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,62 @@ 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
+ * Suggest transaction tags
693
+ * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
694
+ * @param data The data for the request.
695
+ * @param data.region Region code for tenant context
696
+ * @param data.q Prefix match, case-insensitive (max 50 chars)
697
+ * @param data.sort usage (default) or name
698
+ * @param data.limit Max suggestions (1-100, default 10)
699
+ * @returns TagSuggestionsResponseDto Tag suggestions
700
+ * @throws ApiError
701
+ */
702
+ static transactionControllerSuggestTags(data) {
703
+ return request(OpenAPI, {
704
+ method: "GET",
705
+ url: "/api/v1/{region}/bean/transactions/tags",
706
+ path: {
707
+ region: data.region
708
+ },
709
+ query: {
710
+ q: data.q,
711
+ sort: data.sort,
712
+ limit: data.limit
713
+ },
714
+ errors: {
715
+ 400: "Validation failed",
716
+ 401: "Authentication required"
676
717
  }
677
718
  });
678
719
  }
@@ -727,17 +768,26 @@ var BeanTransactionsService = class {
727
768
  });
728
769
  }
729
770
  /**
771
+ * Void transaction
772
+ * Soft-deletes a transaction by marking it as VOIDED
730
773
  * @param data The data for the request.
774
+ * @param data.id Transaction ID
731
775
  * @param data.region Region code for tenant context
732
- * @returns void
776
+ * @returns void Transaction voided successfully
733
777
  * @throws ApiError
734
778
  */
735
- static transactionController1(data) {
779
+ static transactionControllerDelete(data) {
736
780
  return request(OpenAPI, {
737
781
  method: "DELETE",
738
782
  url: "/api/v1/{region}/bean/transactions/{id}",
739
783
  path: {
784
+ id: data.id,
740
785
  region: data.region
786
+ },
787
+ errors: {
788
+ 400: "Transaction already voided",
789
+ 401: "Authentication required",
790
+ 404: "Transaction not found"
741
791
  }
742
792
  });
743
793
  }
@@ -748,7 +798,7 @@ var BeanBalancesService = class {
748
798
  * Calculate account balance at a specific date for a single currency
749
799
  * @param data The data for the request.
750
800
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
751
- * @param data.region Region code (cn, us, eu-core, de)
801
+ * @param data.region Region code for tenant context
752
802
  * @param data.date Date to calculate balance at (ISO 8601 format)
753
803
  * @param data.currency Currency to query (e.g., "USD", "CNY")
754
804
  * @returns BalanceResponseDto Balance calculated successfully
@@ -776,7 +826,7 @@ var BeanBalancesService = class {
776
826
  * Query multi-currency account balance
777
827
  * Calculate account balances for all currencies at a specific date
778
828
  * @param data The data for the request.
779
- * @param data.region Region code (cn, us, eu-core, de)
829
+ * @param data.region Region code for tenant context
780
830
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
781
831
  * @throws ApiError
782
832
  */
@@ -796,17 +846,26 @@ var BeanBalancesService = class {
796
846
  };
797
847
  var BeanCommoditiesService = class {
798
848
  /**
849
+ * Create a new commodity
850
+ * Creates a new commodity definition for the authenticated user
799
851
  * @param data The data for the request.
800
- * @param data.region Region code (cn, us, eu-core, de)
801
- * @returns unknown
852
+ * @param data.region Region code for tenant context
853
+ * @param data.requestBody
854
+ * @returns CommodityResponseDto Commodity created successfully
802
855
  * @throws ApiError
803
856
  */
804
- static commodityController(data) {
857
+ static commodityControllerCreate(data) {
805
858
  return request(OpenAPI, {
806
859
  method: "POST",
807
860
  url: "/api/v1/{region}/bean/commodities",
808
861
  path: {
809
862
  region: data.region
863
+ },
864
+ body: data.requestBody,
865
+ mediaType: "application/json",
866
+ errors: {
867
+ 400: "Invalid input data",
868
+ 409: "Commodity already exists"
810
869
  }
811
870
  });
812
871
  }
@@ -814,7 +873,7 @@ var BeanCommoditiesService = class {
814
873
  * List user commodities
815
874
  * Returns all commodity definitions for the authenticated user with optional filtering
816
875
  * @param data The data for the request.
817
- * @param data.region Region code (cn, us, eu-core, de)
876
+ * @param data.region Region code for tenant context
818
877
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
819
878
  * @param data.symbol Filter by exact symbol match
820
879
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -838,7 +897,7 @@ var BeanCommoditiesService = class {
838
897
  * Returns a specific commodity definition by its symbol
839
898
  * @param data The data for the request.
840
899
  * @param data.symbol Commodity symbol
841
- * @param data.region Region code (cn, us, eu-core, de)
900
+ * @param data.region Region code for tenant context
842
901
  * @returns CommodityResponseDto Commodity retrieved successfully
843
902
  * @throws ApiError
844
903
  */
@@ -856,57 +915,81 @@ var BeanCommoditiesService = class {
856
915
  });
857
916
  }
858
917
  /**
918
+ * Update commodity
919
+ * Updates an existing commodity definition. Symbol cannot be changed.
859
920
  * @param data The data for the request.
860
- * @param data.region Region code (cn, us, eu-core, de)
861
- * @returns unknown
921
+ * @param data.symbol Commodity symbol
922
+ * @param data.region Region code for tenant context
923
+ * @param data.requestBody
924
+ * @returns CommodityResponseDto Commodity updated successfully
862
925
  * @throws ApiError
863
926
  */
864
- static commodityController1(data) {
927
+ static commodityControllerUpdate(data) {
865
928
  return request(OpenAPI, {
866
929
  method: "PUT",
867
930
  url: "/api/v1/{region}/bean/commodities/{symbol}",
868
931
  path: {
932
+ symbol: data.symbol,
869
933
  region: data.region
934
+ },
935
+ body: data.requestBody,
936
+ mediaType: "application/json",
937
+ errors: {
938
+ 400: "Invalid input data",
939
+ 404: "Commodity not found"
870
940
  }
871
941
  });
872
942
  }
873
943
  /**
944
+ * Delete commodity
945
+ * Deletes a commodity definition
874
946
  * @param data The data for the request.
875
- * @param data.region Region code (cn, us, eu-core, de)
876
- * @returns void
947
+ * @param data.symbol Commodity symbol
948
+ * @param data.region Region code for tenant context
949
+ * @returns void Commodity deleted successfully
877
950
  * @throws ApiError
878
951
  */
879
- static commodityController2(data) {
952
+ static commodityControllerDelete(data) {
880
953
  return request(OpenAPI, {
881
954
  method: "DELETE",
882
955
  url: "/api/v1/{region}/bean/commodities/{symbol}",
883
956
  path: {
957
+ symbol: data.symbol,
884
958
  region: data.region
959
+ },
960
+ errors: {
961
+ 404: "Commodity not found"
885
962
  }
886
963
  });
887
964
  }
888
965
  /**
966
+ * Ensure commodity exists
967
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
889
968
  * @param data The data for the request.
890
- * @param data.region Region code (cn, us, eu-core, de)
891
- * @returns unknown
969
+ * @param data.symbol Commodity symbol
970
+ * @param data.region Region code for tenant context
971
+ * @returns CommodityResponseDto Commodity retrieved or created
892
972
  * @throws ApiError
893
973
  */
894
- static commodityController3(data) {
974
+ static commodityControllerGetOrCreate(data) {
895
975
  return request(OpenAPI, {
896
976
  method: "POST",
897
977
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
898
978
  path: {
979
+ symbol: data.symbol,
899
980
  region: data.region
900
981
  }
901
982
  });
902
983
  }
903
984
  /**
985
+ * Bulk create commodities
986
+ * Creates multiple commodities from a list of symbols, useful for initialization
904
987
  * @param data The data for the request.
905
- * @param data.region Region code (cn, us, eu-core, de)
906
- * @returns unknown
988
+ * @param data.region Region code for tenant context
989
+ * @returns CommodityResponseDto Commodities created successfully
907
990
  * @throws ApiError
908
991
  */
909
- static commodityController4(data) {
992
+ static commodityControllerBulkCreate(data) {
910
993
  return request(OpenAPI, {
911
994
  method: "POST",
912
995
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -930,6 +1013,7 @@ var ProviderSyncService = class {
930
1013
  * - **simplefin**: SimpleFIN (Self-hosted)
931
1014
  * - **yodlee**: Yodlee (Global)
932
1015
  * - **beancount-direct**: Beancount format transactions
1016
+ * - **parsed-bill**: Client-side parsed bill transactions
933
1017
  *
934
1018
  * **Processing Flow:**
935
1019
  * 1. Transform raw data via provider adapter
@@ -967,7 +1051,7 @@ var ProviderSyncService = class {
967
1051
  * Get supported providers
968
1052
  * Returns a list of all providers supported by the sync endpoint.
969
1053
  * @param data The data for the request.
970
- * @param data.region Region code (cn, us, eu-core, de)
1054
+ * @param data.region Region code for tenant context
971
1055
  * @returns SupportedProvidersResponseDto List of supported providers
972
1056
  * @throws ApiError
973
1057
  */
@@ -988,7 +1072,7 @@ var ProviderSyncService = class {
988
1072
  * Returns whether a specific provider is supported.
989
1073
  * @param data The data for the request.
990
1074
  * @param data.providerName Provider name to check
991
- * @param data.region Region code (cn, us, eu-core, de)
1075
+ * @param data.region Region code for tenant context
992
1076
  * @returns unknown Provider support status
993
1077
  * @throws ApiError
994
1078
  */
@@ -1009,18 +1093,13 @@ var ProviderSyncService = class {
1009
1093
  var HealthService = class {
1010
1094
  /**
1011
1095
  * Basic health check for K8s/load balancer probes
1012
- * @param data The data for the request.
1013
- * @param data.region Region code (cn, us, eu-core, de)
1014
1096
  * @returns unknown Service is healthy
1015
1097
  * @throws ApiError
1016
1098
  */
1017
- static healthControllerGetHealth(data) {
1099
+ static healthControllerGetHealth() {
1018
1100
  return request(OpenAPI, {
1019
1101
  method: "GET",
1020
1102
  url: "/api/v1/health",
1021
- path: {
1022
- region: data.region
1023
- },
1024
1103
  errors: {
1025
1104
  503: "Service unavailable"
1026
1105
  }
@@ -1028,37 +1107,41 @@ var HealthService = class {
1028
1107
  }
1029
1108
  /**
1030
1109
  * Check database connection health
1031
- * @param data The data for the request.
1032
- * @param data.region Region code (cn, us, eu-core, de)
1033
1110
  * @returns unknown Database is healthy
1034
1111
  * @throws ApiError
1035
1112
  */
1036
- static healthControllerCheckDatabase(data) {
1113
+ static healthControllerCheckDatabase() {
1037
1114
  return request(OpenAPI, {
1038
1115
  method: "GET",
1039
1116
  url: "/api/v1/health/database",
1040
- path: {
1041
- region: data.region
1042
- },
1043
1117
  errors: {
1044
1118
  503: "Database unavailable"
1045
1119
  }
1046
1120
  });
1047
1121
  }
1122
+ /**
1123
+ * Check OpenBB schema status
1124
+ * @returns unknown OpenBB status
1125
+ * @throws ApiError
1126
+ */
1127
+ static healthControllerCheckOpenBb() {
1128
+ return request(OpenAPI, {
1129
+ method: "GET",
1130
+ url: "/api/v1/health/openbb",
1131
+ errors: {
1132
+ 503: "OpenBB unavailable"
1133
+ }
1134
+ });
1135
+ }
1048
1136
  /**
1049
1137
  * Check Redis connection health
1050
- * @param data The data for the request.
1051
- * @param data.region Region code (cn, us, eu-core, de)
1052
1138
  * @returns unknown Redis is healthy
1053
1139
  * @throws ApiError
1054
1140
  */
1055
- static healthControllerCheckRedis(data) {
1141
+ static healthControllerCheckRedis() {
1056
1142
  return request(OpenAPI, {
1057
1143
  method: "GET",
1058
1144
  url: "/api/v1/health/redis",
1059
- path: {
1060
- region: data.region
1061
- },
1062
1145
  errors: {
1063
1146
  503: "Redis unavailable"
1064
1147
  }
@@ -1066,18 +1149,13 @@ var HealthService = class {
1066
1149
  }
1067
1150
  /**
1068
1151
  * Get status of all circuit breakers
1069
- * @param data The data for the request.
1070
- * @param data.region Region code (cn, us, eu-core, de)
1071
1152
  * @returns unknown Circuit breaker status
1072
1153
  * @throws ApiError
1073
1154
  */
1074
- static healthControllerGetCircuitBreakersHealth(data) {
1155
+ static healthControllerGetCircuitBreakersHealth() {
1075
1156
  return request(OpenAPI, {
1076
1157
  method: "GET",
1077
1158
  url: "/api/v1/health/circuit-breakers",
1078
- path: {
1079
- region: data.region
1080
- },
1081
1159
  errors: {
1082
1160
  401: "Unauthorized",
1083
1161
  500: "Internal error"
@@ -1088,7 +1166,6 @@ var HealthService = class {
1088
1166
  * Reset a circuit breaker to CLOSED state
1089
1167
  * @param data The data for the request.
1090
1168
  * @param data.name Circuit breaker name to reset
1091
- * @param data.region Region code (cn, us, eu-core, de)
1092
1169
  * @returns unknown Circuit breaker reset successfully
1093
1170
  * @throws ApiError
1094
1171
  */
@@ -1097,8 +1174,7 @@ var HealthService = class {
1097
1174
  method: "POST",
1098
1175
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1099
1176
  path: {
1100
- name: data.name,
1101
- region: data.region
1177
+ name: data.name
1102
1178
  },
1103
1179
  errors: {
1104
1180
  401: "Unauthorized",
@@ -1108,88 +1184,18 @@ var HealthService = class {
1108
1184
  }
1109
1185
  /**
1110
1186
  * Get health check metrics and statistics
1111
- * @param data The data for the request.
1112
- * @param data.region Region code (cn, us, eu-core, de)
1113
1187
  * @returns unknown Health metrics
1114
1188
  * @throws ApiError
1115
1189
  */
1116
- static healthControllerGetMetrics(data) {
1190
+ static healthControllerGetMetrics() {
1117
1191
  return request(OpenAPI, {
1118
1192
  method: "GET",
1119
1193
  url: "/api/v1/health/metrics",
1120
- path: {
1121
- region: data.region
1122
- },
1123
1194
  errors: {
1124
1195
  401: "Unauthorized"
1125
1196
  }
1126
1197
  });
1127
1198
  }
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, eu-core, 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, eu-core, 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, eu-core, 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
1199
  };
1194
1200
  export {
1195
1201
  BeanAccountsService,
package/package.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@firela/api-types",
3
- "version": "0.0.0-canary.209966",
3
+ "version": "0.0.0-canary.32edff08",
4
4
  "description": "TypeScript types generated from IGN OpenAPI specification",
5
5
  "license": "MIT",
6
6
  "author": "FireLa Team",
7
7
  "repository": {
8
8
  "type": "git",
9
- "url": "https://github.com/fire-zu/ign.git",
9
+ "url": "https://github.com/fire-zu/firela-vlt.git",
10
10
  "directory": "libs/api-types"
11
11
  },
12
12
  "main": "./dist/index.js",
@@ -17,17 +17,14 @@
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
- "files": ["dist", "src"],
22
+ "files": [
23
+ "dist",
24
+ "src"
25
+ ],
28
26
  "scripts": {
29
- "sync": "npx ts-node scripts/sync-spec.ts",
30
- "generate": "npm run sync && openapi-ts",
27
+ "generate": "openapi-ts",
31
28
  "build": "tsup src/index.ts --format cjs,esm --dts --clean",
32
29
  "lint": "spectral lint openapi.yaml",
33
30
  "prepublishOnly": "npm run generate && npm run build"