@firela/api-types 0.0.0-canary.5639ea2d → 0.0.0-canary.614ff760

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
@@ -690,22 +690,89 @@ var BeanTransactionsService = class {
690
690
  accountId: data.accountId
691
691
  },
692
692
  errors: {
693
+ 400: "Validation failed",
693
694
  401: "Authentication required"
694
695
  }
695
696
  });
696
697
  }
697
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.
698
702
  * @param data The data for the request.
699
703
  * @param data.region Region code for tenant context
700
- * @returns unknown
704
+ * @param data.requestBody
705
+ * @returns BatchTransactionResponseDto Transactions processed
701
706
  * @throws ApiError
702
707
  */
703
- static transactionController(data) {
708
+ static transactionControllerCreateBatch(data) {
704
709
  return request(OpenAPI, {
705
710
  method: "POST",
706
711
  url: "/api/v1/{region}/bean/transactions/batch",
707
712
  path: {
708
713
  region: data.region
714
+ },
715
+ body: data.requestBody,
716
+ mediaType: "application/json",
717
+ errors: {
718
+ 400: "Invalid input",
719
+ 401: "Authentication required"
720
+ }
721
+ });
722
+ }
723
+ /**
724
+ * Correct (supersede) a transaction
725
+ * Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
726
+ * @param data The data for the request.
727
+ * @param data.id Original transaction ID to correct
728
+ * @param data.region Region code for tenant context
729
+ * @param data.requestBody
730
+ * @returns TransactionDetailDto Corrected transaction created
731
+ * @throws ApiError
732
+ */
733
+ static transactionControllerCorrect(data) {
734
+ return request(OpenAPI, {
735
+ method: "POST",
736
+ url: "/api/v1/{region}/bean/transactions/{id}/correct",
737
+ path: {
738
+ id: data.id,
739
+ region: data.region
740
+ },
741
+ body: data.requestBody,
742
+ mediaType: "application/json",
743
+ errors: {
744
+ 404: "Original transaction not found",
745
+ 409: "Original no longer ACTIVE (concurrent modification)",
746
+ 422: "Pipeline validation failed (does not balance, invalid accounts)"
747
+ }
748
+ });
749
+ }
750
+ /**
751
+ * Suggest transaction tags
752
+ * Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
753
+ * @param data The data for the request.
754
+ * @param data.region Region code for tenant context
755
+ * @param data.q Prefix match, case-insensitive (max 50 chars)
756
+ * @param data.sort usage (default) or name
757
+ * @param data.limit Max suggestions (1-100, default 10)
758
+ * @returns TagSuggestionsResponseDto Tag suggestions
759
+ * @throws ApiError
760
+ */
761
+ static transactionControllerSuggestTags(data) {
762
+ return request(OpenAPI, {
763
+ method: "GET",
764
+ url: "/api/v1/{region}/bean/transactions/tags",
765
+ path: {
766
+ region: data.region
767
+ },
768
+ query: {
769
+ q: data.q,
770
+ sort: data.sort,
771
+ limit: data.limit
772
+ },
773
+ errors: {
774
+ 400: "Validation failed",
775
+ 401: "Authentication required"
709
776
  }
710
777
  });
711
778
  }
@@ -760,17 +827,26 @@ var BeanTransactionsService = class {
760
827
  });
761
828
  }
762
829
  /**
830
+ * Void transaction
831
+ * Soft-deletes a transaction by marking it as VOIDED
763
832
  * @param data The data for the request.
833
+ * @param data.id Transaction ID
764
834
  * @param data.region Region code for tenant context
765
- * @returns void
835
+ * @returns void Transaction voided successfully
766
836
  * @throws ApiError
767
837
  */
