@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.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,33 @@ 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"
676
688
  }
677
689
  });
678
690
  }
@@ -727,17 +739,26 @@ var BeanTransactionsService = class {
727
739
  });
728
740
  }
729
741
  /**
742
+ * Void transaction
743
+ * Soft-deletes a transaction by marking it as VOIDED
730
744
  * @param data The data for the request.
745
+ * @param data.id Transaction ID
731
746
  * @param data.region Region code for tenant context
732
- * @returns void
747
+ * @returns void Transaction voided successfully
733
748
  * @throws ApiError
734
749
  */
735
- static transactionController1(data) {
750
+ static transactionControllerDelete(data) {
736
751
  return request(OpenAPI, {
737
752
  method: "DELETE",
738
753
  url: "/api/v1/{region}/bean/transactions/{id}",
739
754
  path: {
755
+ id: data.id,
740
756
  region: data.region
757
+ },
758
+ errors: {
759
+ 400: "Transaction already voided",
760
+ 401: "Authentication required",
761
+ 404: "Transaction not found"
741
762
  }
742
763
  });
743
764
  }
@@ -748,7 +769,7 @@ var BeanBalancesService = class {
748
769
  * Calculate account balance at a specific date for a single currency
749
770
  * @param data The data for the request.
750
771
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
751
- * @param data.region Region code (cn, us, de)
772
+ * @param data.region Region code for tenant context
752
773
  * @param data.date Date to calculate balance at (ISO 8601 format)
753
774
  * @param data.currency Currency to query (e.g., "USD", "CNY")
754
775
  * @returns BalanceResponseDto Balance calculated successfully
@@ -776,7 +797,7 @@ var BeanBalancesService = class {
776
797
  * Query multi-currency account balance
777
798
  * Calculate account balances for all currencies at a specific date
778
799
  * @param data The data for the request.
779
- * @param data.region Region code (cn, us, de)
800
+ * @param data.region Region code for tenant context
780
801
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
781
802
  * @throws ApiError
782
803
  */
@@ -796,17 +817,26 @@ var BeanBalancesService = class {
796
817
  };
797
818
  var BeanCommoditiesService = class {
798
819
  /**
820
+ * Create a new commodity
821
+ * Creates a new commodity definition for the authenticated user
799
822
  * @param data The data for the request.
800
- * @param data.region Region code (cn, us, de)
801
- * @returns unknown
823
+ * @param data.region Region code for tenant context
824
+ * @param data.requestBody
825
+ * @returns CommodityResponseDto Commodity created successfully
802
826
  * @throws ApiError
803
827
  */
804
- static commodityController(data) {
828
+ static commodityControllerCreate(data) {
805
829
  return request(OpenAPI, {
806
830
  method: "POST",
807
831
  url: "/api/v1/{region}/bean/commodities",
808
832
  path: {
809
833
  region: data.region
834
+ },
835
+ body: data.requestBody,
836
+ mediaType: "application/json",
837
+ errors: {
838
+ 400: "Invalid input data",
839
+ 409: "Commodity already exists"
810
840
  }
811
841
  });
812
842
  }
@@ -814,7 +844,7 @@ var BeanCommoditiesService = class {
814
844
  * List user commodities
815
845
  * Returns all commodity definitions for the authenticated user with optional filtering
816
846
  * @param data The data for the request.
817
- * @param data.region Region code (cn, us, de)
847
+ * @param data.region Region code for tenant context
818
848
  * @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
819
849
  * @param data.symbol Filter by exact symbol match
820
850
  * @returns CommodityListResponseDto Commodities retrieved successfully
@@ -838,7 +868,7 @@ var BeanCommoditiesService = class {
838
868
  * Returns a specific commodity definition by its symbol
839
869
  * @param data The data for the request.
840
870
  * @param data.symbol Commodity symbol
841
- * @param data.region Region code (cn, us, de)
871
+ * @param data.region Region code for tenant context
842
872
  * @returns CommodityResponseDto Commodity retrieved successfully
843
873
  * @throws ApiError
844
874
  */
@@ -856,57 +886,81 @@ var BeanCommoditiesService = class {
856
886
  });
857
887
  }
858
888
  /**
889
+ * Update commodity
890
+ * Updates an existing commodity definition. Symbol cannot be changed.
859
891
  * @param data The data for the request.
860
- * @param data.region Region code (cn, us, de)
861
- * @returns unknown
892
+ * @param data.symbol Commodity symbol
893
+ * @param data.region Region code for tenant context
894
+ * @param data.requestBody
895
+ * @returns CommodityResponseDto Commodity updated successfully
862
896
  * @throws ApiError
863
897
  */
864
- static commodityController1(data) {
898
+ static commodityControllerUpdate(data) {
865
899
  return request(OpenAPI, {
866
900
  method: "PUT",
867
901
  url: "/api/v1/{region}/bean/commodities/{symbol}",
868
902
  path: {
903
+ symbol: data.symbol,
869
904
  region: data.region
905
+ },
906
+ body: data.requestBody,
907
+ mediaType: "application/json",
908
+ errors: {
909
+ 400: "Invalid input data",
910
+ 404: "Commodity not found"
870
911
  }
871
912
  });
872
913
  }
873
914
  /**
915
+ * Delete commodity
916
+ * Deletes a commodity definition
874
917
  * @param data The data for the request.
875
- * @param data.region Region code (cn, us, de)
876
- * @returns void
918
+ * @param data.symbol Commodity symbol
919
+ * @param data.region Region code for tenant context
920
+ * @returns void Commodity deleted successfully
877
921
  * @throws ApiError
878
922
  */
879
- static commodityController2(data) {
923
+ static commodityControllerDelete(data) {
880
924
  return request(OpenAPI, {
881
925
  method: "DELETE",
882
926
  url: "/api/v1/{region}/bean/commodities/{symbol}",
883
927
  path: {
928
+ symbol: data.symbol,
884
929
  region: data.region
930
+ },
931
+ errors: {
932
+ 404: "Commodity not found"
885
933
  }
886
934
  });
887
935
  }
888
936
  /**
937
+ * Ensure commodity exists
938
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
889
939
  * @param data The data for the request.
890
- * @param data.region Region code (cn, us, de)
891
- * @returns unknown
940
+ * @param data.symbol Commodity symbol
941
+ * @param data.region Region code for tenant context
942
+ * @returns CommodityResponseDto Commodity retrieved or created
892
943
  * @throws ApiError
893
944
  */
894
- static commodityController3(data) {
945
+ static commodityControllerGetOrCreate(data) {
895
946
  return request(OpenAPI, {
896
947
  method: "POST",
897
948
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
898
949
  path: {
950
+ symbol: data.symbol,
899
951
  region: data.region
900
952
  }
901
953
  });
902
954
  }
903
955
  /**
956
+ * Bulk create commodities
957
+ * Creates multiple commodities from a list of symbols, useful for initialization
904
958
  * @param data The data for the request.
905
- * @param data.region Region code (cn, us, de)
906
- * @returns unknown
959
+ * @param data.region Region code for tenant context
960
+ * @returns CommodityResponseDto Commodities created successfully
907
961
  * @throws ApiError
908
962
  */
909
- static commodityController4(data) {
963
+ static commodityControllerBulkCreate(data) {
910
964
  return request(OpenAPI, {
911
965
  method: "POST",
912
966
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -930,6 +984,7 @@ var ProviderSyncService = class {
930
984
  * - **simplefin**: SimpleFIN (Self-hosted)
931
985
  * - **yodlee**: Yodlee (Global)
932
986
  * - **beancount-direct**: Beancount format transactions
987
+ * - **parsed-bill**: Client-side parsed bill transactions
933
988
  *
934
989
  * **Processing Flow:**
935
990
  * 1. Transform raw data via provider adapter
@@ -967,7 +1022,7 @@ var ProviderSyncService = class {
967
1022
  * Get supported providers
968
1023
  * Returns a list of all providers supported by the sync endpoint.
969
1024
  * @param data The data for the request.
970
- * @param data.region Region code (cn, us, de)
1025
+ * @param data.region Region code for tenant context
971
1026
  * @returns SupportedProvidersResponseDto List of supported providers
972
1027
  * @throws ApiError
973
1028
  */
@@ -988,7 +1043,7 @@ var ProviderSyncService = class {
988
1043
  * Returns whether a specific provider is supported.
989
1044
  * @param data The data for the request.
990
1045
  * @param data.providerName Provider name to check
991
- * @param data.region Region code (cn, us, de)
1046
+ * @param data.region Region code for tenant context
992
1047
  * @returns unknown Provider support status
993
1048
  * @throws ApiError
994
1049
  */
@@ -1009,18 +1064,13 @@ var ProviderSyncService = class {
1009
1064
  var HealthService = class {
1010
1065
  /**
1011
1066
  * 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
1067
  * @returns unknown Service is healthy
1015
1068
  * @throws ApiError
1016
1069
  */
1017
- static healthControllerGetHealth(data) {
1070
+ static healthControllerGetHealth() {
1018
1071
  return request(OpenAPI, {
1019
1072
  method: "GET",
1020
1073
  url: "/api/v1/health",
1021
- path: {
1022
- region: data.region
1023
- },
1024
1074
  errors: {
1025
1075
  503: "Service unavailable"
1026
1076
  }
@@ -1028,37 +1078,41 @@ var HealthService = class {
1028
1078
  }
1029
1079
  /**
1030
1080
  * Check database connection health
1031
- * @param data The data for the request.
1032
- * @param data.region Region code (cn, us, de)
1033
1081
  * @returns unknown Database is healthy
1034
1082
  * @throws ApiError
1035
1083
  */
1036
- static healthControllerCheckDatabase(data) {
1084
+ static healthControllerCheckDatabase() {
1037
1085
  return request(OpenAPI, {
1038
1086
  method: "GET",
1039
1087
  url: "/api/v1/health/database",
1040
- path: {
1041
- region: data.region
1042
- },
1043
1088
  errors: {
1044
1089
  503: "Database unavailable"
1045
1090
  }
1046
1091
  });
1047
1092
  }
1093
+ /**
1094
+ * Check OpenBB schema status
1095
+ * @returns unknown OpenBB status
1096
+ * @throws ApiError
1097
+ */
1098
+ static healthControllerCheckOpenBb() {
1099
+ return request(OpenAPI, {
1100
+ method: "GET",
1101
+ url: "/api/v1/health/openbb",
1102
+ errors: {
1103
+ 503: "OpenBB unavailable"
1104
+ }
1105
+ });
1106
+ }
1048
1107
  /**
1049
1108
  * Check Redis connection health
1050
- * @param data The data for the request.
1051
- * @param data.region Region code (cn, us, de)
1052
1109
  * @returns unknown Redis is healthy
1053
1110
  * @throws ApiError
1054
1111
  */
1055
- static healthControllerCheckRedis(data) {
1112
+ static healthControllerCheckRedis() {
1056
1113
  return request(OpenAPI, {
1057
1114
  method: "GET",
1058
1115
  url: "/api/v1/health/redis",
1059
- path: {
1060
- region: data.region
1061
- },
1062
1116
  errors: {
1063
1117
  503: "Redis unavailable"
1064
1118
  }
@@ -1066,18 +1120,13 @@ var HealthService = class {
1066
1120
  }
1067
1121
  /**
1068
1122
  * Get status of all circuit breakers
1069
- * @param data The data for the request.
1070
- * @param data.region Region code (cn, us, de)
1071
1123
  * @returns unknown Circuit breaker status
1072
1124
  * @throws ApiError
1073
1125
  */
1074
- static healthControllerGetCircuitBreakersHealth(data) {
1126
+ static healthControllerGetCircuitBreakersHealth() {
1075
1127
  return request(OpenAPI, {
1076
1128
  method: "GET",
1077
1129
  url: "/api/v1/health/circuit-breakers",
1078
- path: {
1079
- region: data.region
1080
- },
1081
1130
  errors: {
1082
1131
  401: "Unauthorized",
1083
1132
  500: "Internal error"
@@ -1088,7 +1137,6 @@ var HealthService = class {
1088
1137
  * Reset a circuit breaker to CLOSED state
1089
1138
  * @param data The data for the request.
1090
1139
  * @param data.name Circuit breaker name to reset
1091
- * @param data.region Region code (cn, us, de)
1092
1140
  * @returns unknown Circuit breaker reset successfully
1093
1141
  * @throws ApiError
1094
1142
  */
@@ -1097,8 +1145,7 @@ var HealthService = class {
1097
1145
  method: "POST",
1098
1146
  url: "/api/v1/health/circuit-breakers/{name}/reset",
1099
1147
  path: {
1100
- name: data.name,
1101
- region: data.region
1148
+ name: data.name
1102
1149
  },
1103
1150
  errors: {
1104
1151
  401: "Unauthorized",
@@ -1108,88 +1155,18 @@ var HealthService = class {
1108
1155
  }
1109
1156
  /**
1110
1157
  * Get health check metrics and statistics
1111
- * @param data The data for the request.
1112
- * @param data.region Region code (cn, us, de)
1113
1158
  * @returns unknown Health metrics
1114
1159
  * @throws ApiError
1115
1160
  */
1116
- static healthControllerGetMetrics(data) {
1161
+ static healthControllerGetMetrics() {
1117
1162
  return request(OpenAPI, {
1118
1163
  method: "GET",
1119
1164
  url: "/api/v1/health/metrics",
1120
- path: {
1121
- region: data.region
1122
- },
1123
1165
  errors: {
1124
1166
  401: "Unauthorized"
1125
1167
  }
1126
1168
  });
1127
1169
  }
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
1170
  };
1194
1171
  export {
1195
1172
  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.6feee68d",
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": [