@orbis-systems/orbis-api-clients 0.7.13 → 0.7.15
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 +297 -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 +1034 -882
- 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 +1535 -1265
- 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 +141 -72
- 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 +3907 -4063
- 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 +917 -1221
- 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 +607 -589
- 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,98 +3064,6 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
3031
3064
|
Iso = "iso",
|
|
3032
3065
|
Epoch = "epoch"
|
|
3033
3066
|
}
|
|
3034
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
3035
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3037
|
-
/**
|
|
3038
|
-
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
3039
|
-
* @tags Activities
|
|
3040
|
-
* @name GetCompanyAlerts
|
|
3041
|
-
* @summary Get Company Alerts
|
|
3042
|
-
* @request GET:/companies/{company_id}/alerts
|
|
3043
|
-
* @secure
|
|
3044
|
-
*/
|
|
3045
|
-
getCompanyAlerts(companyId: number, query?: {
|
|
3046
|
-
/**
|
|
3047
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3048
|
-
* @default "en-US"
|
|
3049
|
-
*/
|
|
3050
|
-
language?: BridgeWiseLanguageEnum;
|
|
3051
|
-
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
3052
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
3053
|
-
/** Filter alerts by their sentiment. */
|
|
3054
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
3055
|
-
/**
|
|
3056
|
-
* Importance
|
|
3057
|
-
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3058
|
-
*/
|
|
3059
|
-
importance?: string | null;
|
|
3060
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
3061
|
-
/**
|
|
3062
|
-
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
3063
|
-
* @tags Activities
|
|
3064
|
-
* @name GetCompanyForecastsKeyDevelopment
|
|
3065
|
-
* @summary Get Company Forecasts Key Development
|
|
3066
|
-
* @request GET:/companies/{company_id}/key-developments
|
|
3067
|
-
* @secure
|
|
3068
|
-
*/
|
|
3069
|
-
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
3070
|
-
/**
|
|
3071
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3072
|
-
* @default "en-US"
|
|
3073
|
-
*/
|
|
3074
|
-
language?: BridgeWiseLanguageEnum;
|
|
3075
|
-
/**
|
|
3076
|
-
* Importance
|
|
3077
|
-
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3078
|
-
* @default "0,1"
|
|
3079
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3080
|
-
*/
|
|
3081
|
-
importance?: string;
|
|
3082
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
3083
|
-
}
|
|
3084
|
-
export class Bridget<HandleError extends boolean = boolean> {
|
|
3085
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3086
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3087
|
-
/**
|
|
3088
|
-
* @tags Bridget
|
|
3089
|
-
* @name QuestionCreate
|
|
3090
|
-
* @request POST:/bridget/question
|
|
3091
|
-
* @secure
|
|
3092
|
-
*/
|
|
3093
|
-
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3094
|
-
/**
|
|
3095
|
-
* @tags Bridget
|
|
3096
|
-
* @name TenantsExportRetrieve
|
|
3097
|
-
* @request GET:/bridget/tenants/{tenant_id}/export
|
|
3098
|
-
* @secure
|
|
3099
|
-
*/
|
|
3100
|
-
tenantsExportRetrieve(tenantId: string, query?: {
|
|
3101
|
-
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3102
|
-
client_id?: string;
|
|
3103
|
-
/**
|
|
3104
|
-
* 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.
|
|
3105
|
-
* @format date
|
|
3106
|
-
*/
|
|
3107
|
-
date?: string;
|
|
3108
|
-
/**
|
|
3109
|
-
* 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.
|
|
3110
|
-
* @format date
|
|
3111
|
-
*/
|
|
3112
|
-
end_date?: string;
|
|
3113
|
-
/** Filters by user feedback on each answer. Allowed values: like | dislike */
|
|
3114
|
-
feedback_type?: string;
|
|
3115
|
-
/** Filters to a single chat session ID. */
|
|
3116
|
-
session_id?: string;
|
|
3117
|
-
/**
|
|
3118
|
-
* 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.
|
|
3119
|
-
* @format date
|
|
3120
|
-
*/
|
|
3121
|
-
start_date?: string;
|
|
3122
|
-
/** Filters logs to a single end-user within the tenant. */
|
|
3123
|
-
user_id?: string;
|
|
3124
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3125
|
-
}
|
|
3126
3067
|
export class Bwc<HandleError extends boolean = boolean> {
|
|
3127
3068
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3128
3069
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3450,75 +3391,6 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
3450
3391
|
identifier: string;
|
|
3451
3392
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3452
3393
|
}
|
|
3453
|
-
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3454
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3455
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3456
|
-
/**
|
|
3457
|
-
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3458
|
-
* @tags Company Market Data
|
|
3459
|
-
* @name GetCompanyMarketData
|
|
3460
|
-
* @summary Get Company Market Data
|
|
3461
|
-
* @request GET:/companies/{company_id}/market
|
|
3462
|
-
* @secure
|
|
3463
|
-
*/
|
|
3464
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
3465
|
-
/**
|
|
3466
|
-
* Trading Item Id
|
|
3467
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3468
|
-
*/
|
|
3469
|
-
trading_item_id?: number | null;
|
|
3470
|
-
/**
|
|
3471
|
-
* Date Ge
|
|
3472
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3473
|
-
*/
|
|
3474
|
-
date__ge?: string | null;
|
|
3475
|
-
/**
|
|
3476
|
-
* Date Le
|
|
3477
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3478
|
-
*/
|
|
3479
|
-
date__le?: string | null;
|
|
3480
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3481
|
-
/**
|
|
3482
|
-
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
3483
|
-
* @tags Company Market Data
|
|
3484
|
-
* @name GetCompanyMarketStatistics
|
|
3485
|
-
* @summary Get Company Market Statistics
|
|
3486
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
3487
|
-
* @secure
|
|
3488
|
-
*/
|
|
3489
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3490
|
-
/**
|
|
3491
|
-
* Trading Item Id
|
|
3492
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3493
|
-
*/
|
|
3494
|
-
trading_item_id?: number | null;
|
|
3495
|
-
/**
|
|
3496
|
-
* Identifier In
|
|
3497
|
-
* Specify a list of external identifiers.
|
|
3498
|
-
*/
|
|
3499
|
-
identifier__in?: string | null;
|
|
3500
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
3501
|
-
/**
|
|
3502
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3503
|
-
* @tags Company Market Data
|
|
3504
|
-
* @name GetTradingItems
|
|
3505
|
-
* @summary Get Trading Items
|
|
3506
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
3507
|
-
* @secure
|
|
3508
|
-
*/
|
|
3509
|
-
getTradingItems(companyId: number, query?: {
|
|
3510
|
-
/**
|
|
3511
|
-
* Primary Flag
|
|
3512
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3513
|
-
*/
|
|
3514
|
-
primary_flag?: boolean;
|
|
3515
|
-
/**
|
|
3516
|
-
* Security Primary Flag
|
|
3517
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3518
|
-
*/
|
|
3519
|
-
security_primary_flag?: boolean;
|
|
3520
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3521
|
-
}
|
|
3522
3394
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3523
3395
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3524
3396
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4058,6 +3930,64 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4058
3930
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4059
3931
|
*/
|
|
4060
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;
|
|
4061
3991
|
/**
|
|
4062
3992
|
* Tenant Id
|
|
4063
3993
|
* Specify the tenant ID to filter and retrieve companies recommended by that tenant.
|
|
@@ -4094,6 +4024,11 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4094
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>
|
|
4095
4025
|
*/
|
|
4096
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;
|
|
4097
4032
|
/**
|
|
4098
4033
|
* Page
|
|
4099
4034
|
* Define the page number for pagination.
|
|
@@ -4158,83 +4093,100 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4158
4093
|
identifier_type: string;
|
|
4159
4094
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4160
4095
|
}
|
|
4161
|
-
export class
|
|
4096
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
4162
4097
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4163
4098
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4164
4099
|
/**
|
|
4165
|
-
* @description
|
|
4166
|
-
* @tags
|
|
4167
|
-
* @name
|
|
4168
|
-
* @summary
|
|
4169
|
-
* @request GET:/companies/
|
|
4100
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4101
|
+
* @tags Logos
|
|
4102
|
+
* @name FetchLogos
|
|
4103
|
+
* @summary Fetch Logos
|
|
4104
|
+
* @request GET:/companies/logos
|
|
4170
4105
|
* @secure
|
|
4171
4106
|
*/
|
|
4172
|
-
|
|
4107
|
+
fetchLogos(query?: {
|
|
4173
4108
|
/**
|
|
4174
|
-
*
|
|
4175
|
-
*
|
|
4176
|
-
* @
|
|
4177
|
-
* @
|
|
4109
|
+
* Company Id In
|
|
4110
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
4111
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4112
|
+
* @example "74822,83343211"
|
|
4178
4113
|
*/
|
|
4179
|
-
|
|
4180
|
-
/**
|
|
4181
|
-
* Published Date Gte
|
|
4182
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4183
|
-
* @format date
|
|
4184
|
-
* @default "2025-07-22"
|
|
4185
|
-
*/
|
|
4186
|
-
published_date__gte?: string;
|
|
4187
|
-
/**
|
|
4188
|
-
* Published Date Lte
|
|
4189
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4190
|
-
* @format date
|
|
4191
|
-
* @default "2025-07-22"
|
|
4192
|
-
*/
|
|
4193
|
-
published_date__lte?: string;
|
|
4194
|
-
/**
|
|
4195
|
-
* Specify the field by which to sort the results.
|
|
4196
|
-
* @default "publication_date"
|
|
4197
|
-
*/
|
|
4198
|
-
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4114
|
+
company_id__in?: string;
|
|
4199
4115
|
/**
|
|
4200
4116
|
* Size
|
|
4201
|
-
*
|
|
4202
|
-
* @
|
|
4203
|
-
* @
|
|
4117
|
+
* Page size
|
|
4118
|
+
* @min 1
|
|
4119
|
+
* @max 100
|
|
4120
|
+
* @default 50
|
|
4204
4121
|
*/
|
|
4205
4122
|
size?: number;
|
|
4206
4123
|
/**
|
|
4207
4124
|
* Page
|
|
4208
|
-
*
|
|
4125
|
+
* Page number
|
|
4126
|
+
* @min 1
|
|
4209
4127
|
* @default 1
|
|
4210
|
-
* @example 1
|
|
4211
4128
|
*/
|
|
4212
4129
|
page?: number;
|
|
4213
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4130
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4214
4131
|
/**
|
|
4215
|
-
* @description
|
|
4216
|
-
* @tags
|
|
4217
|
-
* @name
|
|
4218
|
-
* @summary
|
|
4219
|
-
* @request GET:/companies/{company_id}/
|
|
4132
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4133
|
+
* @tags Logos
|
|
4134
|
+
* @name FetchLogo
|
|
4135
|
+
* @summary Fetch Logo
|
|
4136
|
+
* @request GET:/companies/{company_id}/logos
|
|
4220
4137
|
* @secure
|
|
4221
4138
|
*/
|
|
4222
|
-
|
|
4139
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4140
|
+
}
|
|
4141
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
4142
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4143
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4144
|
+
/**
|
|
4145
|
+
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
4146
|
+
* @tags Activities
|
|
4147
|
+
* @name GetCompanyAlerts
|
|
4148
|
+
* @summary Get Company Alerts
|
|
4149
|
+
* @request GET:/companies/{company_id}/alerts
|
|
4150
|
+
* @secure
|
|
4151
|
+
*/
|
|
4152
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
4223
4153
|
/**
|
|
4224
|
-
*
|
|
4225
|
-
*
|
|
4226
|
-
* @format date
|
|
4227
|
-
* @default "2025-07-22"
|
|
4154
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4155
|
+
* @default "en-US"
|
|
4228
4156
|
*/
|
|
4229
|
-
|
|
4157
|
+
language?: BridgeWiseLanguageEnum;
|
|
4158
|
+
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
4159
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
4160
|
+
/** Filter alerts by their sentiment. */
|
|
4161
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
4230
4162
|
/**
|
|
4231
|
-
*
|
|
4232
|
-
*
|
|
4233
|
-
* @format date
|
|
4234
|
-
* @default "2025-07-22"
|
|
4163
|
+
* Importance
|
|
4164
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
4235
4165
|
*/
|
|
4236
|
-
|
|
4237
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4166
|
+
importance?: string | null;
|
|
4167
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
4168
|
+
/**
|
|
4169
|
+
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
4170
|
+
* @tags Activities
|
|
4171
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
4172
|
+
* @summary Get Company Forecasts Key Development
|
|
4173
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
4174
|
+
* @secure
|
|
4175
|
+
*/
|
|
4176
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
4177
|
+
/**
|
|
4178
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4179
|
+
* @default "en-US"
|
|
4180
|
+
*/
|
|
4181
|
+
language?: BridgeWiseLanguageEnum;
|
|
4182
|
+
/**
|
|
4183
|
+
* Importance
|
|
4184
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
4185
|
+
* @default "0,1"
|
|
4186
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4187
|
+
*/
|
|
4188
|
+
importance?: string;
|
|
4189
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
4238
4190
|
}
|
|
4239
4191
|
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
4240
4192
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4589,152 +4541,44 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4589
4541
|
*/
|
|
4590
4542
|
date__lte?: string;
|
|
4591
4543
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4592
|
-
}
|
|
4593
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
4594
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4595
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4596
|
-
/**
|
|
4597
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
4598
|
-
* @tags Fund Analysis
|
|
4599
|
-
* @name GetFundAnalysis
|
|
4600
|
-
* @summary Get Fund Analysis
|
|
4601
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
4602
|
-
* @secure
|
|
4603
|
-
*/
|
|
4604
|
-
getFundAnalysis(fundId: number, query?: {
|
|
4605
|
-
/**
|
|
4606
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4607
|
-
* @default "en-US"
|
|
4608
|
-
*/
|
|
4609
|
-
language?: BridgeWiseLanguageEnum;
|
|
4610
|
-
/**
|
|
4611
|
-
* Year
|
|
4612
|
-
* Specify the year for which the analysis is requested.
|
|
4613
|
-
*/
|
|
4614
|
-
year?: number;
|
|
4615
|
-
/**
|
|
4616
|
-
* Quarter
|
|
4617
|
-
* Specify the quarter for which the analysis is requested.
|
|
4618
|
-
*/
|
|
4619
|
-
quarter?: number;
|
|
4620
|
-
/**
|
|
4621
|
-
* Show All
|
|
4622
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4623
|
-
*/
|
|
4624
|
-
show_all?: boolean;
|
|
4625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
4626
|
-
/**
|
|
4627
|
-
* @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.
|
|
4628
|
-
* @tags Fund Analysis
|
|
4629
|
-
* @name GetFundsParagraphs
|
|
4630
|
-
* @summary Get Funds Paragraphs
|
|
4631
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
4632
|
-
* @secure
|
|
4633
|
-
*/
|
|
4634
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
4635
|
-
/**
|
|
4636
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4637
|
-
* @default "en-US"
|
|
4638
|
-
*/
|
|
4639
|
-
language?: BridgeWiseLanguageEnum;
|
|
4640
|
-
/**
|
|
4641
|
-
* Year
|
|
4642
|
-
* Specify the year for which the analysis is requested.
|
|
4643
|
-
*/
|
|
4644
|
-
year?: number | null;
|
|
4645
|
-
/**
|
|
4646
|
-
* Quarter
|
|
4647
|
-
* Specify the quarter for which the analysis is requested.
|
|
4648
|
-
*/
|
|
4649
|
-
quarter?: number | null;
|
|
4650
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
4651
|
-
/**
|
|
4652
|
-
* @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.
|
|
4653
|
-
* @tags Fund Analysis
|
|
4654
|
-
* @name GetFundParameters
|
|
4655
|
-
* @summary Get Fund Parameters
|
|
4656
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
4657
|
-
* @secure
|
|
4658
|
-
*/
|
|
4659
|
-
getFundParameters(fundId: number, query?: {
|
|
4660
|
-
/**
|
|
4661
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4662
|
-
* @default "en-US"
|
|
4663
|
-
*/
|
|
4664
|
-
language?: BridgeWiseLanguageEnum;
|
|
4665
|
-
/**
|
|
4666
|
-
* Parameter Id
|
|
4667
|
-
* ID of the parameter for analysis.
|
|
4668
|
-
*/
|
|
4669
|
-
parameter_id?: number;
|
|
4670
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
4671
4544
|
/**
|
|
4672
|
-
* @description
|
|
4673
|
-
* @tags
|
|
4674
|
-
* @name
|
|
4675
|
-
* @summary Get
|
|
4676
|
-
* @request GET:/
|
|
4545
|
+
* @description This endpoint provides textual analyses and predictions regarding a company's future stock price, including price targets set by analysts.
|
|
4546
|
+
* @tags Fundamental Analysis
|
|
4547
|
+
* @name GetCompanyPriceTargetParagraphs
|
|
4548
|
+
* @summary Get Company Price Target Paragraphs
|
|
4549
|
+
* @request GET:/companies/{company_id}/target-price-paragraphs
|
|
4677
4550
|
* @secure
|
|
4678
4551
|
*/
|
|
4679
|
-
|
|
4680
|
-
/**
|
|
4681
|
-
* Year
|
|
4682
|
-
* Specify the year for which the analysis is requested.
|
|
4683
|
-
*/
|
|
4684
|
-
year?: number;
|
|
4685
|
-
/**
|
|
4686
|
-
* Quarter
|
|
4687
|
-
* Specify the quarter for which the analysis is requested.
|
|
4688
|
-
*/
|
|
4689
|
-
quarter?: number;
|
|
4552
|
+
getCompanyPriceTargetParagraphs(companyId: number, query?: {
|
|
4690
4553
|
/**
|
|
4691
4554
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4692
4555
|
* @default "en-US"
|
|
4693
4556
|
*/
|
|
4694
4557
|
language?: BridgeWiseLanguageEnum;
|
|
4695
4558
|
/**
|
|
4696
|
-
*
|
|
4697
|
-
*
|
|
4698
|
-
*/
|
|
4699
|
-
show_all?: boolean;
|
|
4700
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
4701
|
-
}
|
|
4702
|
-
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
4703
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4704
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4705
|
-
/**
|
|
4706
|
-
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
4707
|
-
* @tags Fund ESG Analysis
|
|
4708
|
-
* @name GetFundEsgAnalysis
|
|
4709
|
-
* @summary Get Fund Esg Analysis
|
|
4710
|
-
* @request GET:/funds/{fund_id}/esg-analysis
|
|
4711
|
-
* @secure
|
|
4712
|
-
*/
|
|
4713
|
-
getFundEsgAnalysis(fundId: number, query?: {
|
|
4714
|
-
/**
|
|
4715
|
-
* Limit
|
|
4716
|
-
* Number of historical periods to be returned (default is 1).
|
|
4559
|
+
* Trading Item Id
|
|
4560
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4717
4561
|
*/
|
|
4718
|
-
|
|
4562
|
+
trading_item_id?: number;
|
|
4719
4563
|
/**
|
|
4720
|
-
*
|
|
4721
|
-
*
|
|
4564
|
+
* Section Type
|
|
4565
|
+
* Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
|
|
4722
4566
|
*/
|
|
4723
|
-
|
|
4724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4567
|
+
section_type?: string;
|
|
4568
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4725
4569
|
}
|
|
4726
|
-
export class
|
|
4570
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
4727
4571
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4728
4572
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4729
4573
|
/**
|
|
4730
|
-
* @description Offers key market data for the specified
|
|
4731
|
-
* @tags
|
|
4732
|
-
* @name
|
|
4733
|
-
* @summary Get
|
|
4734
|
-
* @request GET:/
|
|
4574
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
4575
|
+
* @tags Company Market Data
|
|
4576
|
+
* @name GetCompanyMarketData
|
|
4577
|
+
* @summary Get Company Market Data
|
|
4578
|
+
* @request GET:/companies/{company_id}/market
|
|
4735
4579
|
* @secure
|
|
4736
4580
|
*/
|
|
4737
|
-
|
|
4581
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
4738
4582
|
/**
|
|
4739
4583
|
* Trading Item Id
|
|
4740
4584
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -4750,16 +4594,16 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
4750
4594
|
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4751
4595
|
*/
|
|
4752
4596
|
date__le?: string | null;
|
|
4753
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4597
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4754
4598
|
/**
|
|
4755
|
-
* @description Provides detailed market statistics for the specified
|
|
4756
|
-
* @tags
|
|
4757
|
-
* @name
|
|
4758
|
-
* @summary Get
|
|
4759
|
-
* @request GET:/
|
|
4599
|
+
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4600
|
+
* @tags Company Market Data
|
|
4601
|
+
* @name GetCompanyMarketStatistics
|
|
4602
|
+
* @summary Get Company Market Statistics
|
|
4603
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
4760
4604
|
* @secure
|
|
4761
4605
|
*/
|
|
4762
|
-
|
|
4606
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4763
4607
|
/**
|
|
4764
4608
|
* Trading Item Id
|
|
4765
4609
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -4770,16 +4614,16 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
4770
4614
|
* Specify a list of external identifiers.
|
|
4771
4615
|
*/
|
|
4772
4616
|
identifier__in?: string | null;
|
|
4773
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4617
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4774
4618
|
/**
|
|
4775
|
-
* @description Returns detailed information on trading items related to the specified
|
|
4776
|
-
* @tags
|
|
4777
|
-
* @name
|
|
4778
|
-
* @summary Get
|
|
4779
|
-
* @request GET:/
|
|
4619
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4620
|
+
* @tags Company Market Data
|
|
4621
|
+
* @name GetTradingItems
|
|
4622
|
+
* @summary Get Trading Items
|
|
4623
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
4780
4624
|
* @secure
|
|
4781
4625
|
*/
|
|
4782
|
-
|
|
4626
|
+
getTradingItems(companyId: number, query?: {
|
|
4783
4627
|
/**
|
|
4784
4628
|
* Primary Flag
|
|
4785
4629
|
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
@@ -4790,147 +4634,439 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
4790
4634
|
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4791
4635
|
*/
|
|
4792
4636
|
security_primary_flag?: boolean;
|
|
4793
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList
|
|
4637
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4794
4638
|
}
|
|
4795
|
-
export class
|
|
4639
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4796
4640
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4797
4641
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4798
4642
|
/**
|
|
4799
|
-
* @description
|
|
4800
|
-
* @tags
|
|
4801
|
-
* @name
|
|
4802
|
-
* @summary Get
|
|
4803
|
-
* @request GET:/
|
|
4643
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
4644
|
+
* @tags Company News
|
|
4645
|
+
* @name GetCompanyNews
|
|
4646
|
+
* @summary Get Company News
|
|
4647
|
+
* @request GET:/companies/{company_id}/news
|
|
4804
4648
|
* @secure
|
|
4805
4649
|
*/
|
|
4806
|
-
|
|
4807
|
-
/**
|
|
4808
|
-
* Search
|
|
4809
|
-
* Funds search.
|
|
4810
|
-
*/
|
|
4811
|
-
search?: string;
|
|
4812
|
-
/**
|
|
4813
|
-
* Peers Of
|
|
4814
|
-
* Get peers funds of a specific fund.
|
|
4815
|
-
*/
|
|
4816
|
-
peers_of?: number;
|
|
4817
|
-
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
|
|
4818
|
-
sort_by?: BridgeWiseFundsSortByEnum;
|
|
4650
|
+
getCompanyNews(companyId: number, query?: {
|
|
4819
4651
|
/**
|
|
4652
|
+
* Languages
|
|
4820
4653
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4821
4654
|
* @default "en-US"
|
|
4655
|
+
* @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
|
|
4822
4656
|
*/
|
|
4823
|
-
|
|
4657
|
+
languages?: string;
|
|
4824
4658
|
/**
|
|
4825
|
-
*
|
|
4826
|
-
*
|
|
4827
|
-
* @
|
|
4659
|
+
* Published Date Gte
|
|
4660
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4661
|
+
* @format date
|
|
4662
|
+
* @default "2025-09-01"
|
|
4828
4663
|
*/
|
|
4829
|
-
|
|
4664
|
+
published_date__gte?: string;
|
|
4830
4665
|
/**
|
|
4831
|
-
*
|
|
4832
|
-
*
|
|
4666
|
+
* Published Date Lte
|
|
4667
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4668
|
+
* @format date
|
|
4669
|
+
* @default "2025-09-01"
|
|
4833
4670
|
*/
|
|
4834
|
-
|
|
4671
|
+
published_date__lte?: string;
|
|
4835
4672
|
/**
|
|
4836
|
-
*
|
|
4837
|
-
*
|
|
4838
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4673
|
+
* Specify the field by which to sort the results.
|
|
4674
|
+
* @default "publication_date"
|
|
4839
4675
|
*/
|
|
4840
|
-
|
|
4676
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4841
4677
|
/**
|
|
4842
|
-
*
|
|
4843
|
-
*
|
|
4844
|
-
* @
|
|
4678
|
+
* Size
|
|
4679
|
+
* Define the number of records per page for pagination purposes.
|
|
4680
|
+
* @default 10
|
|
4681
|
+
* @example 10
|
|
4845
4682
|
*/
|
|
4846
|
-
|
|
4683
|
+
size?: number;
|
|
4847
4684
|
/**
|
|
4848
|
-
*
|
|
4849
|
-
*
|
|
4850
|
-
* @
|
|
4685
|
+
* Page
|
|
4686
|
+
* Define the page number for pagination.
|
|
4687
|
+
* @default 1
|
|
4688
|
+
* @example 1
|
|
4851
4689
|
*/
|
|
4852
|
-
|
|
4690
|
+
page?: number;
|
|
4691
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4692
|
+
/**
|
|
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
|
|
4698
|
+
* @secure
|
|
4699
|
+
*/
|
|
4700
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4853
4701
|
/**
|
|
4854
|
-
*
|
|
4855
|
-
*
|
|
4856
|
-
* @
|
|
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"
|
|
4857
4706
|
*/
|
|
4858
|
-
|
|
4707
|
+
published_date__gte?: string;
|
|
4859
4708
|
/**
|
|
4860
|
-
*
|
|
4861
|
-
*
|
|
4862
|
-
* @
|
|
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"
|
|
4863
4713
|
*/
|
|
4864
|
-
|
|
4714
|
+
published_date__lte?: string;
|
|
4715
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4716
|
+
}
|
|
4717
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4718
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4719
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4720
|
+
/**
|
|
4721
|
+
* @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
|
|
4722
|
+
* @tags Technical Analysis
|
|
4723
|
+
* @name GetCompanyTechnicalAnalysis
|
|
4724
|
+
* @summary Get Company Technical Analysis
|
|
4725
|
+
* @request GET:/companies/{company_id}/technical-analysis
|
|
4726
|
+
* @secure
|
|
4727
|
+
*/
|
|
4728
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
4865
4729
|
/**
|
|
4866
|
-
*
|
|
4867
|
-
*
|
|
4868
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4730
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4731
|
+
* @default "en-US"
|
|
4869
4732
|
*/
|
|
4870
|
-
|
|
4733
|
+
language?: BridgeWiseLanguageEnum;
|
|
4871
4734
|
/**
|
|
4872
|
-
*
|
|
4873
|
-
*
|
|
4874
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4735
|
+
* Trading Item Id
|
|
4736
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4875
4737
|
*/
|
|
4876
|
-
|
|
4738
|
+
trading_item_id?: number;
|
|
4739
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
4740
|
+
/**
|
|
4741
|
+
* @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
|
|
4742
|
+
* @tags Technical Analysis
|
|
4743
|
+
* @name GetCompanyTechnicalParagraphs
|
|
4744
|
+
* @summary Get Company Technical Paragraphs
|
|
4745
|
+
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
4746
|
+
* @secure
|
|
4747
|
+
*/
|
|
4748
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
4877
4749
|
/**
|
|
4878
|
-
*
|
|
4879
|
-
*
|
|
4880
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4750
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4751
|
+
* @default "en-US"
|
|
4881
4752
|
*/
|
|
4882
|
-
|
|
4753
|
+
language?: BridgeWiseLanguageEnum;
|
|
4883
4754
|
/**
|
|
4884
|
-
*
|
|
4885
|
-
*
|
|
4886
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4755
|
+
* Trading Item Id
|
|
4756
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4887
4757
|
*/
|
|
4888
|
-
|
|
4758
|
+
trading_item_id?: number;
|
|
4759
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
4760
|
+
/**
|
|
4761
|
+
* @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
4762
|
+
* @tags Technical Analysis
|
|
4763
|
+
* @name GetCompanyTechnicalParameters
|
|
4764
|
+
* @summary Get Company Technical Parameters
|
|
4765
|
+
* @request GET:/companies/{company_id}/technical-parameters
|
|
4766
|
+
* @secure
|
|
4767
|
+
*/
|
|
4768
|
+
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
4889
4769
|
/**
|
|
4890
|
-
*
|
|
4891
|
-
*
|
|
4770
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4771
|
+
* @default "en-US"
|
|
4892
4772
|
*/
|
|
4893
|
-
|
|
4773
|
+
language?: BridgeWiseLanguageEnum;
|
|
4894
4774
|
/**
|
|
4895
|
-
*
|
|
4896
|
-
*
|
|
4897
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4775
|
+
* Trading Item Id
|
|
4776
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4898
4777
|
*/
|
|
4899
|
-
|
|
4778
|
+
trading_item_id?: number;
|
|
4900
4779
|
/**
|
|
4901
|
-
*
|
|
4902
|
-
*
|
|
4903
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4780
|
+
* Parameter Id
|
|
4781
|
+
* Get desired parameter by ID.
|
|
4904
4782
|
*/
|
|
4905
|
-
|
|
4783
|
+
parameter_id?: number;
|
|
4784
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
4785
|
+
}
|
|
4786
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
4787
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4788
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4789
|
+
/**
|
|
4790
|
+
* @description Retrieve a list of themes and their details associated with the company.
|
|
4791
|
+
* @tags Themes
|
|
4792
|
+
* @name GetCompanyThemes
|
|
4793
|
+
* @summary Get Company Themes
|
|
4794
|
+
* @request GET:/companies/{company_id}/themes
|
|
4795
|
+
* @secure
|
|
4796
|
+
*/
|
|
4797
|
+
getCompanyThemes(companyId: number, query?: {
|
|
4906
4798
|
/**
|
|
4907
|
-
*
|
|
4908
|
-
*
|
|
4799
|
+
* Sort By
|
|
4800
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4801
|
+
* @default "group,rank"
|
|
4909
4802
|
*/
|
|
4910
|
-
|
|
4803
|
+
sort_by?: string | null;
|
|
4911
4804
|
/**
|
|
4912
|
-
*
|
|
4913
|
-
*
|
|
4805
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4806
|
+
* @default "en-US"
|
|
4914
4807
|
*/
|
|
4915
|
-
|
|
4808
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4809
|
+
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
4810
|
+
group?: BridgeWiseThemeGroupEnum;
|
|
4811
|
+
/** Filter basic and advanced theme packages. */
|
|
4812
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4813
|
+
/** The type of the theme. */
|
|
4814
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4916
4815
|
/**
|
|
4917
|
-
*
|
|
4918
|
-
*
|
|
4816
|
+
* Page
|
|
4817
|
+
* Define the page number for pagination.
|
|
4818
|
+
* @min 1
|
|
4819
|
+
* @default 1
|
|
4919
4820
|
*/
|
|
4920
|
-
|
|
4821
|
+
page?: number;
|
|
4921
4822
|
/**
|
|
4922
|
-
*
|
|
4923
|
-
*
|
|
4823
|
+
* Page Size
|
|
4824
|
+
* Define the number of records per page for pagination purposes.
|
|
4825
|
+
* @min 1
|
|
4826
|
+
* @default 10
|
|
4924
4827
|
*/
|
|
4925
|
-
|
|
4828
|
+
page_size?: number;
|
|
4829
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
4830
|
+
/**
|
|
4831
|
+
* @description Retrieve a list of themes with their details. Filter by theme_id or search term, and order by any theme field. If no filter is provided, all themes are returned.
|
|
4832
|
+
* @tags Themes
|
|
4833
|
+
* @name GetThemes
|
|
4834
|
+
* @summary Get Themes
|
|
4835
|
+
* @request GET:/themes
|
|
4836
|
+
* @secure
|
|
4837
|
+
*/
|
|
4838
|
+
getThemes(query?: {
|
|
4926
4839
|
/**
|
|
4927
|
-
*
|
|
4928
|
-
*
|
|
4840
|
+
* Search
|
|
4841
|
+
* Search string to filter themes by name or description.
|
|
4929
4842
|
*/
|
|
4930
|
-
|
|
4843
|
+
search?: string | null;
|
|
4931
4844
|
/**
|
|
4932
|
-
*
|
|
4933
|
-
*
|
|
4845
|
+
* Sort By
|
|
4846
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4847
|
+
* @default "rank"
|
|
4848
|
+
*/
|
|
4849
|
+
sort_by?: string;
|
|
4850
|
+
/**
|
|
4851
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4852
|
+
* @default "en-US"
|
|
4853
|
+
*/
|
|
4854
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4855
|
+
/** Filter basic and advanced theme packages. */
|
|
4856
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4857
|
+
/** The type of the theme. */
|
|
4858
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4859
|
+
/**
|
|
4860
|
+
* Page
|
|
4861
|
+
* Define the page number for pagination.
|
|
4862
|
+
* @min 1
|
|
4863
|
+
* @default 1
|
|
4864
|
+
*/
|
|
4865
|
+
page?: number;
|
|
4866
|
+
/**
|
|
4867
|
+
* Page Size
|
|
4868
|
+
* Define the number of records per page for pagination purposes.
|
|
4869
|
+
* @min 1
|
|
4870
|
+
* @default 10
|
|
4871
|
+
*/
|
|
4872
|
+
page_size?: number;
|
|
4873
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
4874
|
+
/**
|
|
4875
|
+
* @description Retrieve a specific theme by its ID.
|
|
4876
|
+
* @tags Themes
|
|
4877
|
+
* @name GetTheme
|
|
4878
|
+
* @summary Get Theme
|
|
4879
|
+
* @request GET:/themes/{theme_id}
|
|
4880
|
+
* @secure
|
|
4881
|
+
*/
|
|
4882
|
+
getTheme(themeId: number, query?: {
|
|
4883
|
+
/**
|
|
4884
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4885
|
+
* @default "en-US"
|
|
4886
|
+
*/
|
|
4887
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4888
|
+
/**
|
|
4889
|
+
* Include Filter
|
|
4890
|
+
* Include theme filters.
|
|
4891
|
+
* @default false
|
|
4892
|
+
*/
|
|
4893
|
+
include_filter?: boolean;
|
|
4894
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
4895
|
+
/**
|
|
4896
|
+
* @tags Themes
|
|
4897
|
+
* @name GetThemeFilters
|
|
4898
|
+
* @summary Get Theme Filters
|
|
4899
|
+
* @request GET:/themes/{theme_id}/filters
|
|
4900
|
+
* @secure
|
|
4901
|
+
*/
|
|
4902
|
+
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
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
|
+
}
|
|
4925
|
+
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4926
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4927
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4928
|
+
/**
|
|
4929
|
+
* @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
|
|
4930
|
+
* @tags Fund Metadata
|
|
4931
|
+
* @name GetFunds
|
|
4932
|
+
* @summary Get Funds
|
|
4933
|
+
* @request GET:/funds
|
|
4934
|
+
* @secure
|
|
4935
|
+
*/
|
|
4936
|
+
getFunds(query?: {
|
|
4937
|
+
/**
|
|
4938
|
+
* Search
|
|
4939
|
+
* Funds search.
|
|
4940
|
+
*/
|
|
4941
|
+
search?: string;
|
|
4942
|
+
/**
|
|
4943
|
+
* Peers Of
|
|
4944
|
+
* Get peers funds of a specific fund.
|
|
4945
|
+
*/
|
|
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;
|
|
4953
|
+
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
|
|
4954
|
+
sort_by?: BridgeWiseFundsSortByEnum;
|
|
4955
|
+
/**
|
|
4956
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4957
|
+
* @default "en-US"
|
|
4958
|
+
*/
|
|
4959
|
+
language?: BridgeWiseLanguageEnum;
|
|
4960
|
+
/**
|
|
4961
|
+
* Sponsor Id
|
|
4962
|
+
* Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
|
|
4963
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4964
|
+
*/
|
|
4965
|
+
sponsor_id?: string;
|
|
4966
|
+
/**
|
|
4967
|
+
* Vehicle Type
|
|
4968
|
+
* Desired vehicle type for the fund.
|
|
4969
|
+
*/
|
|
4970
|
+
vehicle_type?: string;
|
|
4971
|
+
/**
|
|
4972
|
+
* Management Style Id
|
|
4973
|
+
* Comma-separated unique identifiers of the management style for the fund. <br>Example: 9617760,9617759</br>
|
|
4974
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4975
|
+
*/
|
|
4976
|
+
management_style_id?: string;
|
|
4977
|
+
/**
|
|
4978
|
+
* Market Cap Emphasis Id
|
|
4979
|
+
* Comma-separated unique identifiers of market capitalization emphasis. <br>Example: 4072,4073</br>
|
|
4980
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4981
|
+
*/
|
|
4982
|
+
market_cap_emphasis_id?: string;
|
|
4983
|
+
/**
|
|
4984
|
+
* Sector Emphasis Id
|
|
4985
|
+
* Comma-separated unique identifiers of sector emphasis <br>Example: 50,60</br>.
|
|
4986
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4987
|
+
*/
|
|
4988
|
+
sector_emphasis_id?: string;
|
|
4989
|
+
/**
|
|
4990
|
+
* Geography Emphasis Id
|
|
4991
|
+
* Geography emphasis on sector for the fund. <br>Example: 30,37</br>
|
|
4992
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4993
|
+
*/
|
|
4994
|
+
geography_emphasis_id?: string;
|
|
4995
|
+
/**
|
|
4996
|
+
* Exposure Id
|
|
4997
|
+
* Comma-separated unique exposure identifiers of the fund
|
|
4998
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4999
|
+
*/
|
|
5000
|
+
exposure_id?: string;
|
|
5001
|
+
/**
|
|
5002
|
+
* Leverage
|
|
5003
|
+
* Comma-separated unique leverage values of the fund. <br>Example: -200,-100,100,125,200,300</br>
|
|
5004
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5005
|
+
*/
|
|
5006
|
+
leverage?: string;
|
|
5007
|
+
/**
|
|
5008
|
+
* Leverage Not In
|
|
5009
|
+
* Comma-separated unique leverage values to exclude from the fund search results. <br>Example: -200,-100,100,125,200,300</br>
|
|
5010
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5011
|
+
*/
|
|
5012
|
+
leverage__not_in?: string;
|
|
5013
|
+
/**
|
|
5014
|
+
* Market Benchmark Id
|
|
5015
|
+
* Comma-separated unique identifiers of market benchmark. <br>Example: 42892091,29102231</br>
|
|
5016
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5017
|
+
*/
|
|
5018
|
+
market_benchmark_id?: string;
|
|
5019
|
+
/**
|
|
5020
|
+
* Primary Benchmark Id
|
|
5021
|
+
* Comma-separated unique identifiers of primary benchmark. <br>Example: 42892091,29102231</br>
|
|
5022
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5023
|
+
*/
|
|
5024
|
+
primary_benchmark_id?: string;
|
|
5025
|
+
/**
|
|
5026
|
+
* Has Score
|
|
5027
|
+
* Indicates if the fund has a score.
|
|
5028
|
+
*/
|
|
5029
|
+
has_score?: boolean;
|
|
5030
|
+
/**
|
|
5031
|
+
* Currency Market Id
|
|
5032
|
+
* Comma-separated unique currency market identifiers. <br>Example: 55,149</br>
|
|
5033
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5034
|
+
*/
|
|
5035
|
+
currency_market_id?: string;
|
|
5036
|
+
/**
|
|
5037
|
+
* Exchange Id
|
|
5038
|
+
* Comma-separated unique identifiers of fund exchange. <br>Example: 104,106</br>
|
|
5039
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5040
|
+
*/
|
|
5041
|
+
exchange_id?: string;
|
|
5042
|
+
/**
|
|
5043
|
+
* Pct Of Equity Holdings Gte
|
|
5044
|
+
* Percentage of equity holdings greater than or equal specific value.
|
|
5045
|
+
*/
|
|
5046
|
+
pct_of_equity_holdings__gte?: string;
|
|
5047
|
+
/**
|
|
5048
|
+
* Pct Of Equity Holdings Lte
|
|
5049
|
+
* Percentage of equity holdings less than or equal specific value.
|
|
5050
|
+
*/
|
|
5051
|
+
pct_of_equity_holdings__lte?: string;
|
|
5052
|
+
/**
|
|
5053
|
+
* Beta 1Y Gte
|
|
5054
|
+
* Beta greater than or equal specific value.
|
|
5055
|
+
*/
|
|
5056
|
+
beta_1y__gte?: string;
|
|
5057
|
+
/**
|
|
5058
|
+
* Beta 1Y Lte
|
|
5059
|
+
* Beta less than or equal specific value.
|
|
5060
|
+
*/
|
|
5061
|
+
beta_1y__lte?: string;
|
|
5062
|
+
/**
|
|
5063
|
+
* Tracking Error 1Y Gte
|
|
5064
|
+
* Tracking error greater than or equal to the specified value.
|
|
5065
|
+
*/
|
|
5066
|
+
tracking_error_1y__gte?: string;
|
|
5067
|
+
/**
|
|
5068
|
+
* Tracking Error 1Y Lte
|
|
5069
|
+
* Tracking error less than or equal to the specified value.
|
|
4934
5070
|
*/
|
|
4935
5071
|
tracking_error_1y__lte?: string;
|
|
4936
5072
|
/**
|
|
@@ -4955,12 +5091,12 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
4955
5091
|
avg_trading_volume_3m__lte?: string;
|
|
4956
5092
|
/**
|
|
4957
5093
|
* Trading Volume Ratio Gte
|
|
4958
|
-
* Trading
|
|
5094
|
+
* Trading turnover greater than or equal specific value.
|
|
4959
5095
|
*/
|
|
4960
5096
|
trading_volume_ratio__gte?: string;
|
|
4961
5097
|
/**
|
|
4962
5098
|
* Trading Volume Ratio Lte
|
|
4963
|
-
* Trading
|
|
5099
|
+
* Trading turnover less than or equal specific value.
|
|
4964
5100
|
*/
|
|
4965
5101
|
trading_volume_ratio__lte?: string;
|
|
4966
5102
|
/**
|
|
@@ -5178,40 +5314,149 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
5178
5314
|
language?: BridgeWiseLanguageEnum;
|
|
5179
5315
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
5180
5316
|
}
|
|
5181
|
-
export class
|
|
5317
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
5182
5318
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5183
5319
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5184
5320
|
/**
|
|
5185
|
-
* @description
|
|
5186
|
-
* @tags
|
|
5187
|
-
* @name
|
|
5188
|
-
* @summary Get
|
|
5189
|
-
* @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
|
|
5190
5326
|
* @secure
|
|
5191
5327
|
*/
|
|
5192
|
-
|
|
5328
|
+
getFundAnalysis(fundId: number, query?: {
|
|
5193
5329
|
/**
|
|
5194
5330
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5195
5331
|
* @default "en-US"
|
|
5196
5332
|
*/
|
|
5197
5333
|
language?: BridgeWiseLanguageEnum;
|
|
5198
|
-
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5199
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5200
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5201
|
-
/**
|
|
5202
|
-
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5203
|
-
* @tags Holdings
|
|
5204
|
-
* @name GetHoldingStatistics
|
|
5205
|
-
* @summary Get Holding Statistics
|
|
5206
|
-
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5207
|
-
* @secure
|
|
5208
|
-
*/
|
|
5209
|
-
getHoldingStatistics(fundId: number, query?: {
|
|
5210
5334
|
/**
|
|
5211
|
-
*
|
|
5212
|
-
*
|
|
5335
|
+
* Year
|
|
5336
|
+
* Specify the year for which the analysis is requested.
|
|
5213
5337
|
*/
|
|
5214
|
-
|
|
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?: {
|
|
5359
|
+
/**
|
|
5360
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5361
|
+
* @default "en-US"
|
|
5362
|
+
*/
|
|
5363
|
+
language?: BridgeWiseLanguageEnum;
|
|
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>>;
|
|
5375
|
+
/**
|
|
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
|
|
5381
|
+
* @secure
|
|
5382
|
+
*/
|
|
5383
|
+
getFundParameters(fundId: number, query?: {
|
|
5384
|
+
/**
|
|
5385
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5386
|
+
* @default "en-US"
|
|
5387
|
+
*/
|
|
5388
|
+
language?: BridgeWiseLanguageEnum;
|
|
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>>;
|
|
5425
|
+
}
|
|
5426
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5427
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5428
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5429
|
+
/**
|
|
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
|
|
5435
|
+
* @secure
|
|
5436
|
+
*/
|
|
5437
|
+
getCompositions(fundId: number, query?: {
|
|
5438
|
+
/**
|
|
5439
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5440
|
+
* @default "en-US"
|
|
5441
|
+
*/
|
|
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?: {
|
|
5455
|
+
/**
|
|
5456
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5457
|
+
* @default "en-US"
|
|
5458
|
+
*/
|
|
5459
|
+
language?: BridgeWiseLanguageEnum;
|
|
5215
5460
|
/**
|
|
5216
5461
|
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5217
5462
|
* @default "stocks"
|
|
@@ -5263,71 +5508,29 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
5263
5508
|
page_size?: number;
|
|
5264
5509
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
5265
5510
|
}
|
|
5266
|
-
export class
|
|
5511
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5267
5512
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5268
5513
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5269
5514
|
/**
|
|
5270
|
-
* @description
|
|
5271
|
-
* @tags
|
|
5272
|
-
* @name
|
|
5273
|
-
* @summary
|
|
5274
|
-
* @request GET:/
|
|
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
|
|
5275
5520
|
* @secure
|
|
5276
5521
|
*/
|
|
5277
|
-
|
|
5278
|
-
/**
|
|
5279
|
-
* Company Id In
|
|
5280
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
5281
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5282
|
-
* @example "74822,83343211"
|
|
5283
|
-
*/
|
|
5284
|
-
company_id__in?: string;
|
|
5285
|
-
/**
|
|
5286
|
-
* Size
|
|
5287
|
-
* Page size
|
|
5288
|
-
* @min 1
|
|
5289
|
-
* @max 100
|
|
5290
|
-
* @default 50
|
|
5291
|
-
*/
|
|
5292
|
-
size?: number;
|
|
5522
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5293
5523
|
/**
|
|
5294
|
-
*
|
|
5295
|
-
*
|
|
5296
|
-
* @min 1
|
|
5297
|
-
* @default 1
|
|
5524
|
+
* Limit
|
|
5525
|
+
* Number of historical periods to be returned (default is 1).
|
|
5298
5526
|
*/
|
|
5299
|
-
|
|
5300
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
5301
|
-
/**
|
|
5302
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
5303
|
-
* @tags Logos
|
|
5304
|
-
* @name FetchLogo
|
|
5305
|
-
* @summary Fetch Logo
|
|
5306
|
-
* @request GET:/companies/{company_id}/logos
|
|
5307
|
-
* @secure
|
|
5308
|
-
*/
|
|
5309
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
5310
|
-
}
|
|
5311
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
5312
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5313
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5314
|
-
/**
|
|
5315
|
-
* @description This endpoint provides filters
|
|
5316
|
-
* @tags Metadata
|
|
5317
|
-
* @name GetCompanyFilters
|
|
5318
|
-
* @summary Get Company Filters
|
|
5319
|
-
* @request GET:/filters
|
|
5320
|
-
* @secure
|
|
5321
|
-
*/
|
|
5322
|
-
getCompanyFilters(query: {
|
|
5323
|
-
/** Desired filter type. */
|
|
5324
|
-
type: BridgeWiseCompanyFilterType;
|
|
5527
|
+
limit?: number;
|
|
5325
5528
|
/**
|
|
5326
5529
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5327
5530
|
* @default "en-US"
|
|
5328
5531
|
*/
|
|
5329
5532
|
language?: BridgeWiseLanguageEnum;
|
|
5330
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5533
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5331
5534
|
}
|
|
5332
5535
|
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5333
5536
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5363,233 +5566,56 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
|
5363
5566
|
limit?: number;
|
|
5364
5567
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
5365
5568
|
}
|
|
5366
|
-
export class
|
|
5569
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
5367
5570
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5368
5571
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5369
5572
|
/**
|
|
5370
|
-
* @
|
|
5371
|
-
* @
|
|
5372
|
-
* @
|
|
5373
|
-
* @
|
|
5374
|
-
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5573
|
+
* @tags Tenants
|
|
5574
|
+
* @name FetchTenant
|
|
5575
|
+
* @summary Fetch Tenant
|
|
5576
|
+
* @request GET:/tenants/{tenant_id}
|
|
5375
5577
|
* @secure
|
|
5376
5578
|
*/
|
|
5377
|
-
|
|
5579
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
5580
|
+
/**
|
|
5581
|
+
* @tags Tenants
|
|
5582
|
+
* @name GetHistoricalPolicyChanges
|
|
5583
|
+
* @summary Get Historical Policy Changes
|
|
5584
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
5585
|
+
* @secure
|
|
5586
|
+
*/
|
|
5587
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
5378
5588
|
/**
|
|
5379
|
-
*
|
|
5380
|
-
*
|
|
5589
|
+
* Company Ids
|
|
5590
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5591
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5592
|
+
* @example "74822,83343211"
|
|
5381
5593
|
*/
|
|
5382
|
-
|
|
5594
|
+
company_ids?: string;
|
|
5383
5595
|
/**
|
|
5384
|
-
*
|
|
5385
|
-
*
|
|
5596
|
+
* Start Date Gte
|
|
5597
|
+
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5598
|
+
* @format date
|
|
5386
5599
|
*/
|
|
5387
|
-
|
|
5600
|
+
start_date__gte?: string;
|
|
5388
5601
|
/**
|
|
5389
|
-
*
|
|
5390
|
-
*
|
|
5602
|
+
* End Date Lte
|
|
5603
|
+
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5604
|
+
* @format date
|
|
5391
5605
|
*/
|
|
5392
|
-
|
|
5393
|
-
/** Desired segment parameter type. */
|
|
5394
|
-
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5395
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5396
|
-
/**
|
|
5397
|
-
* @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.
|
|
5398
|
-
* @tags Segmentations
|
|
5399
|
-
* @name GetSegment
|
|
5400
|
-
* @summary Get Segment
|
|
5401
|
-
* @request GET:/funds/{fund_id}/segments
|
|
5402
|
-
* @secure
|
|
5403
|
-
*/
|
|
5404
|
-
getSegment(fundId: number, query?: {
|
|
5606
|
+
end_date__lte?: string;
|
|
5405
5607
|
/**
|
|
5406
|
-
*
|
|
5407
|
-
*
|
|
5608
|
+
* Current Value
|
|
5609
|
+
* Specify the current value reflecting the policy change
|
|
5408
5610
|
*/
|
|
5409
|
-
|
|
5611
|
+
current_value?: number | boolean;
|
|
5612
|
+
/** Type of event that is being requested. */
|
|
5613
|
+
event_type?: BridgeWiseEventTypeEnum;
|
|
5410
5614
|
/**
|
|
5411
|
-
*
|
|
5412
|
-
*
|
|
5413
|
-
|
|
5414
|
-
|
|
5415
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5416
|
-
}
|
|
5417
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
5418
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5419
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5420
|
-
/**
|
|
5421
|
-
* @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
|
|
5422
|
-
* @tags Technical Analysis
|
|
5423
|
-
* @name GetCompanyTechnicalAnalysis
|
|
5424
|
-
* @summary Get Company Technical Analysis
|
|
5425
|
-
* @request GET:/companies/{company_id}/technical-analysis
|
|
5426
|
-
* @secure
|
|
5427
|
-
*/
|
|
5428
|
-
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
5429
|
-
/**
|
|
5430
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5431
|
-
* @default "en-US"
|
|
5432
|
-
*/
|
|
5433
|
-
language?: BridgeWiseLanguageEnum;
|
|
5434
|
-
/**
|
|
5435
|
-
* Trading Item Id
|
|
5436
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5437
|
-
*/
|
|
5438
|
-
trading_item_id?: number;
|
|
5439
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
5440
|
-
/**
|
|
5441
|
-
* @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
|
|
5442
|
-
* @tags Technical Analysis
|
|
5443
|
-
* @name GetCompanyTechnicalParagraphs
|
|
5444
|
-
* @summary Get Company Technical Paragraphs
|
|
5445
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
5446
|
-
* @secure
|
|
5447
|
-
*/
|
|
5448
|
-
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
5449
|
-
/**
|
|
5450
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5451
|
-
* @default "en-US"
|
|
5452
|
-
*/
|
|
5453
|
-
language?: BridgeWiseLanguageEnum;
|
|
5454
|
-
/**
|
|
5455
|
-
* Trading Item Id
|
|
5456
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5457
|
-
*/
|
|
5458
|
-
trading_item_id?: number;
|
|
5459
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
5460
|
-
/**
|
|
5461
|
-
* @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
5462
|
-
* @tags Technical Analysis
|
|
5463
|
-
* @name GetCompanyTechnicalParameters
|
|
5464
|
-
* @summary Get Company Technical Parameters
|
|
5465
|
-
* @request GET:/companies/{company_id}/technical-parameters
|
|
5466
|
-
* @secure
|
|
5467
|
-
*/
|
|
5468
|
-
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
5469
|
-
/**
|
|
5470
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5471
|
-
* @default "en-US"
|
|
5472
|
-
*/
|
|
5473
|
-
language?: BridgeWiseLanguageEnum;
|
|
5474
|
-
/**
|
|
5475
|
-
* Trading Item Id
|
|
5476
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5477
|
-
*/
|
|
5478
|
-
trading_item_id?: number;
|
|
5479
|
-
/**
|
|
5480
|
-
* Parameter Id
|
|
5481
|
-
* Get desired parameter by ID.
|
|
5482
|
-
*/
|
|
5483
|
-
parameter_id?: number;
|
|
5484
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
5485
|
-
}
|
|
5486
|
-
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5487
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5488
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5489
|
-
/**
|
|
5490
|
-
* @description Get list of tenant identifiers
|
|
5491
|
-
* @tags Tenant Identifiers
|
|
5492
|
-
* @name GetTenantIdentifiers
|
|
5493
|
-
* @summary Get Tenant Identifiers
|
|
5494
|
-
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5495
|
-
* @secure
|
|
5496
|
-
*/
|
|
5497
|
-
getTenantIdentifiers(tenantId: string, query?: {
|
|
5498
|
-
/** Tenant custom identifier status. */
|
|
5499
|
-
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5500
|
-
/**
|
|
5501
|
-
* Page
|
|
5502
|
-
* Define the page number for the results.
|
|
5503
|
-
* @default 1
|
|
5504
|
-
* @example 1
|
|
5505
|
-
*/
|
|
5506
|
-
page?: number;
|
|
5507
|
-
/**
|
|
5508
|
-
* Page Size
|
|
5509
|
-
* Define the maximum number of results to retrieve.
|
|
5510
|
-
* @default 20
|
|
5511
|
-
* @example 10
|
|
5512
|
-
*/
|
|
5513
|
-
page_size?: number;
|
|
5514
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5515
|
-
/**
|
|
5516
|
-
* @description Create a new identifier for a tenant
|
|
5517
|
-
* @tags Tenant Identifiers
|
|
5518
|
-
* @name CreateTenantIdentifier
|
|
5519
|
-
* @summary Create Tenant Identifier
|
|
5520
|
-
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5521
|
-
* @secure
|
|
5522
|
-
*/
|
|
5523
|
-
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5524
|
-
/**
|
|
5525
|
-
* @description Update an existing identifier for a tenant
|
|
5526
|
-
* @tags Tenant Identifiers
|
|
5527
|
-
* @name UpdateTenantIdentifier
|
|
5528
|
-
* @summary Update Tenant Identifier
|
|
5529
|
-
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5530
|
-
* @secure
|
|
5531
|
-
*/
|
|
5532
|
-
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5533
|
-
/**
|
|
5534
|
-
* @description Delete identifier for a tenant
|
|
5535
|
-
* @tags Tenant Identifiers
|
|
5536
|
-
* @name DeleteTenantIdentifier
|
|
5537
|
-
* @summary Delete Tenant Identifier
|
|
5538
|
-
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5539
|
-
* @secure
|
|
5540
|
-
*/
|
|
5541
|
-
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5542
|
-
}
|
|
5543
|
-
export class Tenants<HandleError extends boolean = boolean> {
|
|
5544
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5545
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5546
|
-
/**
|
|
5547
|
-
* @tags Tenants
|
|
5548
|
-
* @name FetchTenant
|
|
5549
|
-
* @summary Fetch Tenant
|
|
5550
|
-
* @request GET:/tenants/{tenant_id}
|
|
5551
|
-
* @secure
|
|
5552
|
-
*/
|
|
5553
|
-
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
5554
|
-
/**
|
|
5555
|
-
* @tags Tenants
|
|
5556
|
-
* @name GetHistoricalPolicyChanges
|
|
5557
|
-
* @summary Get Historical Policy Changes
|
|
5558
|
-
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
5559
|
-
* @secure
|
|
5560
|
-
*/
|
|
5561
|
-
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
5562
|
-
/**
|
|
5563
|
-
* Company Ids
|
|
5564
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
5565
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5566
|
-
* @example "74822,83343211"
|
|
5567
|
-
*/
|
|
5568
|
-
company_ids?: string;
|
|
5569
|
-
/**
|
|
5570
|
-
* Start Date Gte
|
|
5571
|
-
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5572
|
-
* @format date
|
|
5573
|
-
*/
|
|
5574
|
-
start_date__gte?: string;
|
|
5575
|
-
/**
|
|
5576
|
-
* End Date Lte
|
|
5577
|
-
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5578
|
-
* @format date
|
|
5579
|
-
*/
|
|
5580
|
-
end_date__lte?: string;
|
|
5581
|
-
/**
|
|
5582
|
-
* Current Value
|
|
5583
|
-
* Specify the current value reflecting the policy change
|
|
5584
|
-
*/
|
|
5585
|
-
current_value?: number | boolean;
|
|
5586
|
-
/** Type of event that is being requested. */
|
|
5587
|
-
event_type?: BridgeWiseEventTypeEnum;
|
|
5588
|
-
/**
|
|
5589
|
-
* Size
|
|
5590
|
-
* Define the maximum number of results to retrieve.
|
|
5591
|
-
* @default 10
|
|
5592
|
-
* @example 10
|
|
5615
|
+
* Size
|
|
5616
|
+
* Define the maximum number of results to retrieve.
|
|
5617
|
+
* @default 10
|
|
5618
|
+
* @example 10
|
|
5593
5619
|
*/
|
|
5594
5620
|
size?: number;
|
|
5595
5621
|
/**
|
|
@@ -5713,146 +5739,272 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
5713
5739
|
*/
|
|
5714
5740
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5715
5741
|
}
|
|
5716
|
-
export class
|
|
5742
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5717
5743
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5718
5744
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5719
5745
|
/**
|
|
5720
|
-
* @description
|
|
5721
|
-
* @tags
|
|
5722
|
-
* @name
|
|
5723
|
-
* @summary Get
|
|
5724
|
-
* @request GET:/
|
|
5746
|
+
* @description Get list of tenant identifiers
|
|
5747
|
+
* @tags Tenant Identifiers
|
|
5748
|
+
* @name GetTenantIdentifiers
|
|
5749
|
+
* @summary Get Tenant Identifiers
|
|
5750
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5725
5751
|
* @secure
|
|
5726
5752
|
*/
|
|
5727
|
-
|
|
5728
|
-
/**
|
|
5729
|
-
|
|
5730
|
-
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5731
|
-
* @default "group,rank"
|
|
5732
|
-
*/
|
|
5733
|
-
sort_by?: string | null;
|
|
5734
|
-
/**
|
|
5735
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5736
|
-
* @default "en-US"
|
|
5737
|
-
*/
|
|
5738
|
-
language?: BridgeWiseThemeLanguageEnum;
|
|
5739
|
-
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
5740
|
-
group?: BridgeWiseThemeGroupEnum;
|
|
5741
|
-
/** Filter basic and advanced theme packages. */
|
|
5742
|
-
package?: BridgeWiseThemePackageEnum;
|
|
5743
|
-
/** The type of the theme. */
|
|
5744
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
5753
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
5754
|
+
/** Tenant custom identifier status. */
|
|
5755
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5745
5756
|
/**
|
|
5746
5757
|
* Page
|
|
5747
|
-
* Define the page number for
|
|
5748
|
-
* @min 1
|
|
5758
|
+
* Define the page number for the results.
|
|
5749
5759
|
* @default 1
|
|
5760
|
+
* @example 1
|
|
5750
5761
|
*/
|
|
5751
5762
|
page?: number;
|
|
5752
5763
|
/**
|
|
5753
5764
|
* Page Size
|
|
5754
|
-
* Define the number of
|
|
5755
|
-
* @
|
|
5756
|
-
* @
|
|
5765
|
+
* Define the maximum number of results to retrieve.
|
|
5766
|
+
* @default 20
|
|
5767
|
+
* @example 10
|
|
5757
5768
|
*/
|
|
5758
5769
|
page_size?: number;
|
|
5759
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5770
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5760
5771
|
/**
|
|
5761
|
-
* @description
|
|
5762
|
-
* @tags
|
|
5763
|
-
* @name
|
|
5764
|
-
* @summary
|
|
5765
|
-
* @request
|
|
5772
|
+
* @description Create a new identifier for a tenant
|
|
5773
|
+
* @tags Tenant Identifiers
|
|
5774
|
+
* @name CreateTenantIdentifier
|
|
5775
|
+
* @summary Create Tenant Identifier
|
|
5776
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5766
5777
|
* @secure
|
|
5767
5778
|
*/
|
|
5768
|
-
|
|
5779
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5780
|
+
/**
|
|
5781
|
+
* @description Update an existing identifier for a tenant
|
|
5782
|
+
* @tags Tenant Identifiers
|
|
5783
|
+
* @name UpdateTenantIdentifier
|
|
5784
|
+
* @summary Update Tenant Identifier
|
|
5785
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5786
|
+
* @secure
|
|
5787
|
+
*/
|
|
5788
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5789
|
+
/**
|
|
5790
|
+
* @description Delete identifier for a tenant
|
|
5791
|
+
* @tags Tenant Identifiers
|
|
5792
|
+
* @name DeleteTenantIdentifier
|
|
5793
|
+
* @summary Delete Tenant Identifier
|
|
5794
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5795
|
+
* @secure
|
|
5796
|
+
*/
|
|
5797
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5798
|
+
}
|
|
5799
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5800
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5801
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5802
|
+
/**
|
|
5803
|
+
* @tags Users
|
|
5804
|
+
* @name Authenticate
|
|
5805
|
+
* @summary Authenticate
|
|
5806
|
+
* @request POST:/users/authenticate
|
|
5807
|
+
* @secure
|
|
5808
|
+
*/
|
|
5809
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5810
|
+
/**
|
|
5811
|
+
* @tags Users
|
|
5812
|
+
* @name FetchClientDetails
|
|
5813
|
+
* @summary Fetch Client Details
|
|
5814
|
+
* @request GET:/users/machine
|
|
5815
|
+
* @secure
|
|
5816
|
+
*/
|
|
5817
|
+
fetchClientDetails(headers: {
|
|
5818
|
+
/** Authorization */
|
|
5819
|
+
authorization: string;
|
|
5820
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5821
|
+
}
|
|
5822
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
5823
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5824
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5825
|
+
/**
|
|
5826
|
+
* @tags Bridget
|
|
5827
|
+
* @name QuestionsCreate
|
|
5828
|
+
* @request POST:/questions
|
|
5829
|
+
* @secure
|
|
5830
|
+
*/
|
|
5831
|
+
questionsCreate(data: BridgeWiseQuestionsRequest, headers: {
|
|
5832
|
+
/** User ID */
|
|
5833
|
+
Userid: string;
|
|
5834
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
5835
|
+
/**
|
|
5836
|
+
* @tags Bridget
|
|
5837
|
+
* @name TenantsQuestionsRetrieve
|
|
5838
|
+
* @request GET:/tenants/{tenant_id}/questions
|
|
5839
|
+
* @secure
|
|
5840
|
+
*/
|
|
5841
|
+
tenantsQuestionsRetrieve(tenantId: string, query?: {
|
|
5842
|
+
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
5843
|
+
client_id?: string;
|
|
5769
5844
|
/**
|
|
5770
|
-
*
|
|
5771
|
-
*
|
|
5845
|
+
* Returns logs only for the specified calendar day (00:00–23:59 tenant time zone).
|
|
5846
|
+
*
|
|
5847
|
+
* Use either this field or the `start_date` + `end_date` pair.
|
|
5848
|
+
*
|
|
5849
|
+
* **Never** both in the same request.
|
|
5850
|
+
*
|
|
5851
|
+
* **Format:** YYYY-MM-DD
|
|
5852
|
+
* @format date
|
|
5772
5853
|
*/
|
|
5773
|
-
|
|
5854
|
+
date?: string;
|
|
5774
5855
|
/**
|
|
5775
|
-
*
|
|
5776
|
-
*
|
|
5777
|
-
*
|
|
5856
|
+
* Inclusive end of a date range.
|
|
5857
|
+
*
|
|
5858
|
+
* Must be greater than or equal to `start_date`.
|
|
5859
|
+
*
|
|
5860
|
+
* Use either the `date` field, OR use the `start_date` + `end_date` pair.
|
|
5861
|
+
*
|
|
5862
|
+
* **Never** use both in the same request.
|
|
5863
|
+
*
|
|
5864
|
+
* **Format:** YYYY-MM-DD
|
|
5865
|
+
* @format date
|
|
5778
5866
|
*/
|
|
5779
|
-
|
|
5867
|
+
end_date?: string;
|
|
5868
|
+
/** Filters by user feedback on each answer. **Allowed values**: `like` | `dislike` */
|
|
5869
|
+
feedback_type?: string;
|
|
5870
|
+
/** Filters to a single chat session ID. */
|
|
5871
|
+
session_id?: string;
|
|
5872
|
+
/**
|
|
5873
|
+
* Inclusive start of a date range.
|
|
5874
|
+
*
|
|
5875
|
+
* Use either the `date` field or this `start_date` + `end_date`pair.
|
|
5876
|
+
*
|
|
5877
|
+
* **Never** both in the same request.
|
|
5878
|
+
*
|
|
5879
|
+
* Required when end_date is provided.
|
|
5880
|
+
*
|
|
5881
|
+
* **Format:** YYYY-MM-DD
|
|
5882
|
+
* @format date
|
|
5883
|
+
*/
|
|
5884
|
+
start_date?: string;
|
|
5885
|
+
/** Filters logs to a single end-user within the tenant. */
|
|
5886
|
+
user_id?: string;
|
|
5887
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
5888
|
+
}
|
|
5889
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5890
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5891
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5892
|
+
/**
|
|
5893
|
+
* @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.
|
|
5894
|
+
* @tags Segmentations
|
|
5895
|
+
* @name GetSegmentParameters
|
|
5896
|
+
* @summary Get Segment Parameters
|
|
5897
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5898
|
+
* @secure
|
|
5899
|
+
*/
|
|
5900
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5780
5901
|
/**
|
|
5781
5902
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5782
5903
|
* @default "en-US"
|
|
5783
5904
|
*/
|
|
5784
|
-
language?:
|
|
5785
|
-
/** Filter basic and advanced theme packages. */
|
|
5786
|
-
package?: BridgeWiseThemePackageEnum;
|
|
5787
|
-
/** The type of the theme. */
|
|
5788
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
5905
|
+
language?: BridgeWiseLanguageEnum;
|
|
5789
5906
|
/**
|
|
5790
|
-
*
|
|
5791
|
-
*
|
|
5792
|
-
* @min 1
|
|
5793
|
-
* @default 1
|
|
5907
|
+
* Segment
|
|
5908
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5794
5909
|
*/
|
|
5795
|
-
|
|
5910
|
+
segment?: string;
|
|
5796
5911
|
/**
|
|
5797
|
-
*
|
|
5798
|
-
*
|
|
5799
|
-
* @min 1
|
|
5800
|
-
* @default 10
|
|
5912
|
+
* Segment Type
|
|
5913
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5801
5914
|
*/
|
|
5802
|
-
|
|
5803
|
-
|
|
5915
|
+
segment_type?: string;
|
|
5916
|
+
/** Desired segment parameter type. */
|
|
5917
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5918
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5804
5919
|
/**
|
|
5805
|
-
* @description
|
|
5806
|
-
* @tags
|
|
5807
|
-
* @name
|
|
5808
|
-
* @summary Get
|
|
5809
|
-
* @request GET:/
|
|
5920
|
+
* @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.
|
|
5921
|
+
* @tags Segmentations
|
|
5922
|
+
* @name GetSegment
|
|
5923
|
+
* @summary Get Segment
|
|
5924
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5810
5925
|
* @secure
|
|
5811
5926
|
*/
|
|
5812
|
-
|
|
5927
|
+
getSegment(fundId: number, query?: {
|
|
5813
5928
|
/**
|
|
5814
5929
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5815
5930
|
* @default "en-US"
|
|
5816
5931
|
*/
|
|
5817
|
-
language?:
|
|
5932
|
+
language?: BridgeWiseLanguageEnum;
|
|
5818
5933
|
/**
|
|
5819
|
-
*
|
|
5820
|
-
*
|
|
5821
|
-
* @default false
|
|
5934
|
+
* Segment
|
|
5935
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5822
5936
|
*/
|
|
5823
|
-
|
|
5824
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5825
|
-
/**
|
|
5826
|
-
* @tags Themes
|
|
5827
|
-
* @name GetThemeFilters
|
|
5828
|
-
* @summary Get Theme Filters
|
|
5829
|
-
* @request GET:/themes/{theme_id}/filters
|
|
5830
|
-
* @secure
|
|
5831
|
-
*/
|
|
5832
|
-
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
5937
|
+
segment?: string;
|
|
5938
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5833
5939
|
}
|
|
5834
|
-
export class
|
|
5940
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5835
5941
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5836
5942
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5837
5943
|
/**
|
|
5838
|
-
* @
|
|
5839
|
-
* @
|
|
5840
|
-
* @
|
|
5841
|
-
* @
|
|
5944
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5945
|
+
* @tags Fund Market Data
|
|
5946
|
+
* @name GetFundsMarketData
|
|
5947
|
+
* @summary Get Funds Market Data
|
|
5948
|
+
* @request GET:/funds/{fund_id}/market
|
|
5842
5949
|
* @secure
|
|
5843
5950
|
*/
|
|
5844
|
-
|
|
5951
|
+
getFundsMarketData(fundId: number, query?: {
|
|
5952
|
+
/**
|
|
5953
|
+
* Trading Item Id
|
|
5954
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5955
|
+
*/
|
|
5956
|
+
trading_item_id?: number | null;
|
|
5957
|
+
/**
|
|
5958
|
+
* Date Ge
|
|
5959
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5960
|
+
*/
|
|
5961
|
+
date__ge?: string | null;
|
|
5962
|
+
/**
|
|
5963
|
+
* Date Le
|
|
5964
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5965
|
+
*/
|
|
5966
|
+
date__le?: string | null;
|
|
5967
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5845
5968
|
/**
|
|
5846
|
-
* @
|
|
5847
|
-
* @
|
|
5848
|
-
* @
|
|
5849
|
-
* @
|
|
5969
|
+
* @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
5970
|
+
* @tags Fund Market Data
|
|
5971
|
+
* @name GetFundsMarketStatistics
|
|
5972
|
+
* @summary Get Funds Market Statistics
|
|
5973
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
5850
5974
|
* @secure
|
|
5851
5975
|
*/
|
|
5852
|
-
|
|
5853
|
-
/**
|
|
5854
|
-
|
|
5855
|
-
|
|
5976
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
5977
|
+
/**
|
|
5978
|
+
* Trading Item Id
|
|
5979
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5980
|
+
*/
|
|
5981
|
+
trading_item_id?: number | null;
|
|
5982
|
+
/**
|
|
5983
|
+
* Identifier In
|
|
5984
|
+
* Specify a list of external identifiers.
|
|
5985
|
+
*/
|
|
5986
|
+
identifier__in?: string | null;
|
|
5987
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5988
|
+
/**
|
|
5989
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5990
|
+
* @tags Fund Market Data
|
|
5991
|
+
* @name GetFundTradingItems
|
|
5992
|
+
* @summary Get Fund Trading Items
|
|
5993
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
5994
|
+
* @secure
|
|
5995
|
+
*/
|
|
5996
|
+
getFundTradingItems(fundId: number, query?: {
|
|
5997
|
+
/**
|
|
5998
|
+
* Primary Flag
|
|
5999
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
6000
|
+
*/
|
|
6001
|
+
primary_flag?: boolean;
|
|
6002
|
+
/**
|
|
6003
|
+
* Security Primary Flag
|
|
6004
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
6005
|
+
*/
|
|
6006
|
+
security_primary_flag?: boolean;
|
|
6007
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5856
6008
|
}
|
|
5857
6009
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5858
6010
|
readonly config: JwtClientConfig<HandleError>;
|