768
- static transactionController1(data) {
838
+ static transactionControllerDelete(data) {
769
839
  return request(OpenAPI, {
770
840
  method: "DELETE",
771
841
  url: "/api/v1/{region}/bean/transactions/{id}",
772
842
  path: {
843
+ id: data.id,
773
844
  region: data.region
845
+ },
846
+ errors: {
847
+ 400: "Transaction already voided",
848
+ 401: "Authentication required",
849
+ 404: "Transaction not found"
774
850
  }
775
851
  });
776
852
  }
@@ -781,6 +857,7 @@ var BeanBalancesService = class {
781
857
  * Calculate account balance at a specific date for a single currency
782
858
  * @param data The data for the request.
783
859
  * @param data.account Account name (e.g., "Assets:Bank:Checking")
860
+ * @param data.region Region code for tenant context
784
861
  * @param data.date Date to calculate balance at (ISO 8601 format)
785
862
  * @param data.currency Currency to query (e.g., "USD", "CNY")
786
863
  * @returns BalanceResponseDto Balance calculated successfully
@@ -790,6 +867,9 @@ var BeanBalancesService = class {
790
867
  return request(OpenAPI, {
791
868
  method: "GET",
792
869
  url: "/api/v1/{region}/bean/balances",
870
+ path: {
871
+ region: data.region
872
+ },
793
873
  query: {
794
874
  account: data.account,
795
875
  date: data.date,
@@ -804,13 +884,18 @@ var BeanBalancesService = class {
804
884
  /**
805
885
  * Query multi-currency account balance
806
886
  * Calculate account balances for all currencies at a specific date
887
+ * @param data The data for the request.
888
+ * @param data.region Region code for tenant context
807
889
  * @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
808
890
  * @throws ApiError
809
891
  */
810
- static balanceControllerGetMultiCurrencyBalance() {
892
+ static balanceControllerGetMultiCurrencyBalance(data) {
811
893
  return request(OpenAPI, {
812
894
  method: "GET",
813
895
  url: "/api/v1/{region}/bean/balances/multi-currency",
896
+ path: {
897
+ region: data.region
898
+ },
814
899
  errors: {
815
900
  400: "Invalid query parameters",
816
901
  401: "User not authenticated"
@@ -820,17 +905,26 @@ var BeanBalancesService = class {
820
905
  };
821
906
  var BeanCommoditiesService = class {
822
907
  /**
908
+ * Create a new commodity
909
+ * Creates a new commodity definition for the authenticated user
823
910
  * @param data The data for the request.
824
911
  * @param data.region Region code for tenant context
825
- * @returns unknown
912
+ * @param data.requestBody
913
+ * @returns CommodityResponseDto Commodity created successfully
826
914
  * @throws ApiError
827
915
  */
828
- static commodityController(data) {
916
+ static commodityControllerCreate(data) {
829
917
  return request(OpenAPI, {
830
918
  method: "POST",
831
919
  url: "/api/v1/{region}/bean/commodities",
832
920
  path: {
833
921
  region: data.region
922
+ },
923
+ body: data.requestBody,
924
+ mediaType: "application/json",
925
+ errors: {
926
+ 400: "Invalid input data",
927
+ 409: "Commodity already exists"
834
928
  }
835
929
  });
836
930
  }
@@ -880,57 +974,81 @@ var BeanCommoditiesService = class {
880
974
  });
881
975
  }
882
976
  /**
977
+ * Update commodity
978
+ * Updates an existing commodity definition. Symbol cannot be changed.
883
979
  * @param data The data for the request.
980
+ * @param data.symbol Commodity symbol
884
981
  * @param data.region Region code for tenant context
885
- * @returns unknown
982
+ * @param data.requestBody
983
+ * @returns CommodityResponseDto Commodity updated successfully
886
984
  * @throws ApiError
887
985
  */
888
- static commodityController1(data) {
986
+ static commodityControllerUpdate(data) {
889
987
  return request(OpenAPI, {
890
988
  method: "PUT",
891
989
  url: "/api/v1/{region}/bean/commodities/{symbol}",
892
990
  path: {
991
+ symbol: data.symbol,
893
992
  region: data.region
993
+ },
994
+ body: data.requestBody,
995
+ mediaType: "application/json",
996
+ errors: {
997
+ 400: "Invalid input data",
998
+ 404: "Commodity not found"
894
999
  }
895
1000
  });
896
1001
  }
897
1002
  /**
1003
+ * Delete commodity
1004
+ * Deletes a commodity definition
898
1005
  * @param data The data for the request.
1006
+ * @param data.symbol Commodity symbol
899
1007
  * @param data.region Region code for tenant context
900
- * @returns void
1008
+ * @returns void Commodity deleted successfully
901
1009
  * @throws ApiError
902
1010
  */
903
- static commodityController2(data) {
1011
+ static commodityControllerDelete(data) {
904
1012
  return request(OpenAPI, {
905
1013
  method: "DELETE",
906
1014
  url: "/api/v1/{region}/bean/commodities/{symbol}",
907
1015
  path: {
1016
+ symbol: data.symbol,
908
1017
  region: data.region
1018
+ },
1019
+ errors: {
1020
+ 404: "Commodity not found"
909
1021
  }
910
1022
  });
911
1023
  }
912
1024
  /**
1025
+ * Ensure commodity exists
1026
+ * Gets existing commodity or creates it with automatic initialization from OpenBB
913
1027
  * @param data The data for the request.
1028
+ * @param data.symbol Commodity symbol
914
1029
  * @param data.region Region code for tenant context
915
- * @returns unknown
1030
+ * @returns CommodityResponseDto Commodity retrieved or created
916
1031
  * @throws ApiError
917
1032
  */
918
- static commodityController3(data) {
1033
+ static commodityControllerGetOrCreate(data) {
919
1034
  return request(OpenAPI, {
920
1035
  method: "POST",
921
1036
  url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
922
1037
  path: {
1038
+ symbol: data.symbol,
923
1039
  region: data.region
924
1040
  }
925
1041
  });
926
1042
  }
927
1043
  /**
1044
+ * Bulk create commodities
1045
+ * Creates multiple commodities from a list of symbols, useful for initialization
928
1046
  * @param data The data for the request.
929
1047
  * @param data.region Region code for tenant context
930
- * @returns unknown
1048
+ * @returns CommodityResponseDto Commodities created successfully
931
1049
  * @throws ApiError
932
1050
  */
933
- static commodityController4(data) {
1051
+ static commodityControllerBulkCreate(data) {
934
1052
  return request(OpenAPI, {
935
1053
  method: "POST",
936
1054
  url: "/api/v1/{region}/bean/commodities/bulk",
@@ -991,13 +1109,18 @@ var ProviderSyncService = class {
991
1109
  /**
992
1110
  * Get supported providers
993
1111
  * Returns a list of all providers supported by the sync endpoint.
1112
+ * @param data The data for the request.
1113
+ * @param data.region Region code for tenant context
994
1114
  * @returns SupportedProvidersResponseDto List of supported providers
995
1115
  * @throws ApiError
996
1116
  */
997
- static providerSyncControllerGetSupportedProviders() {
1117
+ static providerSyncControllerGetSupportedProviders(data) {
998
1118
  return request(OpenAPI, {
999
1119
  method: "GET",
1000
1120
  url: "/api/v1/{region}/bean/import/provider/supported",
1121
+ path: {
1122
+ region: data.region
1123
+ },
1001
1124
  errors: {
1002
1125
  401: "Missing or invalid authentication"
1003
1126
  }
@@ -1008,6 +1131,7 @@ var ProviderSyncService = class {
1008
1131
  * Returns whether a specific provider is supported.
1009
1132
  * @param data The data for the request.
1010
1133
  * @param data.providerName Provider name to check
1134
+ * @param data.region Region code for tenant context
1011
1135
  * @returns unknown Provider support status
1012
1136
  * @throws ApiError
1013
1137
  */
@@ -1016,7 +1140,8 @@ var ProviderSyncService = class {
1016
1140
  method: "GET",
1017
1141
  url: "/api/v1/{region}/bean/import/provider/{providerName}/supported",
1018
1142
  path: {
1019
- providerName: data.providerName
1143
+ providerName: data.providerName,
1144
+ region: data.region
1020
1145
  },
1021
1146
  errors: {
1022
1147
  401: "Missing or invalid authentication"
@@ -1053,6 +1178,20 @@ var HealthService = class {
1053
1178
  }
1054
1179
  });
1055
1180
  }
1181
+ /**
1182
+ * Check OpenBB schema status
1183
+ * @returns unknown OpenBB status
1184
+ * @throws ApiError
1185
+ */
1186
+ static healthControllerCheckOpenBb() {
1187
+ return request(OpenAPI, {
1188
+ method: "GET",
1189
+ url: "/api/v1/health/openbb",
1190
+ errors: {
1191
+ 503: "OpenBB unavailable"
1192
+ }
1193
+ });
1194
+ }
1056
1195
  /**
1057
1196
  * Check Redis connection health
1058
1197
  * @returns unknown Redis is healthy
@@ -1116,62 +1255,6 @@ var HealthService = class {
1116
1255
  }
1117
1256
  });
1118
1257
  }
1119
- /**
1120
- * Check health of a specific data enhancer
1121
- * @param data The data for the request.
1122
- * @param data.name Data enhancer name
1123
- * @returns unknown Data enhancer is healthy
1124
- * @throws ApiError
1125
- */
1126
- static healthControllerGetHealthOfDataEnhancer(data) {
1127
- return request(OpenAPI, {
1128
- method: "GET",
1129
- url: "/api/v1/health/data-enhancer/{name}",
1130
- path: {
1131
- name: data.name
1132
- },
1133
- errors: {
1134
- 401: "Unauthorized",
1135
- 503: "Data enhancer unavailable"
1136
- }
1137
- });
1138
- }
1139
- /**
1140
- * Check health of all data providers
1141
- * @returns unknown Data providers health status
1142
- * @throws ApiError
1143
- */
1144
- static healthControllerCheckDataProviders() {
1145
- return request(OpenAPI, {
1146
- method: "GET",
1147
- url: "/api/v1/health/data-providers",
1148
- errors: {
1149
- 401: "Unauthorized",
1150
- 503: "Data providers check failed"
1151
- }
1152
- });
1153
- }
1154
- /**
1155
- * Check health of a specific data provider
1156
- * @param data The data for the request.
1157
- * @param data.dataSource Data source identifier
1158
- * @returns unknown Data provider is healthy
1159
- * @throws ApiError
1160
- */
1161
- static healthControllerGetHealthOfDataProvider(data) {
1162
- return request(OpenAPI, {
1163
- method: "GET",
1164
- url: "/api/v1/health/data-provider/{dataSource}",
1165
- path: {
1166
- dataSource: data.dataSource
1167
- },
1168
- errors: {
1169
- 400: "Invalid data source",
1170
- 401: "Unauthorized",
1171
- 503: "Data provider unavailable"
1172
- }
1173
- });
1174
- }
1175
1258
  };
1176
1259
  // Annotate the CommonJS export names for ESM import in node:
1177
1260
  0 && (module.exports = {