@firela/api-types 0.0.0-canary.209967 → 0.0.0-canary.20e5bd10
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.d.mts +5686 -2588
- package/dist/index.d.ts +5686 -2588
- package/dist/index.js +192 -131
- package/dist/index.mjs +192 -131
- package/package.json +2 -8
- package/src/generated/schemas.gen.ts +5561 -1916
- package/src/generated/services.gen.ts +2178 -1245
- package/src/generated/types.gen.ts +9355 -3182
package/dist/index.mjs
CHANGED
|
@@ -452,7 +452,7 @@ var BeanAccountsService = class {
|
|
|
452
452
|
* @param data.type Filter by account type
|
|
453
453
|
* @param data.status Filter by status
|
|
454
454
|
* @param data.isCustom Filter by custom (user-created) accounts only
|
|
455
|
-
* @param data.search Search term for path
|
|
455
|
+
* @param data.search Search term for account path
|
|
456
456
|
* @param data.limit Maximum number of results
|
|
457
457
|
* @param data.offset Number of results to skip
|
|
458
458
|
* @returns AccountListResponseDto Accounts retrieved successfully
|
|
@@ -524,7 +524,7 @@ var BeanAccountsService = class {
|
|
|
524
524
|
}
|
|
525
525
|
/**
|
|
526
526
|
* Delete account
|
|
527
|
-
* Deletes an account (only if no transactions)
|
|
527
|
+
* Deletes an account (only if no active transactions; voided/superseded residual postings are cleaned up)
|
|
528
528
|
* @param data The data for the request.
|
|
529
529
|
* @param data.id Account UUID
|
|
530
530
|
* @param data.region Region code for tenant context
|
|
@@ -541,7 +541,7 @@ var BeanAccountsService = class {
|
|
|
541
541
|
},
|
|
542
542
|
errors: {
|
|
543
543
|
404: "Account not found",
|
|
544
|
-
409: "Account has transactions and cannot be deleted"
|
|
544
|
+
409: "Account has active transactions and cannot be deleted"
|
|
545
545
|
}
|
|
546
546
|
});
|
|
547
547
|
}
|
|
@@ -597,11 +597,38 @@ var BeanAccountsService = class {
|
|
|
597
597
|
}
|
|
598
598
|
});
|
|
599
599
|
}
|
|
600
|
+
/**
|
|
601
|
+
* Post an opening-balance transaction
|
|
602
|
+
* Posts a double-entry opening-balance transaction against Equity:Opening-Balances for an existing Assets/Liabilities account. At most one active opening balance per account.
|
|
603
|
+
* @param data The data for the request.
|
|
604
|
+
* @param data.id Account UUID
|
|
605
|
+
* @param data.region Region code for tenant context
|
|
606
|
+
* @param data.requestBody
|
|
607
|
+
* @returns OpeningBalanceResultDto Opening-balance transaction created
|
|
608
|
+
* @throws ApiError
|
|
609
|
+
*/
|
|
610
|
+
static accountControllerAddOpeningBalance(data) {
|
|
611
|
+
return request(OpenAPI, {
|
|
612
|
+
method: "POST",
|
|
613
|
+
url: "/api/v1/{region}/bean/accounts/{id}/opening-balance",
|
|
614
|
+
path: {
|
|
615
|
+
id: data.id,
|
|
616
|
+
region: data.region
|
|
617
|
+
},
|
|
618
|
+
body: data.requestBody,
|
|
619
|
+
mediaType: "application/json",
|
|
620
|
+
errors: {
|
|
621
|
+
404: "Account not found",
|
|
622
|
+
409: "An opening balance already exists for this account"
|
|
623
|
+
}
|
|
624
|
+
});
|
|
625
|
+
}
|
|
600
626
|
};
|
|
601
627
|
var BeanTransactionsService = class {
|
|
602
628
|
/**
|
|
603
|
-
*
|
|
604
|
-
*
|
|
629
|
+
* @deprecated
|
|
630
|
+
* Create transaction (DEPRECATED)
|
|
631
|
+
* DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
|
|
605
632
|
* @param data The data for the request.
|
|
606
633
|
* @param data.region Region code for tenant context
|
|
607
634
|
* @param data.requestBody Transaction data with postings
|
|
@@ -637,6 +664,7 @@ var BeanTransactionsService = class {
|
|
|
637
664
|
* @param data.status Filter by transaction status
|
|
638
665
|
* @param data.search Search in narration and payee fields (max 200 chars)
|
|
639
666
|
* @param data.accountId Filter by account ID (transactions with postings to this account)
|
|
667
|
+
* @param data.category Filter by ADR-0075 functional category (Group segment); matches any posting to an Expenses/Income account whose derived Group segment equals this value
|
|
640
668
|
* @returns TransactionListResponseDto Transaction list
|
|
641
669
|
* @throws ApiError
|
|
642
670
|
*/
|
|
@@ -654,25 +682,93 @@ var BeanTransactionsService = class {
|
|
|
654
682
|
dateTo: data.dateTo,
|
|
655
683
|
status: data.status,
|
|
656
684
|
search: data.search,
|
|
657
|
-
accountId: data.accountId
|
|
685
|
+
accountId: data.accountId,
|
|
686
|
+
category: data.category
|
|
658
687
|
},
|
|
659
688
|
errors: {
|
|
689
|
+
400: "Validation failed",
|
|
660
690
|
401: "Authentication required"
|
|
661
691
|
}
|
|
662
692
|
});
|
|
663
693
|
}
|
|
664
694
|
/**
|
|
695
|
+
* @deprecated
|
|
696
|
+
* Batch create transactions (DEPRECATED)
|
|
697
|
+
* DEPRECATED: Use POST /:region/bean/import/provider/:name/sync instead. This endpoint skips dedup, rule matching, and review branching.
|
|
665
698
|
* @param data The data for the request.
|
|
666
699
|
* @param data.region Region code for tenant context
|
|
667
|
-
* @
|
|
700
|
+
* @param data.requestBody
|
|
701
|
+
* @returns BatchTransactionResponseDto Transactions processed
|
|
668
702
|
* @throws ApiError
|
|
669
703
|
*/
|
|
670
|
-
static
|
|
704
|
+
static transactionControllerCreateBatch(data) {
|
|
671
705
|
return request(OpenAPI, {
|
|
672
706
|
method: "POST",
|
|
673
707
|
url: "/api/v1/{region}/bean/transactions/batch",
|
|
674
708
|
path: {
|
|
675
709
|
region: data.region
|
|
710
|
+
},
|
|
711
|
+
body: data.requestBody,
|
|
712
|
+
mediaType: "application/json",
|
|
713
|
+
errors: {
|
|
714
|
+
400: "Invalid input",
|
|
715
|
+
401: "Authentication required"
|
|
716
|
+
}
|
|
717
|
+
});
|
|
718
|
+
}
|
|
719
|
+
/**
|
|
720
|
+
* Correct (supersede) a transaction
|
|
721
|
+
* Atomically voids the original (SUPERSEDED) and creates a replacement through the full validation pipeline.
|
|
722
|
+
* @param data The data for the request.
|
|
723
|
+
* @param data.id Original transaction ID to correct
|
|
724
|
+
* @param data.region Region code for tenant context
|
|
725
|
+
* @param data.requestBody
|
|
726
|
+
* @returns TransactionDetailDto Corrected transaction created
|
|
727
|
+
* @throws ApiError
|
|
728
|
+
*/
|
|
729
|
+
static transactionControllerCorrect(data) {
|
|
730
|
+
return request(OpenAPI, {
|
|
731
|
+
method: "POST",
|
|
732
|
+
url: "/api/v1/{region}/bean/transactions/{id}/correct",
|
|
733
|
+
path: {
|
|
734
|
+
id: data.id,
|
|
735
|
+
region: data.region
|
|
736
|
+
},
|
|
737
|
+
body: data.requestBody,
|
|
738
|
+
mediaType: "application/json",
|
|
739
|
+
errors: {
|
|
740
|
+
404: "Original transaction not found",
|
|
741
|
+
409: "Original no longer ACTIVE (concurrent modification)",
|
|
742
|
+
422: "Pipeline validation failed (does not balance, invalid accounts)"
|
|
743
|
+
}
|
|
744
|
+
});
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* Suggest transaction tags
|
|
748
|
+
* Returns distinct tags from the user ACTIVE transactions, sorted by usage, for autocomplete. Optional q performs a case-insensitive prefix match.
|
|
749
|
+
* @param data The data for the request.
|
|
750
|
+
* @param data.region Region code for tenant context
|
|
751
|
+
* @param data.q Prefix match, case-insensitive (max 50 chars)
|
|
752
|
+
* @param data.sort usage (default) or name
|
|
753
|
+
* @param data.limit Max suggestions (1-100, default 10)
|
|
754
|
+
* @returns TagSuggestionsResponseDto Tag suggestions
|
|
755
|
+
* @throws ApiError
|
|
756
|
+
*/
|
|
757
|
+
static transactionControllerSuggestTags(data) {
|
|
758
|
+
return request(OpenAPI, {
|
|
759
|
+
method: "GET",
|
|
760
|
+
url: "/api/v1/{region}/bean/transactions/tags",
|
|
761
|
+
path: {
|
|
762
|
+
region: data.region
|
|
763
|
+
},
|
|
764
|
+
query: {
|
|
765
|
+
q: data.q,
|
|
766
|
+
sort: data.sort,
|
|
767
|
+
limit: data.limit
|
|
768
|
+
},
|
|
769
|
+
errors: {
|
|
770
|
+
400: "Validation failed",
|
|
771
|
+
401: "Authentication required"
|
|
676
772
|
}
|
|
677
773
|
});
|
|
678
774
|
}
|
|
@@ -727,17 +823,26 @@ var BeanTransactionsService = class {
|
|
|
727
823
|
});
|
|
728
824
|
}
|
|
729
825
|
/**
|
|
826
|
+
* Void transaction
|
|
827
|
+
* Soft-deletes a transaction by marking it as VOIDED
|
|
730
828
|
* @param data The data for the request.
|
|
829
|
+
* @param data.id Transaction ID
|
|
731
830
|
* @param data.region Region code for tenant context
|
|
732
|
-
* @returns void
|
|
831
|
+
* @returns void Transaction voided successfully
|
|
733
832
|
* @throws ApiError
|
|
734
833
|
*/
|
|
735
|
-
static
|
|
834
|
+
static transactionControllerDelete(data) {
|
|
736
835
|
return request(OpenAPI, {
|
|
737
836
|
method: "DELETE",
|
|
738
837
|
url: "/api/v1/{region}/bean/transactions/{id}",
|
|
739
838
|
path: {
|
|
839
|
+
id: data.id,
|
|
740
840
|
region: data.region
|
|
841
|
+
},
|
|
842
|
+
errors: {
|
|
843
|
+
400: "Transaction already voided",
|
|
844
|
+
401: "Authentication required",
|
|
845
|
+
404: "Transaction not found"
|
|
741
846
|
}
|
|
742
847
|
});
|
|
743
848
|
}
|
|
@@ -747,8 +852,8 @@ var BeanBalancesService = class {
|
|
|
747
852
|
* Query account balance
|
|
748
853
|
* Calculate account balance at a specific date for a single currency
|
|
749
854
|
* @param data The data for the request.
|
|
750
|
-
* @param data.account Account name (e.g., "Assets:
|
|
751
|
-
* @param data.region Region code
|
|
855
|
+
* @param data.account Account name (e.g., "Assets:Checking")
|
|
856
|
+
* @param data.region Region code for tenant context
|
|
752
857
|
* @param data.date Date to calculate balance at (ISO 8601 format)
|
|
753
858
|
* @param data.currency Currency to query (e.g., "USD", "CNY")
|
|
754
859
|
* @returns BalanceResponseDto Balance calculated successfully
|
|
@@ -776,7 +881,7 @@ var BeanBalancesService = class {
|
|
|
776
881
|
* Query multi-currency account balance
|
|
777
882
|
* Calculate account balances for all currencies at a specific date
|
|
778
883
|
* @param data The data for the request.
|
|
779
|
-
* @param data.region Region code
|
|
884
|
+
* @param data.region Region code for tenant context
|
|
780
885
|
* @returns MultiCurrencyBalanceResponseDto Balances calculated successfully
|
|
781
886
|
* @throws ApiError
|
|
782
887
|
*/
|
|
@@ -796,17 +901,26 @@ var BeanBalancesService = class {
|
|
|
796
901
|
};
|
|
797
902
|
var BeanCommoditiesService = class {
|
|
798
903
|
/**
|
|
904
|
+
* Create a new commodity
|
|
905
|
+
* Creates a new commodity definition for the authenticated user
|
|
799
906
|
* @param data The data for the request.
|
|
800
|
-
* @param data.region Region code
|
|
801
|
-
* @
|
|
907
|
+
* @param data.region Region code for tenant context
|
|
908
|
+
* @param data.requestBody
|
|
909
|
+
* @returns CommodityResponseDto Commodity created successfully
|
|
802
910
|
* @throws ApiError
|
|
803
911
|
*/
|
|
804
|
-
static
|
|
912
|
+
static commodityControllerCreate(data) {
|
|
805
913
|
return request(OpenAPI, {
|
|
806
914
|
method: "POST",
|
|
807
915
|
url: "/api/v1/{region}/bean/commodities",
|
|
808
916
|
path: {
|
|
809
917
|
region: data.region
|
|
918
|
+
},
|
|
919
|
+
body: data.requestBody,
|
|
920
|
+
mediaType: "application/json",
|
|
921
|
+
errors: {
|
|
922
|
+
400: "Invalid input data",
|
|
923
|
+
409: "Commodity already exists"
|
|
810
924
|
}
|
|
811
925
|
});
|
|
812
926
|
}
|
|
@@ -814,7 +928,7 @@ var BeanCommoditiesService = class {
|
|
|
814
928
|
* List user commodities
|
|
815
929
|
* Returns all commodity definitions for the authenticated user with optional filtering
|
|
816
930
|
* @param data The data for the request.
|
|
817
|
-
* @param data.region Region code
|
|
931
|
+
* @param data.region Region code for tenant context
|
|
818
932
|
* @param data.search Search term for symbol or metadata fields (partial match). Searches symbol and metadata.name.
|
|
819
933
|
* @param data.symbol Filter by exact symbol match
|
|
820
934
|
* @returns CommodityListResponseDto Commodities retrieved successfully
|
|
@@ -838,7 +952,7 @@ var BeanCommoditiesService = class {
|
|
|
838
952
|
* Returns a specific commodity definition by its symbol
|
|
839
953
|
* @param data The data for the request.
|
|
840
954
|
* @param data.symbol Commodity symbol
|
|
841
|
-
* @param data.region Region code
|
|
955
|
+
* @param data.region Region code for tenant context
|
|
842
956
|
* @returns CommodityResponseDto Commodity retrieved successfully
|
|
843
957
|
* @throws ApiError
|
|
844
958
|
*/
|
|
@@ -856,57 +970,81 @@ var BeanCommoditiesService = class {
|
|
|
856
970
|
});
|
|
857
971
|
}
|
|
858
972
|
/**
|
|
973
|
+
* Update commodity
|
|
974
|
+
* Updates an existing commodity definition. Symbol cannot be changed.
|
|
859
975
|
* @param data The data for the request.
|
|
860
|
-
* @param data.
|
|
861
|
-
* @
|
|
976
|
+
* @param data.symbol Commodity symbol
|
|
977
|
+
* @param data.region Region code for tenant context
|
|
978
|
+
* @param data.requestBody
|
|
979
|
+
* @returns CommodityResponseDto Commodity updated successfully
|
|
862
980
|
* @throws ApiError
|
|
863
981
|
*/
|
|
864
|
-
static
|
|
982
|
+
static commodityControllerUpdate(data) {
|
|
865
983
|
return request(OpenAPI, {
|
|
866
984
|
method: "PUT",
|
|
867
985
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
868
986
|
path: {
|
|
987
|
+
symbol: data.symbol,
|
|
869
988
|
region: data.region
|
|
989
|
+
},
|
|
990
|
+
body: data.requestBody,
|
|
991
|
+
mediaType: "application/json",
|
|
992
|
+
errors: {
|
|
993
|
+
400: "Invalid input data",
|
|
994
|
+
404: "Commodity not found"
|
|
870
995
|
}
|
|
871
996
|
});
|
|
872
997
|
}
|
|
873
998
|
/**
|
|
999
|
+
* Delete commodity
|
|
1000
|
+
* Deletes a commodity definition
|
|
874
1001
|
* @param data The data for the request.
|
|
875
|
-
* @param data.
|
|
876
|
-
* @
|
|
1002
|
+
* @param data.symbol Commodity symbol
|
|
1003
|
+
* @param data.region Region code for tenant context
|
|
1004
|
+
* @returns void Commodity deleted successfully
|
|
877
1005
|
* @throws ApiError
|
|
878
1006
|
*/
|
|
879
|
-
static
|
|
1007
|
+
static commodityControllerDelete(data) {
|
|
880
1008
|
return request(OpenAPI, {
|
|
881
1009
|
method: "DELETE",
|
|
882
1010
|
url: "/api/v1/{region}/bean/commodities/{symbol}",
|
|
883
1011
|
path: {
|
|
1012
|
+
symbol: data.symbol,
|
|
884
1013
|
region: data.region
|
|
1014
|
+
},
|
|
1015
|
+
errors: {
|
|
1016
|
+
404: "Commodity not found"
|
|
885
1017
|
}
|
|
886
1018
|
});
|
|
887
1019
|
}
|
|
888
1020
|
/**
|
|
1021
|
+
* Ensure commodity exists
|
|
1022
|
+
* Gets existing commodity or creates it with automatic initialization from OpenBB
|
|
889
1023
|
* @param data The data for the request.
|
|
890
|
-
* @param data.
|
|
891
|
-
* @
|
|
1024
|
+
* @param data.symbol Commodity symbol
|
|
1025
|
+
* @param data.region Region code for tenant context
|
|
1026
|
+
* @returns CommodityResponseDto Commodity retrieved or created
|
|
892
1027
|
* @throws ApiError
|
|
893
1028
|
*/
|
|
894
|
-
static
|
|
1029
|
+
static commodityControllerGetOrCreate(data) {
|
|
895
1030
|
return request(OpenAPI, {
|
|
896
1031
|
method: "POST",
|
|
897
1032
|
url: "/api/v1/{region}/bean/commodities/{symbol}/ensure",
|
|
898
1033
|
path: {
|
|
1034
|
+
symbol: data.symbol,
|
|
899
1035
|
region: data.region
|
|
900
1036
|
}
|
|
901
1037
|
});
|
|
902
1038
|
}
|
|
903
1039
|
/**
|
|
1040
|
+
* Bulk create commodities
|
|
1041
|
+
* Creates multiple commodities from a list of symbols, useful for initialization
|
|
904
1042
|
* @param data The data for the request.
|
|
905
|
-
* @param data.region Region code
|
|
906
|
-
* @returns
|
|
1043
|
+
* @param data.region Region code for tenant context
|
|
1044
|
+
* @returns CommodityResponseDto Commodities created successfully
|
|
907
1045
|
* @throws ApiError
|
|
908
1046
|
*/
|
|
909
|
-
static
|
|
1047
|
+
static commodityControllerBulkCreate(data) {
|
|
910
1048
|
return request(OpenAPI, {
|
|
911
1049
|
method: "POST",
|
|
912
1050
|
url: "/api/v1/{region}/bean/commodities/bulk",
|
|
@@ -930,6 +1068,7 @@ var ProviderSyncService = class {
|
|
|
930
1068
|
* - **simplefin**: SimpleFIN (Self-hosted)
|
|
931
1069
|
* - **yodlee**: Yodlee (Global)
|
|
932
1070
|
* - **beancount-direct**: Beancount format transactions
|
|
1071
|
+
* - **parsed-bill**: Client-side parsed bill transactions
|
|
933
1072
|
*
|
|
934
1073
|
* **Processing Flow:**
|
|
935
1074
|
* 1. Transform raw data via provider adapter
|
|
@@ -941,7 +1080,7 @@ var ProviderSyncService = class {
|
|
|
941
1080
|
*
|
|
942
1081
|
* @param data The data for the request.
|
|
943
1082
|
* @param data.providerName Provider name
|
|
944
|
-
* @param data.region Region code
|
|
1083
|
+
* @param data.region Region code for tenant context
|
|
945
1084
|
* @param data.requestBody
|
|
946
1085
|
* @returns ProviderSyncResponseDto Sync completed successfully
|
|
947
1086
|
* @throws ApiError
|
|
@@ -967,7 +1106,7 @@ var ProviderSyncService = class {
|
|
|
967
1106
|
* Get supported providers
|
|
968
1107
|
* Returns a list of all providers supported by the sync endpoint.
|
|
969
1108
|
* @param data The data for the request.
|
|
970
|
-
* @param data.region Region code
|
|
1109
|
+
* @param data.region Region code for tenant context
|
|
971
1110
|
* @returns SupportedProvidersResponseDto List of supported providers
|
|
972
1111
|
* @throws ApiError
|
|
973
1112
|
*/
|
|
@@ -988,7 +1127,7 @@ var ProviderSyncService = class {
|
|
|
988
1127
|
* Returns whether a specific provider is supported.
|
|
989
1128
|
* @param data The data for the request.
|
|
990
1129
|
* @param data.providerName Provider name to check
|
|
991
|
-
* @param data.region Region code
|
|
1130
|
+
* @param data.region Region code for tenant context
|
|
992
1131
|
* @returns unknown Provider support status
|
|
993
1132
|
* @throws ApiError
|
|
994
1133
|
*/
|
|
@@ -1009,18 +1148,13 @@ var ProviderSyncService = class {
|
|
|
1009
1148
|
var HealthService = class {
|
|
1010
1149
|
/**
|
|
1011
1150
|
* 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
1151
|
* @returns unknown Service is healthy
|
|
1015
1152
|
* @throws ApiError
|
|
1016
1153
|
*/
|
|
1017
|
-
static healthControllerGetHealth(
|
|
1154
|
+
static healthControllerGetHealth() {
|
|
1018
1155
|
return request(OpenAPI, {
|
|
1019
1156
|
method: "GET",
|
|
1020
1157
|
url: "/api/v1/health",
|
|
1021
|
-
path: {
|
|
1022
|
-
region: data.region
|
|
1023
|
-
},
|
|
1024
1158
|
errors: {
|
|
1025
1159
|
503: "Service unavailable"
|
|
1026
1160
|
}
|
|
@@ -1028,37 +1162,41 @@ var HealthService = class {
|
|
|
1028
1162
|
}
|
|
1029
1163
|
/**
|
|
1030
1164
|
* Check database connection health
|
|
1031
|
-
* @param data The data for the request.
|
|
1032
|
-
* @param data.region Region code (cn, us, de)
|
|
1033
1165
|
* @returns unknown Database is healthy
|
|
1034
1166
|
* @throws ApiError
|
|
1035
1167
|
*/
|
|
1036
|
-
static healthControllerCheckDatabase(
|
|
1168
|
+
static healthControllerCheckDatabase() {
|
|
1037
1169
|
return request(OpenAPI, {
|
|
1038
1170
|
method: "GET",
|
|
1039
1171
|
url: "/api/v1/health/database",
|
|
1040
|
-
path: {
|
|
1041
|
-
region: data.region
|
|
1042
|
-
},
|
|
1043
1172
|
errors: {
|
|
1044
1173
|
503: "Database unavailable"
|
|
1045
1174
|
}
|
|
1046
1175
|
});
|
|
1047
1176
|
}
|
|
1177
|
+
/**
|
|
1178
|
+
* Check OpenBB schema status
|
|
1179
|
+
* @returns unknown OpenBB status
|
|
1180
|
+
* @throws ApiError
|
|
1181
|
+
*/
|
|
1182
|
+
static healthControllerCheckOpenBb() {
|
|
1183
|
+
return request(OpenAPI, {
|
|
1184
|
+
method: "GET",
|
|
1185
|
+
url: "/api/v1/health/openbb",
|
|
1186
|
+
errors: {
|
|
1187
|
+
503: "OpenBB unavailable"
|
|
1188
|
+
}
|
|
1189
|
+
});
|
|
1190
|
+
}
|
|
1048
1191
|
/**
|
|
1049
1192
|
* Check Redis connection health
|
|
1050
|
-
* @param data The data for the request.
|
|
1051
|
-
* @param data.region Region code (cn, us, de)
|
|
1052
1193
|
* @returns unknown Redis is healthy
|
|
1053
1194
|
* @throws ApiError
|
|
1054
1195
|
*/
|
|
1055
|
-
static healthControllerCheckRedis(
|
|
1196
|
+
static healthControllerCheckRedis() {
|
|
1056
1197
|
return request(OpenAPI, {
|
|
1057
1198
|
method: "GET",
|
|
1058
1199
|
url: "/api/v1/health/redis",
|
|
1059
|
-
path: {
|
|
1060
|
-
region: data.region
|
|
1061
|
-
},
|
|
1062
1200
|
errors: {
|
|
1063
1201
|
503: "Redis unavailable"
|
|
1064
1202
|
}
|
|
@@ -1066,18 +1204,13 @@ var HealthService = class {
|
|
|
1066
1204
|
}
|
|
1067
1205
|
/**
|
|
1068
1206
|
* Get status of all circuit breakers
|
|
1069
|
-
* @param data The data for the request.
|
|
1070
|
-
* @param data.region Region code (cn, us, de)
|
|
1071
1207
|
* @returns unknown Circuit breaker status
|
|
1072
1208
|
* @throws ApiError
|
|
1073
1209
|
*/
|
|
1074
|
-
static healthControllerGetCircuitBreakersHealth(
|
|
1210
|
+
static healthControllerGetCircuitBreakersHealth() {
|
|
1075
1211
|
return request(OpenAPI, {
|
|
1076
1212
|
method: "GET",
|
|
1077
1213
|
url: "/api/v1/health/circuit-breakers",
|
|
1078
|
-
path: {
|
|
1079
|
-
region: data.region
|
|
1080
|
-
},
|
|
1081
1214
|
errors: {
|
|
1082
1215
|
401: "Unauthorized",
|
|
1083
1216
|
500: "Internal error"
|
|
@@ -1088,7 +1221,6 @@ var HealthService = class {
|
|
|
1088
1221
|
* Reset a circuit breaker to CLOSED state
|
|
1089
1222
|
* @param data The data for the request.
|
|
1090
1223
|
* @param data.name Circuit breaker name to reset
|
|
1091
|
-
* @param data.region Region code (cn, us, de)
|
|
1092
1224
|
* @returns unknown Circuit breaker reset successfully
|
|
1093
1225
|
* @throws ApiError
|
|
1094
1226
|
*/
|
|
@@ -1097,8 +1229,7 @@ var HealthService = class {
|
|
|
1097
1229
|
method: "POST",
|
|
1098
1230
|
url: "/api/v1/health/circuit-breakers/{name}/reset",
|
|
1099
1231
|
path: {
|
|
1100
|
-
name: data.name
|
|
1101
|
-
region: data.region
|
|
1232
|
+
name: data.name
|
|
1102
1233
|
},
|
|
1103
1234
|
errors: {
|
|
1104
1235
|
401: "Unauthorized",
|
|
@@ -1108,88 +1239,18 @@ var HealthService = class {
|
|
|
1108
1239
|
}
|
|
1109
1240
|
/**
|
|
1110
1241
|
* Get health check metrics and statistics
|
|
1111
|
-
* @param data The data for the request.
|
|
1112
|
-
* @param data.region Region code (cn, us, de)
|
|
1113
1242
|
* @returns unknown Health metrics
|
|
1114
1243
|
* @throws ApiError
|
|
1115
1244
|
*/
|
|
1116
|
-
static healthControllerGetMetrics(
|
|
1245
|
+
static healthControllerGetMetrics() {
|
|
1117
1246
|
return request(OpenAPI, {
|
|
1118
1247
|
method: "GET",
|
|
1119
1248
|
url: "/api/v1/health/metrics",
|
|
1120
|
-
path: {
|
|
1121
|
-
region: data.region
|
|
1122
|
-
},
|
|
1123
1249
|
errors: {
|
|
1124
1250
|
401: "Unauthorized"
|
|
1125
1251
|
}
|
|
1126
1252
|
});
|
|
1127
1253
|
}
|
|
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
1254
|
};
|
|
1194
1255
|
export {
|
|
1195
1256
|
BeanAccountsService,
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@firela/api-types",
|
|
3
|
-
"version": "0.0.0-canary.
|
|
3
|
+
"version": "0.0.0-canary.20e5bd10",
|
|
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
|
-
"
|
|
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"
|