@orbis-systems/orbis-api-clients 0.7.14 → 0.7.16
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/aesmidas/index.d.ts +197 -163
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +710 -558
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +410 -131
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +156 -87
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +911 -1067
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +475 -774
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +263 -245
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -94,26 +94,58 @@ export interface BridgeWiseExportRow {
|
|
|
94
94
|
feedback_reason: string;
|
|
95
95
|
answer_requested_by_user: boolean;
|
|
96
96
|
}
|
|
97
|
-
export interface
|
|
97
|
+
export interface BridgeWiseExternalQuestionResponse {
|
|
98
|
+
message: string;
|
|
99
|
+
message_id: string;
|
|
100
|
+
}
|
|
101
|
+
/** LanguageEnum */
|
|
102
|
+
export enum BridgeWiseLanguageEnum {
|
|
103
|
+
ArSA = "ar-SA",
|
|
104
|
+
DeDE = "de-DE",
|
|
105
|
+
EnUS = "en-US",
|
|
106
|
+
EsES = "es-ES",
|
|
107
|
+
FrFR = "fr-FR",
|
|
108
|
+
HeIL = "he-IL",
|
|
109
|
+
NlNL = "nl-NL",
|
|
110
|
+
PtBR = "pt-BR",
|
|
111
|
+
TrTR = "tr-TR",
|
|
112
|
+
ZhCN = "zh-CN",
|
|
113
|
+
JaJP = "ja-JP",
|
|
114
|
+
KoKR = "ko-KR",
|
|
115
|
+
ThTH = "th-TH",
|
|
116
|
+
ZhHK = "zh-HK"
|
|
117
|
+
}
|
|
118
|
+
export interface BridgeWiseQuestionsRequest {
|
|
98
119
|
/**
|
|
99
120
|
* Question to ask like: What are the latest news about Nvidia?
|
|
100
121
|
* @maxLength 2000
|
|
101
122
|
*/
|
|
102
123
|
message: string;
|
|
103
124
|
/**
|
|
104
|
-
* Single chat session ID like:
|
|
125
|
+
* Single chat session ID like: 848e71ee-b907-4b9b-bdcd-2efe00eb40cd
|
|
105
126
|
* @maxLength 256
|
|
106
127
|
*/
|
|
107
128
|
session_id: string;
|
|
108
129
|
/**
|
|
109
|
-
* Language type like 'en', '
|
|
110
|
-
*
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
130
|
+
* Language type like 'en-US', 'he-IL', 'ja-JP'
|
|
131
|
+
*
|
|
132
|
+
* * `en-US` - en
|
|
133
|
+
* * `he-IL` - he
|
|
134
|
+
* * `zh-CN` - zh
|
|
135
|
+
* * `zh-HK` - zh_HK
|
|
136
|
+
* * `zh-TW` - zh_TW
|
|
137
|
+
* * `pt-BR` - pt
|
|
138
|
+
* * `ar-SA` - ar
|
|
139
|
+
* * `es-ES` - es
|
|
140
|
+
* * `nl-NL` - nl
|
|
141
|
+
* * `tr-TR` - tr
|
|
142
|
+
* * `de-DE` - de
|
|
143
|
+
* * `fr-FR` - fr
|
|
144
|
+
* * `ja-JP` - ja
|
|
145
|
+
* * `th-TH` - th
|
|
146
|
+
* * `ko-KR` - ko
|
|
147
|
+
*/
|
|
148
|
+
language?: BridgeWiseLanguageEnum;
|
|
117
149
|
}
|
|
118
150
|
/**
|
|
119
151
|
* AnalysisResultV2
|
|
@@ -384,23 +416,6 @@ export interface BridgeWiseIndustryDescriptionResultV2 {
|
|
|
384
416
|
/** Data */
|
|
385
417
|
data: BridgeWiseIndustryDescription[];
|
|
386
418
|
}
|
|
387
|
-
/** LanguageEnum */
|
|
388
|
-
export enum BridgeWiseLanguageEnum {
|
|
389
|
-
ArSA = "ar-SA",
|
|
390
|
-
DeDE = "de-DE",
|
|
391
|
-
EnUS = "en-US",
|
|
392
|
-
EsES = "es-ES",
|
|
393
|
-
FrFR = "fr-FR",
|
|
394
|
-
HeIL = "he-IL",
|
|
395
|
-
NlNL = "nl-NL",
|
|
396
|
-
PtBR = "pt-BR",
|
|
397
|
-
TrTR = "tr-TR",
|
|
398
|
-
ZhCN = "zh-CN",
|
|
399
|
-
JaJP = "ja-JP",
|
|
400
|
-
KoKR = "ko-KR",
|
|
401
|
-
ThTH = "th-TH",
|
|
402
|
-
ZhHK = "zh-HK"
|
|
403
|
-
}
|
|
404
419
|
/**
|
|
405
420
|
* Sentiment
|
|
406
421
|
* Pydantic model representing trading sentiments.
|
|
@@ -893,11 +908,14 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
893
908
|
ValueAnalysisEsgScoreGroup = "-analysis_esg_score_group",
|
|
894
909
|
ValueAnalysisFundamentalScore = "-analysis_fundamental_score",
|
|
895
910
|
ValueAnalysisFundamentalScoreGroup = "-analysis_fundamental_score_group",
|
|
911
|
+
ValueAnalysisTechnicalScore = "-analysis_technical_score",
|
|
896
912
|
ValueAssetsTurnover = "-assets_turnover",
|
|
897
913
|
ValueAverageRevenuePerSubscriber = "-average_revenue_per_subscriber",
|
|
898
914
|
ValueBeta = "-beta",
|
|
899
915
|
ValueBeta1Year = "-beta_1_year",
|
|
900
916
|
ValueBeta1Y = "-beta_1y",
|
|
917
|
+
ValueConsensusAnalystCount = "-consensus_analyst_count",
|
|
918
|
+
ValueConsensusScoreGroup = "-consensus_score_group",
|
|
901
919
|
ValueCurrentPeRatio = "-current_pe_ratio",
|
|
902
920
|
ValueCurrentRatio = "-current_ratio",
|
|
903
921
|
ValueDividendYield = "-dividend_yield",
|
|
@@ -921,6 +939,7 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
921
939
|
ValueNetEpsBasic = "-net_eps_basic",
|
|
922
940
|
ValueNetEpsDiluted = "-net_eps_diluted",
|
|
923
941
|
ValueNetIncomeMarginPercent = "-net_income_margin_percent",
|
|
942
|
+
ValueNewsSentiment = "-news_sentiment",
|
|
924
943
|
ValueOperatingCashFlowByCurrentLiabilities = "-operating_cash_flow_by_current_liabilities",
|
|
925
944
|
ValuePayoutRatio = "-payout_ratio",
|
|
926
945
|
ValuePctOfEquityHoldings = "-pct_of_equity_holdings",
|
|
@@ -956,6 +975,7 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
956
975
|
ValueSectorScore = "-sector_score",
|
|
957
976
|
ValueSectorScoreGroup = "-sector_score_group",
|
|
958
977
|
ValueSharpeRatio1Y = "-sharpe_ratio_1y",
|
|
978
|
+
ValueTargetPriceToLastClose = "-target_price_to_last_close",
|
|
959
979
|
ValueTotalDebtToCapitalPercent = "-total_debt_to_capital_percent",
|
|
960
980
|
ValueTotalDebtToEquity = "-total_debt_to_equity",
|
|
961
981
|
ValueTotalRevenues = "-total_revenues",
|
|
@@ -964,11 +984,14 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
964
984
|
AnalysisEsgScoreGroup = "analysis_esg_score_group",
|
|
965
985
|
AnalysisFundamentalScore = "analysis_fundamental_score",
|
|
966
986
|
AnalysisFundamentalScoreGroup = "analysis_fundamental_score_group",
|
|
987
|
+
AnalysisTechnicalScore = "analysis_technical_score",
|
|
967
988
|
AssetsTurnover = "assets_turnover",
|
|
968
989
|
AverageRevenuePerSubscriber = "average_revenue_per_subscriber",
|
|
969
990
|
Beta = "beta",
|
|
970
991
|
Beta1Year = "beta_1_year",
|
|
971
992
|
Beta1Y = "beta_1y",
|
|
993
|
+
ConsensusAnalystCount = "consensus_analyst_count",
|
|
994
|
+
ConsensusScoreGroup = "consensus_score_group",
|
|
972
995
|
CurrentPeRatio = "current_pe_ratio",
|
|
973
996
|
CurrentRatio = "current_ratio",
|
|
974
997
|
DividendYield = "dividend_yield",
|
|
@@ -992,6 +1015,7 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
992
1015
|
NetEpsBasic = "net_eps_basic",
|
|
993
1016
|
NetEpsDiluted = "net_eps_diluted",
|
|
994
1017
|
NetIncomeMarginPercent = "net_income_margin_percent",
|
|
1018
|
+
NewsSentiment = "news_sentiment",
|
|
995
1019
|
OperatingCashFlowByCurrentLiabilities = "operating_cash_flow_by_current_liabilities",
|
|
996
1020
|
PayoutRatio = "payout_ratio",
|
|
997
1021
|
PctOfEquityHoldings = "pct_of_equity_holdings",
|
|
@@ -1027,6 +1051,7 @@ export enum BridgeWiseCompaniesSortByEnum {
|
|
|
1027
1051
|
SectorScore = "sector_score",
|
|
1028
1052
|
SectorScoreGroup = "sector_score_group",
|
|
1029
1053
|
SharpeRatio1Y = "sharpe_ratio_1y",
|
|
1054
|
+
TargetPriceToLastClose = "target_price_to_last_close",
|
|
1030
1055
|
TotalDebtToCapitalPercent = "total_debt_to_capital_percent",
|
|
1031
1056
|
TotalDebtToEquity = "total_debt_to_equity",
|
|
1032
1057
|
TotalRevenues = "total_revenues",
|
|
@@ -1100,7 +1125,7 @@ export interface BridgeWiseCompanyFilterResponse {
|
|
|
1100
1125
|
/** Value */
|
|
1101
1126
|
value: string;
|
|
1102
1127
|
/** Id */
|
|
1103
|
-
id: number;
|
|
1128
|
+
id: number | number[];
|
|
1104
1129
|
/** Language */
|
|
1105
1130
|
language: string;
|
|
1106
1131
|
}
|
|
@@ -1109,8 +1134,10 @@ export enum BridgeWiseCompanyFilterType {
|
|
|
1109
1134
|
Countries = "countries",
|
|
1110
1135
|
GicsIndustry = "gics_industry",
|
|
1111
1136
|
GicsSector = "gics_sector",
|
|
1137
|
+
ThemeEmphasis = "theme_emphasis",
|
|
1112
1138
|
Regions = "regions",
|
|
1113
1139
|
GicsGroup = "gics_group",
|
|
1140
|
+
GicsIndustryGroup = "gics_industry_group",
|
|
1114
1141
|
Currency = "currency",
|
|
1115
1142
|
Exchange = "exchange",
|
|
1116
1143
|
CsaIndustry = "csa_industry",
|
|
@@ -1306,6 +1333,7 @@ export enum BridgeWiseFundsSortByEnum {
|
|
|
1306
1333
|
ValueLastCloseMarketCapUsd = "-last_close_market_cap_usd",
|
|
1307
1334
|
ValueMarketBenchmarkId = "-market_benchmark_id",
|
|
1308
1335
|
ValueMaxConcentration = "-max_concentration",
|
|
1336
|
+
ValueNumberOfHoldings = "-number_of_holdings",
|
|
1309
1337
|
ValuePctOfEquityHoldings = "-pct_of_equity_holdings",
|
|
1310
1338
|
ValuePriceCurrencyIso3 = "-price_currency_iso3",
|
|
1311
1339
|
ValuePrimaryBenchmarkId = "-primary_benchmark_id",
|
|
@@ -1330,6 +1358,7 @@ export enum BridgeWiseFundsSortByEnum {
|
|
|
1330
1358
|
ValueSharpeRatio1Y = "-sharpe_ratio_1y",
|
|
1331
1359
|
ValueSponsorAumUsd = "-sponsor_aum_usd",
|
|
1332
1360
|
ValueTrackingError1Y = "-tracking_error_1y",
|
|
1361
|
+
ValueTradingVolumeRatio = "-trading_volume_ratio",
|
|
1333
1362
|
ValueValueFactor = "-value_factor",
|
|
1334
1363
|
ValueValueFactorGroup = "-value_factor_group",
|
|
1335
1364
|
ValueVehicleType = "-vehicle_type",
|
|
@@ -1353,6 +1382,7 @@ export enum BridgeWiseFundsSortByEnum {
|
|
|
1353
1382
|
LastCloseMarketCapUsd = "last_close_market_cap_usd",
|
|
1354
1383
|
MarketBenchmarkId = "market_benchmark_id",
|
|
1355
1384
|
MaxConcentration = "max_concentration",
|
|
1385
|
+
NumberOfHoldings = "number_of_holdings",
|
|
1356
1386
|
PctOfEquityHoldings = "pct_of_equity_holdings",
|
|
1357
1387
|
PriceCurrencyIso3 = "price_currency_iso3",
|
|
1358
1388
|
PrimaryBenchmarkId = "primary_benchmark_id",
|
|
@@ -1377,6 +1407,7 @@ export enum BridgeWiseFundsSortByEnum {
|
|
|
1377
1407
|
SharpeRatio1Y = "sharpe_ratio_1y",
|
|
1378
1408
|
SponsorAumUsd = "sponsor_aum_usd",
|
|
1379
1409
|
TrackingError1Y = "tracking_error_1y",
|
|
1410
|
+
TradingVolumeRatio = "trading_volume_ratio",
|
|
1380
1411
|
ValueFactor = "value_factor",
|
|
1381
1412
|
ValueFactorGroup = "value_factor_group",
|
|
1382
1413
|
VehicleType = "vehicle_type"
|
|
@@ -1518,11 +1549,14 @@ export interface BridgeWiseMetadata {
|
|
|
1518
1549
|
*/
|
|
1519
1550
|
fund_name_short?: string | null;
|
|
1520
1551
|
/** Fund Type Id */
|
|
1521
|
-
fund_type_id
|
|
1522
|
-
/**
|
|
1523
|
-
|
|
1552
|
+
fund_type_id?: number | null;
|
|
1553
|
+
/**
|
|
1554
|
+
* Fund Type Name
|
|
1555
|
+
* @default "etf"
|
|
1556
|
+
*/
|
|
1557
|
+
fund_type_name?: string | null;
|
|
1524
1558
|
/** Domicile Country Name */
|
|
1525
|
-
domicile_country_name
|
|
1559
|
+
domicile_country_name?: string | null;
|
|
1526
1560
|
/** Primary Trading Item */
|
|
1527
1561
|
primary_trading_item: number;
|
|
1528
1562
|
/** Primary Ticker Symbol */
|
|
@@ -1534,53 +1568,52 @@ export interface BridgeWiseMetadata {
|
|
|
1534
1568
|
/** Primary Market Currency Iso3 */
|
|
1535
1569
|
primary_market_currency_iso3: string;
|
|
1536
1570
|
/** Geographic Country Mandate */
|
|
1537
|
-
geographic_country_mandate
|
|
1571
|
+
geographic_country_mandate?: string | null;
|
|
1538
1572
|
/** Geographic Region Mandate */
|
|
1539
|
-
geographic_region_mandate
|
|
1540
|
-
/**
|
|
1541
|
-
* Geographic Emphasis
|
|
1542
|
-
* @default ""
|
|
1543
|
-
*/
|
|
1573
|
+
geographic_region_mandate?: string | null;
|
|
1574
|
+
/** Geographic Emphasis */
|
|
1544
1575
|
geographic_emphasis?: string | null;
|
|
1576
|
+
/** Dividend Policy */
|
|
1577
|
+
dividend_policy?: string | null;
|
|
1545
1578
|
/** Market Capitalization Emphasis */
|
|
1546
|
-
market_capitalization_emphasis
|
|
1579
|
+
market_capitalization_emphasis?: string | null;
|
|
1547
1580
|
/** Sector Emphasis */
|
|
1548
|
-
sector_emphasis
|
|
1581
|
+
sector_emphasis?: string | null;
|
|
1549
1582
|
/** Inception Date */
|
|
1550
|
-
inception_date
|
|
1583
|
+
inception_date?: string | null;
|
|
1551
1584
|
/** Weight Method */
|
|
1552
|
-
weight_method
|
|
1585
|
+
weight_method?: string | null;
|
|
1553
1586
|
/** Exposure */
|
|
1554
|
-
exposure
|
|
1587
|
+
exposure?: string | null;
|
|
1555
1588
|
/** Leverage */
|
|
1556
|
-
leverage
|
|
1589
|
+
leverage?: number | null;
|
|
1557
1590
|
/** Sponsor Name */
|
|
1558
|
-
sponsor_name
|
|
1591
|
+
sponsor_name?: string | null;
|
|
1559
1592
|
/**
|
|
1560
1593
|
* Sponsor Name Short
|
|
1561
1594
|
* @default ""
|
|
1562
1595
|
*/
|
|
1563
1596
|
sponsor_name_short?: string | null;
|
|
1564
1597
|
/** Benchmark Id */
|
|
1565
|
-
benchmark_id
|
|
1598
|
+
benchmark_id?: number | null;
|
|
1566
1599
|
/** Benchmark Name */
|
|
1567
|
-
benchmark_name
|
|
1600
|
+
benchmark_name?: string | null;
|
|
1568
1601
|
/**
|
|
1569
1602
|
* Benchmark Name Short
|
|
1570
1603
|
* @default ""
|
|
1571
1604
|
*/
|
|
1572
1605
|
benchmark_name_short?: string | null;
|
|
1573
1606
|
/** Management Style */
|
|
1574
|
-
management_style
|
|
1607
|
+
management_style?: string | null;
|
|
1575
1608
|
/**
|
|
1576
1609
|
* Number Of Holdings
|
|
1577
1610
|
* @default 0
|
|
1578
1611
|
*/
|
|
1579
1612
|
number_of_holdings?: number | null;
|
|
1580
1613
|
/** Has Score */
|
|
1581
|
-
has_score
|
|
1614
|
+
has_score?: boolean | null;
|
|
1582
1615
|
/** Pct Of Equity Holdings */
|
|
1583
|
-
pct_of_equity_holdings
|
|
1616
|
+
pct_of_equity_holdings?: number | null;
|
|
1584
1617
|
/**
|
|
1585
1618
|
* Portfolio Strategy
|
|
1586
1619
|
* @default -1
|
|
@@ -3031,48 +3064,6 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
3031
3064
|
Iso = "iso",
|
|
3032
3065
|
Epoch = "epoch"
|
|
3033
3066
|
}
|
|
3034
|
-
export class Bridget<HandleError extends boolean = boolean> {
|
|
3035
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3037
|
-
/**
|
|
3038
|
-
* @tags Bridget
|
|
3039
|
-
* @name QuestionCreate
|
|
3040
|
-
* @request POST:/bridget/question
|
|
3041
|
-
* @secure
|
|
3042
|
-
*/
|
|
3043
|
-
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3044
|
-
/**
|
|
3045
|
-
* @tags Bridget
|
|
3046
|
-
* @name TenantsExportRetrieve
|
|
3047
|
-
* @request GET:/bridget/tenants/{tenant_id}/export
|
|
3048
|
-
* @secure
|
|
3049
|
-
*/
|
|
3050
|
-
tenantsExportRetrieve(tenantId: string, query?: {
|
|
3051
|
-
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3052
|
-
client_id?: string;
|
|
3053
|
-
/**
|
|
3054
|
-
* Returns logs only for the specified calendar day (00:00–23:59 tenant time zone). Use either this field or the start_date + end_date pair — never both in the same request.
|
|
3055
|
-
* @format date
|
|
3056
|
-
*/
|
|
3057
|
-
date?: string;
|
|
3058
|
-
/**
|
|
3059
|
-
* Inclusive end of a date range (must be ≥ start_date). Use either the date field or this start_date + end_date pair — never both in the same request.
|
|
3060
|
-
* @format date
|
|
3061
|
-
*/
|
|
3062
|
-
end_date?: string;
|
|
3063
|
-
/** Filters by user feedback on each answer. Allowed values: like | dislike */
|
|
3064
|
-
feedback_type?: string;
|
|
3065
|
-
/** Filters to a single chat session ID. */
|
|
3066
|
-
session_id?: string;
|
|
3067
|
-
/**
|
|
3068
|
-
* Inclusive start of a date range. Use either the date field or this start_date + end_date pair — never both in the same request. Required when end_date is provided.
|
|
3069
|
-
* @format date
|
|
3070
|
-
*/
|
|
3071
|
-
start_date?: string;
|
|
3072
|
-
/** Filters logs to a single end-user within the tenant. */
|
|
3073
|
-
user_id?: string;
|
|
3074
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3075
|
-
}
|
|
3076
3067
|
export class Bwc<HandleError extends boolean = boolean> {
|
|
3077
3068
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3078
3069
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3939,6 +3930,64 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
3939
3930
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3940
3931
|
*/
|
|
3941
3932
|
sector_score_group?: string;
|
|
3933
|
+
/**
|
|
3934
|
+
* Analysis Technical Score Group
|
|
3935
|
+
* Comma-separated unique analysis technical score groups. <br>Example: 1,2,3,4,5</br>
|
|
3936
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3937
|
+
*/
|
|
3938
|
+
analysis_technical_score_group?: string;
|
|
3939
|
+
/**
|
|
3940
|
+
* Analysis Technical Score Gte
|
|
3941
|
+
* Analysis technical score greater than or equal to.
|
|
3942
|
+
*/
|
|
3943
|
+
analysis_technical_score__gte?: number;
|
|
3944
|
+
/**
|
|
3945
|
+
* Analysis Technical Score Lte
|
|
3946
|
+
* Analysis technical score less than or equal to.
|
|
3947
|
+
*/
|
|
3948
|
+
analysis_technical_score__lte?: number;
|
|
3949
|
+
/**
|
|
3950
|
+
* Consensus Score Group
|
|
3951
|
+
* Comma-separated unique consensus score groups. <br>Example: 1,2,3,4,5</br>
|
|
3952
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3953
|
+
*/
|
|
3954
|
+
consensus_score_group?: string;
|
|
3955
|
+
/**
|
|
3956
|
+
* Consensus Analyst Count Gte
|
|
3957
|
+
* Consensus analyst count greater than or equal to.
|
|
3958
|
+
*/
|
|
3959
|
+
consensus_analyst_count__gte?: number;
|
|
3960
|
+
/**
|
|
3961
|
+
* Consensus Analyst Count Lte
|
|
3962
|
+
* Consensus analyst count less than or equal to.
|
|
3963
|
+
*/
|
|
3964
|
+
consensus_analyst_count__lte?: number;
|
|
3965
|
+
/**
|
|
3966
|
+
* News Sentiment Gte
|
|
3967
|
+
* News sentiment greater than or equal to.
|
|
3968
|
+
*/
|
|
3969
|
+
news_sentiment__gte?: number;
|
|
3970
|
+
/**
|
|
3971
|
+
* News Sentiment Lte
|
|
3972
|
+
* News sentiment less than or equal to.
|
|
3973
|
+
*/
|
|
3974
|
+
news_sentiment__lte?: number;
|
|
3975
|
+
/**
|
|
3976
|
+
* Target Price To Last Close Gte
|
|
3977
|
+
* Target price to last close greater than or equal to.
|
|
3978
|
+
*/
|
|
3979
|
+
target_price_to_last_close__gte?: number;
|
|
3980
|
+
/**
|
|
3981
|
+
* Target Price To Last Close Lte
|
|
3982
|
+
* Target price to last close less than or equal to.
|
|
3983
|
+
*/
|
|
3984
|
+
target_price_to_last_close__lte?: number;
|
|
3985
|
+
/**
|
|
3986
|
+
* Fund Id
|
|
3987
|
+
* Comma-separated fund ids
|
|
3988
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3989
|
+
*/
|
|
3990
|
+
fund_id?: string;
|
|
3942
3991
|
/**
|
|
3943
3992
|
* Tenant Id
|
|
3944
3993
|
* Specify the tenant ID to filter and retrieve companies recommended by that tenant.
|
|
@@ -3975,6 +4024,11 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
3975
4024
|
* Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
|
|
3976
4025
|
*/
|
|
3977
4026
|
return_value__lte?: string;
|
|
4027
|
+
/**
|
|
4028
|
+
* Scoring Method
|
|
4029
|
+
* Ability to screen and sort companies by country-based scores. Country-based scores: analysis_fundamental_score,section_income_statement_score,section_balance_sheet_score,section_cash_flow_score,analysis_fundamental_score_group,section_income_statement_score_group,section_balance_sheet_score_group,section_cash_flow_score_group. Options: <br>Example: country</br>
|
|
4030
|
+
*/
|
|
4031
|
+
scoring_method?: string;
|
|
3978
4032
|
/**
|
|
3979
4033
|
* Page
|
|
3980
4034
|
* Define the page number for pagination.
|
|
@@ -4039,51 +4093,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4039
4093
|
identifier_type: string;
|
|
4040
4094
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4041
4095
|
}
|
|
4042
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
4043
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4044
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4045
|
-
/**
|
|
4046
|
-
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4047
|
-
* @tags Logos
|
|
4048
|
-
* @name FetchLogos
|
|
4049
|
-
* @summary Fetch Logos
|
|
4050
|
-
* @request GET:/companies/logos
|
|
4051
|
-
* @secure
|
|
4052
|
-
*/
|
|
4053
|
-
fetchLogos(query?: {
|
|
4054
|
-
/**
|
|
4055
|
-
* Company Id In
|
|
4056
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
4057
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4058
|
-
* @example "74822,83343211"
|
|
4059
|
-
*/
|
|
4060
|
-
company_id__in?: string;
|
|
4061
|
-
/**
|
|
4062
|
-
* Size
|
|
4063
|
-
* Page size
|
|
4064
|
-
* @min 1
|
|
4065
|
-
* @max 100
|
|
4066
|
-
* @default 50
|
|
4067
|
-
*/
|
|
4068
|
-
size?: number;
|
|
4069
|
-
/**
|
|
4070
|
-
* Page
|
|
4071
|
-
* Page number
|
|
4072
|
-
* @min 1
|
|
4073
|
-
* @default 1
|
|
4074
|
-
*/
|
|
4075
|
-
page?: number;
|
|
4076
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4077
|
-
/**
|
|
4078
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4079
|
-
* @tags Logos
|
|
4080
|
-
* @name FetchLogo
|
|
4081
|
-
* @summary Fetch Logo
|
|
4082
|
-
* @request GET:/companies/{company_id}/logos
|
|
4083
|
-
* @secure
|
|
4084
|
-
*/
|
|
4085
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4086
|
-
}
|
|
4087
4096
|
export class Activities<HandleError extends boolean = boolean> {
|
|
4088
4097
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4089
4098
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4209,51 +4218,18 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4209
4218
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4210
4219
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
4211
4220
|
}
|
|
4212
|
-
export class
|
|
4213
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4214
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4215
|
-
/**
|
|
4216
|
-
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
4217
|
-
* @tags Forecasts
|
|
4218
|
-
* @name GetCompanyForecasts
|
|
4219
|
-
* @summary Get Company Forecasts
|
|
4220
|
-
* @request GET:/companies/{company_id}/forecasts
|
|
4221
|
-
* @secure
|
|
4222
|
-
*/
|
|
4223
|
-
getCompanyForecasts(companyId: number, query?: {
|
|
4224
|
-
/**
|
|
4225
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4226
|
-
* @default "en-US"
|
|
4227
|
-
*/
|
|
4228
|
-
language?: BridgeWiseLanguageEnum;
|
|
4229
|
-
/** Desired forecast type. */
|
|
4230
|
-
forecast_type?: BridgeWiseForecastType;
|
|
4231
|
-
/**
|
|
4232
|
-
* Page
|
|
4233
|
-
* Define the page number for pagination.
|
|
4234
|
-
* @exclusiveMin 0
|
|
4235
|
-
*/
|
|
4236
|
-
page?: number;
|
|
4237
|
-
/**
|
|
4238
|
-
* Page Size
|
|
4239
|
-
* Define the number of records per page for pagination purposes.
|
|
4240
|
-
* @exclusiveMin 0
|
|
4241
|
-
*/
|
|
4242
|
-
page_size?: number;
|
|
4243
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
4244
|
-
}
|
|
4245
|
-
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4221
|
+
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4246
4222
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4247
4223
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4248
4224
|
/**
|
|
4249
|
-
* @description Returns Bridgewise's
|
|
4250
|
-
* @tags
|
|
4251
|
-
* @name
|
|
4252
|
-
* @summary Get Company
|
|
4253
|
-
* @request GET:/companies/{company_id}/
|
|
4225
|
+
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
4226
|
+
* @tags ESG Analysis
|
|
4227
|
+
* @name GetCompanyEsgAnalysis
|
|
4228
|
+
* @summary Get Company Esg Analysis
|
|
4229
|
+
* @request GET:/companies/{company_id}/esg-analysis
|
|
4254
4230
|
* @secure
|
|
4255
4231
|
*/
|
|
4256
|
-
|
|
4232
|
+
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
4257
4233
|
/**
|
|
4258
4234
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4259
4235
|
* @default "en-US"
|
|
@@ -4264,56 +4240,206 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4264
4240
|
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4265
4241
|
*/
|
|
4266
4242
|
show_all?: boolean;
|
|
4267
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4243
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
4268
4244
|
/**
|
|
4269
|
-
* @description This endpoint
|
|
4270
|
-
* @tags
|
|
4271
|
-
* @name
|
|
4272
|
-
* @summary Get Company
|
|
4273
|
-
* @request GET:/companies/{company_id}/
|
|
4245
|
+
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
4246
|
+
* @tags ESG Analysis
|
|
4247
|
+
* @name GetCompanyEsgParagraphs
|
|
4248
|
+
* @summary Get Company Esg Paragraphs
|
|
4249
|
+
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
4274
4250
|
* @secure
|
|
4275
4251
|
*/
|
|
4276
|
-
|
|
4252
|
+
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
4277
4253
|
/**
|
|
4278
4254
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4279
4255
|
* @default "en-US"
|
|
4280
4256
|
*/
|
|
4281
4257
|
language?: BridgeWiseLanguageEnum;
|
|
4282
|
-
/** Specify the component of the analysis to retrieve (e.g., `
|
|
4283
|
-
section_type?:
|
|
4258
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4259
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4284
4260
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4285
4261
|
/**
|
|
4286
|
-
* @description
|
|
4287
|
-
* @tags
|
|
4288
|
-
* @name
|
|
4289
|
-
* @summary Get Company
|
|
4290
|
-
* @request GET:/companies/{company_id}/
|
|
4262
|
+
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
4263
|
+
* @tags ESG Analysis
|
|
4264
|
+
* @name GetCompanyEsgParameters
|
|
4265
|
+
* @summary Get Company Esg Parameters
|
|
4266
|
+
* @request GET:/companies/{company_id}/esg-parameters
|
|
4291
4267
|
* @secure
|
|
4292
4268
|
*/
|
|
4293
|
-
|
|
4269
|
+
getCompanyEsgParameters(companyId: number, query?: {
|
|
4294
4270
|
/**
|
|
4295
4271
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4296
4272
|
* @default "en-US"
|
|
4297
4273
|
*/
|
|
4298
4274
|
language?: BridgeWiseLanguageEnum;
|
|
4299
|
-
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
4300
|
-
section_type?: BridgeWiseFundamentalSectionTypeEnum;
|
|
4301
|
-
/**
|
|
4302
|
-
* Has Score
|
|
4303
|
-
* Boolean flag. Filter out companies without BW scores (not valid for analysis).
|
|
4304
|
-
* @default false
|
|
4305
|
-
*/
|
|
4306
|
-
has_score?: boolean;
|
|
4307
4275
|
/**
|
|
4308
|
-
*
|
|
4309
|
-
*
|
|
4276
|
+
* Parameter Id
|
|
4277
|
+
* Get desired parameter by ID.
|
|
4310
4278
|
*/
|
|
4311
|
-
|
|
4279
|
+
parameter_id?: number;
|
|
4280
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4281
|
+
section_type?: BridgeWiseESGSectionTypeParamEnumV2;
|
|
4312
4282
|
/**
|
|
4313
|
-
*
|
|
4314
|
-
*
|
|
4283
|
+
* Show All
|
|
4284
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4315
4285
|
*/
|
|
4316
|
-
|
|
4286
|
+
show_all?: boolean;
|
|
4287
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
4288
|
+
/**
|
|
4289
|
+
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
4290
|
+
* @tags ESG Analysis
|
|
4291
|
+
* @name GetCompanyEsgSections
|
|
4292
|
+
* @summary Get Company Esg Sections
|
|
4293
|
+
* @request GET:/companies/{company_id}/esg-sections
|
|
4294
|
+
* @secure
|
|
4295
|
+
*/
|
|
4296
|
+
getCompanyEsgSections(companyId: number, query?: {
|
|
4297
|
+
/**
|
|
4298
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4299
|
+
* @default "en-US"
|
|
4300
|
+
*/
|
|
4301
|
+
language?: BridgeWiseLanguageEnum;
|
|
4302
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4303
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4304
|
+
/**
|
|
4305
|
+
* Show All
|
|
4306
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4307
|
+
*/
|
|
4308
|
+
show_all?: boolean;
|
|
4309
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
4310
|
+
/**
|
|
4311
|
+
* @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
|
|
4312
|
+
* @tags ESG Analysis
|
|
4313
|
+
* @name GetCompanyForecastsMsa
|
|
4314
|
+
* @summary Get Company Forecasts Msa
|
|
4315
|
+
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
4316
|
+
* @secure
|
|
4317
|
+
*/
|
|
4318
|
+
getCompanyForecastsMsa(companyId: number, query?: {
|
|
4319
|
+
/**
|
|
4320
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4321
|
+
* @default "en-US"
|
|
4322
|
+
*/
|
|
4323
|
+
language?: BridgeWiseLanguageEnum;
|
|
4324
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
4325
|
+
}
|
|
4326
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
4327
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4328
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4329
|
+
/**
|
|
4330
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4331
|
+
* @tags Logos
|
|
4332
|
+
* @name FetchLogos
|
|
4333
|
+
* @summary Fetch Logos
|
|
4334
|
+
* @request GET:/companies/logos
|
|
4335
|
+
* @secure
|
|
4336
|
+
*/
|
|
4337
|
+
fetchLogos(query?: {
|
|
4338
|
+
/**
|
|
4339
|
+
* Company Id In
|
|
4340
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
4341
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4342
|
+
* @example "74822,83343211"
|
|
4343
|
+
*/
|
|
4344
|
+
company_id__in?: string;
|
|
4345
|
+
/**
|
|
4346
|
+
* Size
|
|
4347
|
+
* Page size
|
|
4348
|
+
* @min 1
|
|
4349
|
+
* @max 100
|
|
4350
|
+
* @default 50
|
|
4351
|
+
*/
|
|
4352
|
+
size?: number;
|
|
4353
|
+
/**
|
|
4354
|
+
* Page
|
|
4355
|
+
* Page number
|
|
4356
|
+
* @min 1
|
|
4357
|
+
* @default 1
|
|
4358
|
+
*/
|
|
4359
|
+
page?: number;
|
|
4360
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4361
|
+
/**
|
|
4362
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4363
|
+
* @tags Logos
|
|
4364
|
+
* @name FetchLogo
|
|
4365
|
+
* @summary Fetch Logo
|
|
4366
|
+
* @request GET:/companies/{company_id}/logos
|
|
4367
|
+
* @secure
|
|
4368
|
+
*/
|
|
4369
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4370
|
+
}
|
|
4371
|
+
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4372
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4373
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4374
|
+
/**
|
|
4375
|
+
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
4376
|
+
* @tags Fundamental Analysis
|
|
4377
|
+
* @name GetCompanyFundamentalAnalysis
|
|
4378
|
+
* @summary Get Company Fundamental Analysis
|
|
4379
|
+
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
4380
|
+
* @secure
|
|
4381
|
+
*/
|
|
4382
|
+
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
4383
|
+
/**
|
|
4384
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4385
|
+
* @default "en-US"
|
|
4386
|
+
*/
|
|
4387
|
+
language?: BridgeWiseLanguageEnum;
|
|
4388
|
+
/**
|
|
4389
|
+
* Show All
|
|
4390
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4391
|
+
*/
|
|
4392
|
+
show_all?: boolean;
|
|
4393
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResponse, HandleError>>;
|
|
4394
|
+
/**
|
|
4395
|
+
* @description This endpoint provides detailed textual analyses focused on a company's financial health, including its profitability, balance sheet, cash flow and income statement.
|
|
4396
|
+
* @tags Fundamental Analysis
|
|
4397
|
+
* @name GetCompanyFundamentalParagraphs
|
|
4398
|
+
* @summary Get Company Fundamental Paragraphs
|
|
4399
|
+
* @request GET:/companies/{company_id}/fundamental-paragraphs
|
|
4400
|
+
* @secure
|
|
4401
|
+
*/
|
|
4402
|
+
getCompanyFundamentalParagraphs(companyId: number, query?: {
|
|
4403
|
+
/**
|
|
4404
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4405
|
+
* @default "en-US"
|
|
4406
|
+
*/
|
|
4407
|
+
language?: BridgeWiseLanguageEnum;
|
|
4408
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
4409
|
+
section_type?: BridgeWiseFundamentalParagraphSectionTypeEnum;
|
|
4410
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4411
|
+
/**
|
|
4412
|
+
* @description Offers an in-depth breakdown of the parameters used in the fundamental analysis, detailing more than 100 key metrics within the income statement, balance sheet and cash flow financial statements.
|
|
4413
|
+
* @tags Fundamental Analysis
|
|
4414
|
+
* @name GetCompanyFundamentalParameters
|
|
4415
|
+
* @summary Get Company Fundamental Parameters
|
|
4416
|
+
* @request GET:/companies/{company_id}/fundamental-parameters
|
|
4417
|
+
* @secure
|
|
4418
|
+
*/
|
|
4419
|
+
getCompanyFundamentalParameters(companyId: number, query?: {
|
|
4420
|
+
/**
|
|
4421
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4422
|
+
* @default "en-US"
|
|
4423
|
+
*/
|
|
4424
|
+
language?: BridgeWiseLanguageEnum;
|
|
4425
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
4426
|
+
section_type?: BridgeWiseFundamentalSectionTypeEnum;
|
|
4427
|
+
/**
|
|
4428
|
+
* Has Score
|
|
4429
|
+
* Boolean flag. Filter out companies without BW scores (not valid for analysis).
|
|
4430
|
+
* @default false
|
|
4431
|
+
*/
|
|
4432
|
+
has_score?: boolean;
|
|
4433
|
+
/**
|
|
4434
|
+
* Year
|
|
4435
|
+
* Specify the year for which the analysis is requested.
|
|
4436
|
+
*/
|
|
4437
|
+
year?: number;
|
|
4438
|
+
/**
|
|
4439
|
+
* Quarter
|
|
4440
|
+
* Specify the quarter for which the analysis is requested.
|
|
4441
|
+
*/
|
|
4442
|
+
quarter?: number;
|
|
4317
4443
|
/**
|
|
4318
4444
|
* Define the data period format (e.g., TTM, Quarterly, Annual).
|
|
4319
4445
|
* @default "last_12_month"
|
|
@@ -4382,6 +4508,64 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4382
4508
|
*/
|
|
4383
4509
|
date__lte?: string;
|
|
4384
4510
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4511
|
+
/**
|
|
4512
|
+
* @description This endpoint provides textual analyses and predictions regarding a company's future stock price, including price targets set by analysts.
|
|
4513
|
+
* @tags Fundamental Analysis
|
|
4514
|
+
* @name GetCompanyPriceTargetParagraphs
|
|
4515
|
+
* @summary Get Company Price Target Paragraphs
|
|
4516
|
+
* @request GET:/companies/{company_id}/target-price-paragraphs
|
|
4517
|
+
* @secure
|
|
4518
|
+
*/
|
|
4519
|
+
getCompanyPriceTargetParagraphs(companyId: number, query?: {
|
|
4520
|
+
/**
|
|
4521
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4522
|
+
* @default "en-US"
|
|
4523
|
+
*/
|
|
4524
|
+
language?: BridgeWiseLanguageEnum;
|
|
4525
|
+
/**
|
|
4526
|
+
* Trading Item Id
|
|
4527
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4528
|
+
*/
|
|
4529
|
+
trading_item_id?: number;
|
|
4530
|
+
/**
|
|
4531
|
+
* Section Type
|
|
4532
|
+
* Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
|
|
4533
|
+
*/
|
|
4534
|
+
section_type?: string;
|
|
4535
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4536
|
+
}
|
|
4537
|
+
export class Forecasts<HandleError extends boolean = boolean> {
|
|
4538
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4539
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4540
|
+
/**
|
|
4541
|
+
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
4542
|
+
* @tags Forecasts
|
|
4543
|
+
* @name GetCompanyForecasts
|
|
4544
|
+
* @summary Get Company Forecasts
|
|
4545
|
+
* @request GET:/companies/{company_id}/forecasts
|
|
4546
|
+
* @secure
|
|
4547
|
+
*/
|
|
4548
|
+
getCompanyForecasts(companyId: number, query?: {
|
|
4549
|
+
/**
|
|
4550
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4551
|
+
* @default "en-US"
|
|
4552
|
+
*/
|
|
4553
|
+
language?: BridgeWiseLanguageEnum;
|
|
4554
|
+
/** Desired forecast type. */
|
|
4555
|
+
forecast_type?: BridgeWiseForecastType;
|
|
4556
|
+
/**
|
|
4557
|
+
* Page
|
|
4558
|
+
* Define the page number for pagination.
|
|
4559
|
+
* @exclusiveMin 0
|
|
4560
|
+
*/
|
|
4561
|
+
page?: number;
|
|
4562
|
+
/**
|
|
4563
|
+
* Page Size
|
|
4564
|
+
* Define the number of records per page for pagination purposes.
|
|
4565
|
+
* @exclusiveMin 0
|
|
4566
|
+
*/
|
|
4567
|
+
page_size?: number;
|
|
4568
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
4385
4569
|
}
|
|
4386
4570
|
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
4387
4571
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4475,14 +4659,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
4475
4659
|
* Published Date Gte
|
|
4476
4660
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4477
4661
|
* @format date
|
|
4478
|
-
* @default "2025-
|
|
4662
|
+
* @default "2025-09-01"
|
|
4479
4663
|
*/
|
|
4480
4664
|
published_date__gte?: string;
|
|
4481
4665
|
/**
|
|
4482
4666
|
* Published Date Lte
|
|
4483
4667
|
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4484
4668
|
* @format date
|
|
4485
|
-
* @default "2025-
|
|
4669
|
+
* @default "2025-09-01"
|
|
4486
4670
|
*/
|
|
4487
4671
|
published_date__lte?: string;
|
|
4488
4672
|
/**
|
|
@@ -4494,146 +4678,41 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
4494
4678
|
* Size
|
|
4495
4679
|
* Define the number of records per page for pagination purposes.
|
|
4496
4680
|
* @default 10
|
|
4497
|
-
* @example 10
|
|
4498
|
-
*/
|
|
4499
|
-
size?: number;
|
|
4500
|
-
/**
|
|
4501
|
-
* Page
|
|
4502
|
-
* Define the page number for pagination.
|
|
4503
|
-
* @default 1
|
|
4504
|
-
* @example 1
|
|
4505
|
-
*/
|
|
4506
|
-
page?: number;
|
|
4507
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4508
|
-
/**
|
|
4509
|
-
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
4510
|
-
* @tags Company News
|
|
4511
|
-
* @name GetAverageCompanyNewsSentiment
|
|
4512
|
-
* @summary Get Average Company News Sentiment
|
|
4513
|
-
* @request GET:/companies/{company_id}/news-sentiment
|
|
4514
|
-
* @secure
|
|
4515
|
-
*/
|
|
4516
|
-
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4517
|
-
/**
|
|
4518
|
-
* Published Date Gte
|
|
4519
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4520
|
-
* @format date
|
|
4521
|
-
* @default "2025-07-22"
|
|
4522
|
-
*/
|
|
4523
|
-
published_date__gte?: string;
|
|
4524
|
-
/**
|
|
4525
|
-
* Published Date Lte
|
|
4526
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4527
|
-
* @format date
|
|
4528
|
-
* @default "2025-07-22"
|
|
4529
|
-
*/
|
|
4530
|
-
published_date__lte?: string;
|
|
4531
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4532
|
-
}
|
|
4533
|
-
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4534
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4535
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4536
|
-
/**
|
|
4537
|
-
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
4538
|
-
* @tags ESG Analysis
|
|
4539
|
-
* @name GetCompanyEsgAnalysis
|
|
4540
|
-
* @summary Get Company Esg Analysis
|
|
4541
|
-
* @request GET:/companies/{company_id}/esg-analysis
|
|
4542
|
-
* @secure
|
|
4543
|
-
*/
|
|
4544
|
-
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
4545
|
-
/**
|
|
4546
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4547
|
-
* @default "en-US"
|
|
4548
|
-
*/
|
|
4549
|
-
language?: BridgeWiseLanguageEnum;
|
|
4550
|
-
/**
|
|
4551
|
-
* Show All
|
|
4552
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4553
|
-
*/
|
|
4554
|
-
show_all?: boolean;
|
|
4555
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
4556
|
-
/**
|
|
4557
|
-
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
4558
|
-
* @tags ESG Analysis
|
|
4559
|
-
* @name GetCompanyEsgParagraphs
|
|
4560
|
-
* @summary Get Company Esg Paragraphs
|
|
4561
|
-
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
4562
|
-
* @secure
|
|
4563
|
-
*/
|
|
4564
|
-
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
4565
|
-
/**
|
|
4566
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4567
|
-
* @default "en-US"
|
|
4568
|
-
*/
|
|
4569
|
-
language?: BridgeWiseLanguageEnum;
|
|
4570
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4571
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4572
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4573
|
-
/**
|
|
4574
|
-
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
4575
|
-
* @tags ESG Analysis
|
|
4576
|
-
* @name GetCompanyEsgParameters
|
|
4577
|
-
* @summary Get Company Esg Parameters
|
|
4578
|
-
* @request GET:/companies/{company_id}/esg-parameters
|
|
4579
|
-
* @secure
|
|
4580
|
-
*/
|
|
4581
|
-
getCompanyEsgParameters(companyId: number, query?: {
|
|
4582
|
-
/**
|
|
4583
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4584
|
-
* @default "en-US"
|
|
4585
|
-
*/
|
|
4586
|
-
language?: BridgeWiseLanguageEnum;
|
|
4587
|
-
/**
|
|
4588
|
-
* Parameter Id
|
|
4589
|
-
* Get desired parameter by ID.
|
|
4590
|
-
*/
|
|
4591
|
-
parameter_id?: number;
|
|
4592
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4593
|
-
section_type?: BridgeWiseESGSectionTypeParamEnumV2;
|
|
4594
|
-
/**
|
|
4595
|
-
* Show All
|
|
4596
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4597
|
-
*/
|
|
4598
|
-
show_all?: boolean;
|
|
4599
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
4600
|
-
/**
|
|
4601
|
-
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
4602
|
-
* @tags ESG Analysis
|
|
4603
|
-
* @name GetCompanyEsgSections
|
|
4604
|
-
* @summary Get Company Esg Sections
|
|
4605
|
-
* @request GET:/companies/{company_id}/esg-sections
|
|
4606
|
-
* @secure
|
|
4607
|
-
*/
|
|
4608
|
-
getCompanyEsgSections(companyId: number, query?: {
|
|
4609
|
-
/**
|
|
4610
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4611
|
-
* @default "en-US"
|
|
4681
|
+
* @example 10
|
|
4612
4682
|
*/
|
|
4613
|
-
|
|
4614
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4615
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4683
|
+
size?: number;
|
|
4616
4684
|
/**
|
|
4617
|
-
*
|
|
4618
|
-
*
|
|
4685
|
+
* Page
|
|
4686
|
+
* Define the page number for pagination.
|
|
4687
|
+
* @default 1
|
|
4688
|
+
* @example 1
|
|
4619
4689
|
*/
|
|
4620
|
-
|
|
4621
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4690
|
+
page?: number;
|
|
4691
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4622
4692
|
/**
|
|
4623
|
-
* @description This endpoint provides
|
|
4624
|
-
* @tags
|
|
4625
|
-
* @name
|
|
4626
|
-
* @summary Get Company
|
|
4627
|
-
* @request GET:/companies/{company_id}/
|
|
4693
|
+
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
4694
|
+
* @tags Company News
|
|
4695
|
+
* @name GetAverageCompanyNewsSentiment
|
|
4696
|
+
* @summary Get Average Company News Sentiment
|
|
4697
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
4628
4698
|
* @secure
|
|
4629
4699
|
*/
|
|
4630
|
-
|
|
4700
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4631
4701
|
/**
|
|
4632
|
-
*
|
|
4633
|
-
*
|
|
4702
|
+
* Published Date Gte
|
|
4703
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4704
|
+
* @format date
|
|
4705
|
+
* @default "2025-09-01"
|
|
4634
4706
|
*/
|
|
4635
|
-
|
|
4636
|
-
|
|
4707
|
+
published_date__gte?: string;
|
|
4708
|
+
/**
|
|
4709
|
+
* Published Date Lte
|
|
4710
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4711
|
+
* @format date
|
|
4712
|
+
* @default "2025-09-01"
|
|
4713
|
+
*/
|
|
4714
|
+
published_date__lte?: string;
|
|
4715
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4637
4716
|
}
|
|
4638
4717
|
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4639
4718
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4822,6 +4901,27 @@ export class Themes<HandleError extends boolean = boolean> {
|
|
|
4822
4901
|
*/
|
|
4823
4902
|
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4824
4903
|
}
|
|
4904
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
4905
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4906
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4907
|
+
/**
|
|
4908
|
+
* @description This endpoint provides filters
|
|
4909
|
+
* @tags Metadata
|
|
4910
|
+
* @name GetCompanyFilters
|
|
4911
|
+
* @summary Get Company Filters
|
|
4912
|
+
* @request GET:/filters
|
|
4913
|
+
* @secure
|
|
4914
|
+
*/
|
|
4915
|
+
getCompanyFilters(query: {
|
|
4916
|
+
/** Desired filter type. */
|
|
4917
|
+
type: BridgeWiseCompanyFilterType;
|
|
4918
|
+
/**
|
|
4919
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4920
|
+
* @default "en-US"
|
|
4921
|
+
*/
|
|
4922
|
+
language?: BridgeWiseLanguageEnum;
|
|
4923
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
4924
|
+
}
|
|
4825
4925
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4826
4926
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4827
4927
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4844,6 +4944,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
4844
4944
|
* Get peers funds of a specific fund.
|
|
4845
4945
|
*/
|
|
4846
4946
|
peers_of?: number;
|
|
4947
|
+
/**
|
|
4948
|
+
* Theme Id
|
|
4949
|
+
* Comma-separated list of unique numeric identifiers for investment themes. <br>Example: 123,126</br>
|
|
4950
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4951
|
+
*/
|
|
4952
|
+
theme_id?: string;
|
|
4847
4953
|
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
|
|
4848
4954
|
sort_by?: BridgeWiseFundsSortByEnum;
|
|
4849
4955
|
/**
|
|
@@ -4985,12 +5091,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
4985
5091
|
avg_trading_volume_3m__lte?: string;
|
|
4986
5092
|
/**
|
|
4987
5093
|
* Trading Volume Ratio Gte
|
|
4988
|
-
* Trading
|
|
5094
|
+
* Trading turnover greater than or equal specific value.
|
|
4989
5095
|
*/
|
|
4990
5096
|
trading_volume_ratio__gte?: string;
|
|
4991
5097
|
/**
|
|
4992
5098
|
* Trading Volume Ratio Lte
|
|
4993
|
-
* Trading
|
|
5099
|
+
* Trading turnover less than or equal specific value.
|
|
4994
5100
|
*/
|
|
4995
5101
|
trading_volume_ratio__lte?: string;
|
|
4996
5102
|
/**
|
|
@@ -5208,101 +5314,223 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
5208
5314
|
language?: BridgeWiseLanguageEnum;
|
|
5209
5315
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
5210
5316
|
}
|
|
5211
|
-
export class
|
|
5317
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
5212
5318
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5213
5319
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5214
5320
|
/**
|
|
5215
|
-
* @description
|
|
5216
|
-
* @tags Fund
|
|
5217
|
-
* @name
|
|
5218
|
-
* @summary Get Fund
|
|
5219
|
-
* @request GET:/funds/{fund_id}/
|
|
5321
|
+
* @description Returns Bridgewise final analysis for a specified fund.
|
|
5322
|
+
* @tags Fund Analysis
|
|
5323
|
+
* @name GetFundAnalysis
|
|
5324
|
+
* @summary Get Fund Analysis
|
|
5325
|
+
* @request GET:/funds/{fund_id}/analysis
|
|
5220
5326
|
* @secure
|
|
5221
5327
|
*/
|
|
5222
|
-
|
|
5328
|
+
getFundAnalysis(fundId: number, query?: {
|
|
5223
5329
|
/**
|
|
5224
|
-
*
|
|
5225
|
-
*
|
|
5330
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5331
|
+
* @default "en-US"
|
|
5226
5332
|
*/
|
|
5227
|
-
|
|
5333
|
+
language?: BridgeWiseLanguageEnum;
|
|
5334
|
+
/**
|
|
5335
|
+
* Year
|
|
5336
|
+
* Specify the year for which the analysis is requested.
|
|
5337
|
+
*/
|
|
5338
|
+
year?: number;
|
|
5339
|
+
/**
|
|
5340
|
+
* Quarter
|
|
5341
|
+
* Specify the quarter for which the analysis is requested.
|
|
5342
|
+
*/
|
|
5343
|
+
quarter?: number;
|
|
5344
|
+
/**
|
|
5345
|
+
* Show All
|
|
5346
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5347
|
+
*/
|
|
5348
|
+
show_all?: boolean;
|
|
5349
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
5350
|
+
/**
|
|
5351
|
+
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
5352
|
+
* @tags Fund Analysis
|
|
5353
|
+
* @name GetFundsParagraphs
|
|
5354
|
+
* @summary Get Funds Paragraphs
|
|
5355
|
+
* @request GET:/funds/{fund_id}/paragraphs
|
|
5356
|
+
* @secure
|
|
5357
|
+
*/
|
|
5358
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
5228
5359
|
/**
|
|
5229
5360
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5230
5361
|
* @default "en-US"
|
|
5231
5362
|
*/
|
|
5232
5363
|
language?: BridgeWiseLanguageEnum;
|
|
5233
|
-
|
|
5234
|
-
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
|
|
5364
|
+
/**
|
|
5365
|
+
* Year
|
|
5366
|
+
* Specify the year for which the analysis is requested.
|
|
5367
|
+
*/
|
|
5368
|
+
year?: number | null;
|
|
5369
|
+
/**
|
|
5370
|
+
* Quarter
|
|
5371
|
+
* Specify the quarter for which the analysis is requested.
|
|
5372
|
+
*/
|
|
5373
|
+
quarter?: number | null;
|
|
5374
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
5238
5375
|
/**
|
|
5239
|
-
* @description
|
|
5240
|
-
* @tags
|
|
5241
|
-
* @name
|
|
5242
|
-
* @summary Get
|
|
5243
|
-
* @request GET:/
|
|
5376
|
+
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
5377
|
+
* @tags Fund Analysis
|
|
5378
|
+
* @name GetFundParameters
|
|
5379
|
+
* @summary Get Fund Parameters
|
|
5380
|
+
* @request GET:/funds/{fund_id}/parameters
|
|
5244
5381
|
* @secure
|
|
5245
5382
|
*/
|
|
5246
|
-
|
|
5247
|
-
/** Desired filter type. */
|
|
5248
|
-
type: BridgeWiseCompanyFilterType;
|
|
5383
|
+
getFundParameters(fundId: number, query?: {
|
|
5249
5384
|
/**
|
|
5250
5385
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5251
5386
|
* @default "en-US"
|
|
5252
5387
|
*/
|
|
5253
5388
|
language?: BridgeWiseLanguageEnum;
|
|
5254
|
-
|
|
5389
|
+
/**
|
|
5390
|
+
* Parameter Id
|
|
5391
|
+
* ID of the parameter for analysis.
|
|
5392
|
+
*/
|
|
5393
|
+
parameter_id?: number;
|
|
5394
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
5395
|
+
/**
|
|
5396
|
+
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
5397
|
+
* @tags Fund Analysis
|
|
5398
|
+
* @name GetFundSections
|
|
5399
|
+
* @summary Get Fund Sections
|
|
5400
|
+
* @request GET:/funds/{fund_id}/sections
|
|
5401
|
+
* @secure
|
|
5402
|
+
*/
|
|
5403
|
+
getFundSections(fundId: number, query?: {
|
|
5404
|
+
/**
|
|
5405
|
+
* Year
|
|
5406
|
+
* Specify the year for which the analysis is requested.
|
|
5407
|
+
*/
|
|
5408
|
+
year?: number;
|
|
5409
|
+
/**
|
|
5410
|
+
* Quarter
|
|
5411
|
+
* Specify the quarter for which the analysis is requested.
|
|
5412
|
+
*/
|
|
5413
|
+
quarter?: number;
|
|
5414
|
+
/**
|
|
5415
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5416
|
+
* @default "en-US"
|
|
5417
|
+
*/
|
|
5418
|
+
language?: BridgeWiseLanguageEnum;
|
|
5419
|
+
/**
|
|
5420
|
+
* Show All
|
|
5421
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5422
|
+
*/
|
|
5423
|
+
show_all?: boolean;
|
|
5424
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
5255
5425
|
}
|
|
5256
|
-
export class
|
|
5426
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5257
5427
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5258
5428
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5259
5429
|
/**
|
|
5260
|
-
* @description
|
|
5261
|
-
* @tags
|
|
5262
|
-
* @name
|
|
5263
|
-
* @summary Get
|
|
5264
|
-
* @request GET:/funds/{fund_id}/
|
|
5430
|
+
* @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
|
|
5431
|
+
* @tags Holdings
|
|
5432
|
+
* @name GetCompositions
|
|
5433
|
+
* @summary Get Compositions
|
|
5434
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
5265
5435
|
* @secure
|
|
5266
5436
|
*/
|
|
5267
|
-
|
|
5437
|
+
getCompositions(fundId: number, query?: {
|
|
5268
5438
|
/**
|
|
5269
5439
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5270
5440
|
* @default "en-US"
|
|
5271
5441
|
*/
|
|
5272
5442
|
language?: BridgeWiseLanguageEnum;
|
|
5443
|
+
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5444
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5445
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5446
|
+
/**
|
|
5447
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5448
|
+
* @tags Holdings
|
|
5449
|
+
* @name GetHoldingStatistics
|
|
5450
|
+
* @summary Get Holding Statistics
|
|
5451
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5452
|
+
* @secure
|
|
5453
|
+
*/
|
|
5454
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
5273
5455
|
/**
|
|
5274
|
-
*
|
|
5275
|
-
*
|
|
5456
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5457
|
+
* @default "en-US"
|
|
5276
5458
|
*/
|
|
5277
|
-
|
|
5459
|
+
language?: BridgeWiseLanguageEnum;
|
|
5460
|
+
/**
|
|
5461
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5462
|
+
* @default "stocks"
|
|
5463
|
+
*/
|
|
5464
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5465
|
+
/**
|
|
5466
|
+
* Page
|
|
5467
|
+
* Define the page number for pagination.
|
|
5468
|
+
* @exclusiveMin 0
|
|
5469
|
+
*/
|
|
5470
|
+
page?: number;
|
|
5471
|
+
/**
|
|
5472
|
+
* Page Size
|
|
5473
|
+
* Define the number of records per page for pagination purposes.
|
|
5474
|
+
* @exclusiveMin 0
|
|
5475
|
+
*/
|
|
5476
|
+
page_size?: number;
|
|
5477
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
5478
|
+
/**
|
|
5479
|
+
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
5480
|
+
* @tags Holdings
|
|
5481
|
+
* @name GetHoldings
|
|
5482
|
+
* @summary Get Holdings
|
|
5483
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
5484
|
+
* @secure
|
|
5485
|
+
*/
|
|
5486
|
+
getHoldings(fundId: number, query?: {
|
|
5487
|
+
/**
|
|
5488
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5489
|
+
* @default "en-US"
|
|
5490
|
+
*/
|
|
5491
|
+
language?: BridgeWiseLanguageEnum;
|
|
5492
|
+
/**
|
|
5493
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5494
|
+
* @default "stocks"
|
|
5495
|
+
*/
|
|
5496
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5497
|
+
/**
|
|
5498
|
+
* Page
|
|
5499
|
+
* Define the page number for pagination.
|
|
5500
|
+
* @exclusiveMin 0
|
|
5501
|
+
*/
|
|
5502
|
+
page?: number;
|
|
5278
5503
|
/**
|
|
5279
|
-
*
|
|
5280
|
-
*
|
|
5504
|
+
* Page Size
|
|
5505
|
+
* Define the number of records per page for pagination purposes.
|
|
5506
|
+
* @exclusiveMin 0
|
|
5281
5507
|
*/
|
|
5282
|
-
|
|
5283
|
-
|
|
5284
|
-
|
|
5285
|
-
|
|
5508
|
+
page_size?: number;
|
|
5509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
5510
|
+
}
|
|
5511
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5512
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5513
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5286
5514
|
/**
|
|
5287
|
-
* @description
|
|
5288
|
-
* @tags
|
|
5289
|
-
* @name
|
|
5290
|
-
* @summary Get
|
|
5291
|
-
* @request GET:/funds/{fund_id}/
|
|
5515
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5516
|
+
* @tags Fund ESG Analysis
|
|
5517
|
+
* @name GetFundEsgAnalysis
|
|
5518
|
+
* @summary Get Fund Esg Analysis
|
|
5519
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5292
5520
|
* @secure
|
|
5293
5521
|
*/
|
|
5294
|
-
|
|
5522
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5523
|
+
/**
|
|
5524
|
+
* Limit
|
|
5525
|
+
* Number of historical periods to be returned (default is 1).
|
|
5526
|
+
*/
|
|
5527
|
+
limit?: number;
|
|
5295
5528
|
/**
|
|
5296
5529
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5297
5530
|
* @default "en-US"
|
|
5298
5531
|
*/
|
|
5299
5532
|
language?: BridgeWiseLanguageEnum;
|
|
5300
|
-
|
|
5301
|
-
* Segment
|
|
5302
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5303
|
-
*/
|
|
5304
|
-
segment?: string;
|
|
5305
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5533
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5306
5534
|
}
|
|
5307
5535
|
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5308
5536
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5591,90 +5819,123 @@ export class Users<HandleError extends boolean = boolean> {
|
|
|
5591
5819
|
authorization: string;
|
|
5592
5820
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5593
5821
|
}
|
|
5594
|
-
export class
|
|
5822
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5595
5823
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5596
5824
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5597
5825
|
/**
|
|
5598
|
-
* @description
|
|
5599
|
-
* @tags
|
|
5600
|
-
* @name
|
|
5601
|
-
* @summary Get
|
|
5602
|
-
* @request GET:/funds/{fund_id}/
|
|
5826
|
+
* @description Provides key financial metrics for each segment within the specified fund, such as weighted averages of P/E ratio, P/B ratio, P/S ratio, Net Debt to EBITDA, Revenue Growth Rate, and Relative Market Value. It also includes the Weighted Average Segment Strength based on Bridgewise scores.
|
|
5827
|
+
* @tags Segmentations
|
|
5828
|
+
* @name GetSegmentParameters
|
|
5829
|
+
* @summary Get Segment Parameters
|
|
5830
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5603
5831
|
* @secure
|
|
5604
5832
|
*/
|
|
5605
|
-
|
|
5833
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5606
5834
|
/**
|
|
5607
5835
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5608
5836
|
* @default "en-US"
|
|
5609
5837
|
*/
|
|
5610
5838
|
language?: BridgeWiseLanguageEnum;
|
|
5611
|
-
/**
|
|
5612
|
-
|
|
5613
|
-
|
|
5839
|
+
/**
|
|
5840
|
+
* Segment
|
|
5841
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5842
|
+
*/
|
|
5843
|
+
segment?: string;
|
|
5844
|
+
/**
|
|
5845
|
+
* Segment Type
|
|
5846
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5847
|
+
*/
|
|
5848
|
+
segment_type?: string;
|
|
5849
|
+
/** Desired segment parameter type. */
|
|
5850
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5851
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5614
5852
|
/**
|
|
5615
|
-
* @description
|
|
5616
|
-
* @tags
|
|
5617
|
-
* @name
|
|
5618
|
-
* @summary Get
|
|
5619
|
-
* @request GET:/funds/{fund_id}/
|
|
5853
|
+
* @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
|
|
5854
|
+
* @tags Segmentations
|
|
5855
|
+
* @name GetSegment
|
|
5856
|
+
* @summary Get Segment
|
|
5857
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5620
5858
|
* @secure
|
|
5621
5859
|
*/
|
|
5622
|
-
|
|
5860
|
+
getSegment(fundId: number, query?: {
|
|
5623
5861
|
/**
|
|
5624
5862
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5625
5863
|
* @default "en-US"
|
|
5626
5864
|
*/
|
|
5627
5865
|
language?: BridgeWiseLanguageEnum;
|
|
5628
5866
|
/**
|
|
5629
|
-
*
|
|
5630
|
-
*
|
|
5631
|
-
*/
|
|
5632
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5633
|
-
/**
|
|
5634
|
-
* Page
|
|
5635
|
-
* Define the page number for pagination.
|
|
5636
|
-
* @exclusiveMin 0
|
|
5637
|
-
*/
|
|
5638
|
-
page?: number;
|
|
5639
|
-
/**
|
|
5640
|
-
* Page Size
|
|
5641
|
-
* Define the number of records per page for pagination purposes.
|
|
5642
|
-
* @exclusiveMin 0
|
|
5867
|
+
* Segment
|
|
5868
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5643
5869
|
*/
|
|
5644
|
-
|
|
5645
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5870
|
+
segment?: string;
|
|
5871
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5872
|
+
}
|
|
5873
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
5874
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5875
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5646
5876
|
/**
|
|
5647
|
-
* @
|
|
5648
|
-
* @
|
|
5649
|
-
* @
|
|
5650
|
-
* @summary Get Holdings
|
|
5651
|
-
* @request GET:/funds/{fund_id}/holdings
|
|
5877
|
+
* @tags Bridget
|
|
5878
|
+
* @name QuestionsCreate
|
|
5879
|
+
* @request POST:/questions
|
|
5652
5880
|
* @secure
|
|
5653
5881
|
*/
|
|
5654
|
-
|
|
5655
|
-
/**
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5882
|
+
questionsCreate(data: BridgeWiseQuestionsRequest, headers: {
|
|
5883
|
+
/** User ID */
|
|
5884
|
+
Userid: string;
|
|
5885
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
5886
|
+
/**
|
|
5887
|
+
* @tags Bridget
|
|
5888
|
+
* @name TenantsQuestionsRetrieve
|
|
5889
|
+
* @request GET:/tenants/{tenant_id}/questions
|
|
5890
|
+
* @secure
|
|
5891
|
+
*/
|
|
5892
|
+
tenantsQuestionsRetrieve(tenantId: string, query?: {
|
|
5893
|
+
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
5894
|
+
client_id?: string;
|
|
5660
5895
|
/**
|
|
5661
|
-
*
|
|
5662
|
-
*
|
|
5896
|
+
* Returns logs only for the specified calendar day (00:00–23:59 tenant time zone).
|
|
5897
|
+
*
|
|
5898
|
+
* Use either this field or the `start_date` + `end_date` pair.
|
|
5899
|
+
*
|
|
5900
|
+
* **Never** both in the same request.
|
|
5901
|
+
*
|
|
5902
|
+
* **Format:** YYYY-MM-DD
|
|
5903
|
+
* @format date
|
|
5663
5904
|
*/
|
|
5664
|
-
|
|
5905
|
+
date?: string;
|
|
5665
5906
|
/**
|
|
5666
|
-
*
|
|
5667
|
-
*
|
|
5668
|
-
*
|
|
5907
|
+
* Inclusive end of a date range.
|
|
5908
|
+
*
|
|
5909
|
+
* Must be greater than or equal to `start_date`.
|
|
5910
|
+
*
|
|
5911
|
+
* Use either the `date` field, OR use the `start_date` + `end_date` pair.
|
|
5912
|
+
*
|
|
5913
|
+
* **Never** use both in the same request.
|
|
5914
|
+
*
|
|
5915
|
+
* **Format:** YYYY-MM-DD
|
|
5916
|
+
* @format date
|
|
5669
5917
|
*/
|
|
5670
|
-
|
|
5918
|
+
end_date?: string;
|
|
5919
|
+
/** Filters by user feedback on each answer. **Allowed values**: `like` | `dislike` */
|
|
5920
|
+
feedback_type?: string;
|
|
5921
|
+
/** Filters to a single chat session ID. */
|
|
5922
|
+
session_id?: string;
|
|
5671
5923
|
/**
|
|
5672
|
-
*
|
|
5673
|
-
*
|
|
5674
|
-
*
|
|
5924
|
+
* Inclusive start of a date range.
|
|
5925
|
+
*
|
|
5926
|
+
* Use either the `date` field or this `start_date` + `end_date`pair.
|
|
5927
|
+
*
|
|
5928
|
+
* **Never** both in the same request.
|
|
5929
|
+
*
|
|
5930
|
+
* Required when end_date is provided.
|
|
5931
|
+
*
|
|
5932
|
+
* **Format:** YYYY-MM-DD
|
|
5933
|
+
* @format date
|
|
5675
5934
|
*/
|
|
5676
|
-
|
|
5677
|
-
|
|
5935
|
+
start_date?: string;
|
|
5936
|
+
/** Filters logs to a single end-user within the tenant. */
|
|
5937
|
+
user_id?: string;
|
|
5938
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
5678
5939
|
}
|
|
5679
5940
|
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5680
5941
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5745,115 +6006,6 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
5745
6006
|
security_primary_flag?: boolean;
|
|
5746
6007
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5747
6008
|
}
|
|
5748
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
5749
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5750
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5751
|
-
/**
|
|
5752
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
5753
|
-
* @tags Fund Analysis
|
|
5754
|
-
* @name GetFundAnalysis
|
|
5755
|
-
* @summary Get Fund Analysis
|
|
5756
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
5757
|
-
* @secure
|
|
5758
|
-
*/
|
|
5759
|
-
getFundAnalysis(fundId: number, query?: {
|
|
5760
|
-
/**
|
|
5761
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5762
|
-
* @default "en-US"
|
|
5763
|
-
*/
|
|
5764
|
-
language?: BridgeWiseLanguageEnum;
|
|
5765
|
-
/**
|
|
5766
|
-
* Year
|
|
5767
|
-
* Specify the year for which the analysis is requested.
|
|
5768
|
-
*/
|
|
5769
|
-
year?: number;
|
|
5770
|
-
/**
|
|
5771
|
-
* Quarter
|
|
5772
|
-
* Specify the quarter for which the analysis is requested.
|
|
5773
|
-
*/
|
|
5774
|
-
quarter?: number;
|
|
5775
|
-
/**
|
|
5776
|
-
* Show All
|
|
5777
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5778
|
-
*/
|
|
5779
|
-
show_all?: boolean;
|
|
5780
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
5781
|
-
/**
|
|
5782
|
-
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
5783
|
-
* @tags Fund Analysis
|
|
5784
|
-
* @name GetFundsParagraphs
|
|
5785
|
-
* @summary Get Funds Paragraphs
|
|
5786
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
5787
|
-
* @secure
|
|
5788
|
-
*/
|
|
5789
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
5790
|
-
/**
|
|
5791
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5792
|
-
* @default "en-US"
|
|
5793
|
-
*/
|
|
5794
|
-
language?: BridgeWiseLanguageEnum;
|
|
5795
|
-
/**
|
|
5796
|
-
* Year
|
|
5797
|
-
* Specify the year for which the analysis is requested.
|
|
5798
|
-
*/
|
|
5799
|
-
year?: number | null;
|
|
5800
|
-
/**
|
|
5801
|
-
* Quarter
|
|
5802
|
-
* Specify the quarter for which the analysis is requested.
|
|
5803
|
-
*/
|
|
5804
|
-
quarter?: number | null;
|
|
5805
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
5806
|
-
/**
|
|
5807
|
-
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
5808
|
-
* @tags Fund Analysis
|
|
5809
|
-
* @name GetFundParameters
|
|
5810
|
-
* @summary Get Fund Parameters
|
|
5811
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
5812
|
-
* @secure
|
|
5813
|
-
*/
|
|
5814
|
-
getFundParameters(fundId: number, query?: {
|
|
5815
|
-
/**
|
|
5816
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5817
|
-
* @default "en-US"
|
|
5818
|
-
*/
|
|
5819
|
-
language?: BridgeWiseLanguageEnum;
|
|
5820
|
-
/**
|
|
5821
|
-
* Parameter Id
|
|
5822
|
-
* ID of the parameter for analysis.
|
|
5823
|
-
*/
|
|
5824
|
-
parameter_id?: number;
|
|
5825
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
5826
|
-
/**
|
|
5827
|
-
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
5828
|
-
* @tags Fund Analysis
|
|
5829
|
-
* @name GetFundSections
|
|
5830
|
-
* @summary Get Fund Sections
|
|
5831
|
-
* @request GET:/funds/{fund_id}/sections
|
|
5832
|
-
* @secure
|
|
5833
|
-
*/
|
|
5834
|
-
getFundSections(fundId: number, query?: {
|
|
5835
|
-
/**
|
|
5836
|
-
* Year
|
|
5837
|
-
* Specify the year for which the analysis is requested.
|
|
5838
|
-
*/
|
|
5839
|
-
year?: number;
|
|
5840
|
-
/**
|
|
5841
|
-
* Quarter
|
|
5842
|
-
* Specify the quarter for which the analysis is requested.
|
|
5843
|
-
*/
|
|
5844
|
-
quarter?: number;
|
|
5845
|
-
/**
|
|
5846
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5847
|
-
* @default "en-US"
|
|
5848
|
-
*/
|
|
5849
|
-
language?: BridgeWiseLanguageEnum;
|
|
5850
|
-
/**
|
|
5851
|
-
* Show All
|
|
5852
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5853
|
-
*/
|
|
5854
|
-
show_all?: boolean;
|
|
5855
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
5856
|
-
}
|
|
5857
6009
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5858
6010
|
readonly config: JwtClientConfig<HandleError>;
|
|
5859
6011
|
activities: Activities<HandleError>;
|