@orbis-systems/orbis-api-clients 0.7.12 → 0.7.13
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 +28 -28
- 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 +652 -652
- 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 +1112 -1112
- 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 +73 -73
- 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 +3871 -3871
- 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 +686 -686
- 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 +273 -273
- 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
|
@@ -3031,6 +3031,56 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
3031
3031
|
Iso = "iso",
|
|
3032
3032
|
Epoch = "epoch"
|
|
3033
3033
|
}
|
|
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
|
+
}
|
|
3034
3084
|
export class Bridget<HandleError extends boolean = boolean> {
|
|
3035
3085
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
3086
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3400,6 +3450,75 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
3400
3450
|
identifier: string;
|
|
3401
3451
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3402
3452
|
}
|
|
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
|
+
}
|
|
3403
3522
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3404
3523
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3405
3524
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4039,100 +4158,83 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4039
4158
|
identifier_type: string;
|
|
4040
4159
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4041
4160
|
}
|
|
4042
|
-
export class
|
|
4161
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4043
4162
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4044
4163
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4045
4164
|
/**
|
|
4046
|
-
* @description
|
|
4047
|
-
* @tags
|
|
4048
|
-
* @name
|
|
4049
|
-
* @summary
|
|
4050
|
-
* @request GET:/companies/
|
|
4165
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
4166
|
+
* @tags Company News
|
|
4167
|
+
* @name GetCompanyNews
|
|
4168
|
+
* @summary Get Company News
|
|
4169
|
+
* @request GET:/companies/{company_id}/news
|
|
4051
4170
|
* @secure
|
|
4052
4171
|
*/
|
|
4053
|
-
|
|
4172
|
+
getCompanyNews(companyId: number, query?: {
|
|
4054
4173
|
/**
|
|
4055
|
-
*
|
|
4056
|
-
*
|
|
4057
|
-
* @
|
|
4058
|
-
* @
|
|
4174
|
+
* Languages
|
|
4175
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4176
|
+
* @default "en-US"
|
|
4177
|
+
* @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))*$
|
|
4059
4178
|
*/
|
|
4060
|
-
|
|
4179
|
+
languages?: string;
|
|
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;
|
|
4061
4199
|
/**
|
|
4062
4200
|
* Size
|
|
4063
|
-
*
|
|
4064
|
-
* @
|
|
4065
|
-
* @
|
|
4066
|
-
* @default 50
|
|
4201
|
+
* Define the number of records per page for pagination purposes.
|
|
4202
|
+
* @default 10
|
|
4203
|
+
* @example 10
|
|
4067
4204
|
*/
|
|
4068
4205
|
size?: number;
|
|
4069
4206
|
/**
|
|
4070
4207
|
* Page
|
|
4071
|
-
*
|
|
4072
|
-
* @min 1
|
|
4208
|
+
* Define the page number for pagination.
|
|
4073
4209
|
* @default 1
|
|
4210
|
+
* @example 1
|
|
4074
4211
|
*/
|
|
4075
4212
|
page?: number;
|
|
4076
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4077
|
-
/**
|
|
4078
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4079
|
-
* @tags Logos
|
|
4080
|
-
* @name FetchLogo
|
|
4081
|
-
* @summary Fetch Logo
|
|
4082
|
-
* @request GET:/companies/{company_id}/logos
|
|
4083
|
-
* @secure
|
|
4084
|
-
*/
|
|
4085
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4086
|
-
}
|
|
4087
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
4088
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4089
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4090
|
-
/**
|
|
4091
|
-
* @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.
|
|
4092
|
-
* @tags Activities
|
|
4093
|
-
* @name GetCompanyAlerts
|
|
4094
|
-
* @summary Get Company Alerts
|
|
4095
|
-
* @request GET:/companies/{company_id}/alerts
|
|
4096
|
-
* @secure
|
|
4097
|
-
*/
|
|
4098
|
-
getCompanyAlerts(companyId: number, query?: {
|
|
4099
|
-
/**
|
|
4100
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4101
|
-
* @default "en-US"
|
|
4102
|
-
*/
|
|
4103
|
-
language?: BridgeWiseLanguageEnum;
|
|
4104
|
-
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
4105
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
4106
|
-
/** Filter alerts by their sentiment. */
|
|
4107
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
4108
|
-
/**
|
|
4109
|
-
* Importance
|
|
4110
|
-
* 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
|
|
4111
|
-
*/
|
|
4112
|
-
importance?: string | null;
|
|
4113
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
4213
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4114
4214
|
/**
|
|
4115
|
-
* @description
|
|
4116
|
-
* @tags
|
|
4117
|
-
* @name
|
|
4118
|
-
* @summary Get Company
|
|
4119
|
-
* @request GET:/companies/{company_id}/
|
|
4215
|
+
* @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.
|
|
4216
|
+
* @tags Company News
|
|
4217
|
+
* @name GetAverageCompanyNewsSentiment
|
|
4218
|
+
* @summary Get Average Company News Sentiment
|
|
4219
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
4120
4220
|
* @secure
|
|
4121
4221
|
*/
|
|
4122
|
-
|
|
4222
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4123
4223
|
/**
|
|
4124
|
-
*
|
|
4125
|
-
*
|
|
4224
|
+
* Published Date Gte
|
|
4225
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4226
|
+
* @format date
|
|
4227
|
+
* @default "2025-07-22"
|
|
4126
4228
|
*/
|
|
4127
|
-
|
|
4229
|
+
published_date__gte?: string;
|
|
4128
4230
|
/**
|
|
4129
|
-
*
|
|
4130
|
-
*
|
|
4131
|
-
* @
|
|
4132
|
-
* @
|
|
4231
|
+
* Published Date Lte
|
|
4232
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4233
|
+
* @format date
|
|
4234
|
+
* @default "2025-07-22"
|
|
4133
4235
|
*/
|
|
4134
|
-
|
|
4135
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4236
|
+
published_date__lte?: string;
|
|
4237
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4136
4238
|
}
|
|
4137
4239
|
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
4138
4240
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4347,84 +4449,15 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
4347
4449
|
page_size?: number;
|
|
4348
4450
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
4349
4451
|
}
|
|
4350
|
-
export class
|
|
4452
|
+
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4351
4453
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4352
4454
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4353
4455
|
/**
|
|
4354
|
-
* @description
|
|
4355
|
-
* @tags
|
|
4356
|
-
* @name
|
|
4357
|
-
* @summary Get Company
|
|
4358
|
-
* @request GET:/companies/{company_id}/
|
|
4359
|
-
* @secure
|
|
4360
|
-
*/
|
|
4361
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
4362
|
-
/**
|
|
4363
|
-
* Trading Item Id
|
|
4364
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4365
|
-
*/
|
|
4366
|
-
trading_item_id?: number | null;
|
|
4367
|
-
/**
|
|
4368
|
-
* Date Ge
|
|
4369
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4370
|
-
*/
|
|
4371
|
-
date__ge?: string | null;
|
|
4372
|
-
/**
|
|
4373
|
-
* Date Le
|
|
4374
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4375
|
-
*/
|
|
4376
|
-
date__le?: string | null;
|
|
4377
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4378
|
-
/**
|
|
4379
|
-
* @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.
|
|
4380
|
-
* @tags Company Market Data
|
|
4381
|
-
* @name GetCompanyMarketStatistics
|
|
4382
|
-
* @summary Get Company Market Statistics
|
|
4383
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
4384
|
-
* @secure
|
|
4385
|
-
*/
|
|
4386
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4387
|
-
/**
|
|
4388
|
-
* Trading Item Id
|
|
4389
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4390
|
-
*/
|
|
4391
|
-
trading_item_id?: number | null;
|
|
4392
|
-
/**
|
|
4393
|
-
* Identifier In
|
|
4394
|
-
* Specify a list of external identifiers.
|
|
4395
|
-
*/
|
|
4396
|
-
identifier__in?: string | null;
|
|
4397
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4398
|
-
/**
|
|
4399
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4400
|
-
* @tags Company Market Data
|
|
4401
|
-
* @name GetTradingItems
|
|
4402
|
-
* @summary Get Trading Items
|
|
4403
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
4404
|
-
* @secure
|
|
4405
|
-
*/
|
|
4406
|
-
getTradingItems(companyId: number, query?: {
|
|
4407
|
-
/**
|
|
4408
|
-
* Primary Flag
|
|
4409
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4410
|
-
*/
|
|
4411
|
-
primary_flag?: boolean;
|
|
4412
|
-
/**
|
|
4413
|
-
* Security Primary Flag
|
|
4414
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4415
|
-
*/
|
|
4416
|
-
security_primary_flag?: boolean;
|
|
4417
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4418
|
-
}
|
|
4419
|
-
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4420
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4421
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4422
|
-
/**
|
|
4423
|
-
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
4424
|
-
* @tags Fundamental Analysis
|
|
4425
|
-
* @name GetCompanyFundamentalAnalysis
|
|
4426
|
-
* @summary Get Company Fundamental Analysis
|
|
4427
|
-
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
4456
|
+
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
4457
|
+
* @tags Fundamental Analysis
|
|
4458
|
+
* @name GetCompanyFundamentalAnalysis
|
|
4459
|
+
* @summary Get Company Fundamental Analysis
|
|
4460
|
+
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
4428
4461
|
* @secure
|
|
4429
4462
|
*/
|
|
4430
4463
|
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
@@ -4557,291 +4590,207 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4557
4590
|
date__lte?: string;
|
|
4558
4591
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4559
4592
|
}
|
|
4560
|
-
export class
|
|
4593
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
4561
4594
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4562
4595
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4563
4596
|
/**
|
|
4564
|
-
* @description
|
|
4565
|
-
* @tags
|
|
4566
|
-
* @name
|
|
4567
|
-
* @summary Get
|
|
4568
|
-
* @request GET:/
|
|
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
|
|
4569
4602
|
* @secure
|
|
4570
4603
|
*/
|
|
4571
|
-
|
|
4604
|
+
getFundAnalysis(fundId: number, query?: {
|
|
4572
4605
|
/**
|
|
4573
|
-
* Languages
|
|
4574
4606
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4575
4607
|
* @default "en-US"
|
|
4576
|
-
* @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))*$
|
|
4577
|
-
*/
|
|
4578
|
-
languages?: string;
|
|
4579
|
-
/**
|
|
4580
|
-
* Published Date Gte
|
|
4581
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4582
|
-
* @format date
|
|
4583
|
-
* @default "2025-07-22"
|
|
4584
|
-
*/
|
|
4585
|
-
published_date__gte?: string;
|
|
4586
|
-
/**
|
|
4587
|
-
* Published Date Lte
|
|
4588
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4589
|
-
* @format date
|
|
4590
|
-
* @default "2025-07-22"
|
|
4591
4608
|
*/
|
|
4592
|
-
|
|
4609
|
+
language?: BridgeWiseLanguageEnum;
|
|
4593
4610
|
/**
|
|
4594
|
-
*
|
|
4595
|
-
*
|
|
4611
|
+
* Year
|
|
4612
|
+
* Specify the year for which the analysis is requested.
|
|
4596
4613
|
*/
|
|
4597
|
-
|
|
4614
|
+
year?: number;
|
|
4598
4615
|
/**
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* @default 10
|
|
4602
|
-
* @example 10
|
|
4616
|
+
* Quarter
|
|
4617
|
+
* Specify the quarter for which the analysis is requested.
|
|
4603
4618
|
*/
|
|
4604
|
-
|
|
4619
|
+
quarter?: number;
|
|
4605
4620
|
/**
|
|
4606
|
-
*
|
|
4607
|
-
*
|
|
4608
|
-
* @default 1
|
|
4609
|
-
* @example 1
|
|
4621
|
+
* Show All
|
|
4622
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4610
4623
|
*/
|
|
4611
|
-
|
|
4612
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4624
|
+
show_all?: boolean;
|
|
4625
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
4613
4626
|
/**
|
|
4614
|
-
* @description
|
|
4615
|
-
* @tags
|
|
4616
|
-
* @name
|
|
4617
|
-
* @summary Get
|
|
4618
|
-
* @request GET:/
|
|
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
|
|
4619
4632
|
* @secure
|
|
4620
4633
|
*/
|
|
4621
|
-
|
|
4634
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
4622
4635
|
/**
|
|
4623
|
-
*
|
|
4624
|
-
*
|
|
4625
|
-
* @format date
|
|
4626
|
-
* @default "2025-07-22"
|
|
4636
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4637
|
+
* @default "en-US"
|
|
4627
4638
|
*/
|
|
4628
|
-
|
|
4639
|
+
language?: BridgeWiseLanguageEnum;
|
|
4629
4640
|
/**
|
|
4630
|
-
*
|
|
4631
|
-
*
|
|
4632
|
-
* @format date
|
|
4633
|
-
* @default "2025-07-22"
|
|
4641
|
+
* Year
|
|
4642
|
+
* Specify the year for which the analysis is requested.
|
|
4634
4643
|
*/
|
|
4635
|
-
|
|
4636
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4637
|
-
}
|
|
4638
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
4639
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4640
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4641
|
-
/**
|
|
4642
|
-
* @description This endpoint provides filters
|
|
4643
|
-
* @tags Metadata
|
|
4644
|
-
* @name GetCompanyFilters
|
|
4645
|
-
* @summary Get Company Filters
|
|
4646
|
-
* @request GET:/filters
|
|
4647
|
-
* @secure
|
|
4648
|
-
*/
|
|
4649
|
-
getCompanyFilters(query: {
|
|
4650
|
-
/** Desired filter type. */
|
|
4651
|
-
type: BridgeWiseCompanyFilterType;
|
|
4644
|
+
year?: number | null;
|
|
4652
4645
|
/**
|
|
4653
|
-
*
|
|
4654
|
-
*
|
|
4646
|
+
* Quarter
|
|
4647
|
+
* Specify the quarter for which the analysis is requested.
|
|
4655
4648
|
*/
|
|
4656
|
-
|
|
4657
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4658
|
-
}
|
|
4659
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4660
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4661
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4649
|
+
quarter?: number | null;
|
|
4650
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
4662
4651
|
/**
|
|
4663
|
-
* @description
|
|
4664
|
-
* @tags
|
|
4665
|
-
* @name
|
|
4666
|
-
* @summary Get
|
|
4667
|
-
* @request GET:/
|
|
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
|
|
4668
4657
|
* @secure
|
|
4669
4658
|
*/
|
|
4670
|
-
|
|
4659
|
+
getFundParameters(fundId: number, query?: {
|
|
4671
4660
|
/**
|
|
4672
4661
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4673
4662
|
* @default "en-US"
|
|
4674
4663
|
*/
|
|
4675
4664
|
language?: BridgeWiseLanguageEnum;
|
|
4676
4665
|
/**
|
|
4677
|
-
*
|
|
4678
|
-
*
|
|
4666
|
+
* Parameter Id
|
|
4667
|
+
* ID of the parameter for analysis.
|
|
4679
4668
|
*/
|
|
4680
|
-
|
|
4681
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4669
|
+
parameter_id?: number;
|
|
4670
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
4682
4671
|
/**
|
|
4683
|
-
* @description
|
|
4684
|
-
* @tags
|
|
4685
|
-
* @name
|
|
4686
|
-
* @summary Get
|
|
4687
|
-
* @request GET:/
|
|
4672
|
+
* @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.
|
|
4673
|
+
* @tags Fund Analysis
|
|
4674
|
+
* @name GetFundSections
|
|
4675
|
+
* @summary Get Fund Sections
|
|
4676
|
+
* @request GET:/funds/{fund_id}/sections
|
|
4688
4677
|
* @secure
|
|
4689
4678
|
*/
|
|
4690
|
-
|
|
4679
|
+
getFundSections(fundId: number, query?: {
|
|
4691
4680
|
/**
|
|
4692
|
-
*
|
|
4693
|
-
*
|
|
4681
|
+
* Year
|
|
4682
|
+
* Specify the year for which the analysis is requested.
|
|
4694
4683
|
*/
|
|
4695
|
-
|
|
4684
|
+
year?: number;
|
|
4696
4685
|
/**
|
|
4697
|
-
*
|
|
4698
|
-
* Specify
|
|
4686
|
+
* Quarter
|
|
4687
|
+
* Specify the quarter for which the analysis is requested.
|
|
4699
4688
|
*/
|
|
4700
|
-
|
|
4701
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
4702
|
-
/**
|
|
4703
|
-
* @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.
|
|
4704
|
-
* @tags Technical Analysis
|
|
4705
|
-
* @name GetCompanyTechnicalParameters
|
|
4706
|
-
* @summary Get Company Technical Parameters
|
|
4707
|
-
* @request GET:/companies/{company_id}/technical-parameters
|
|
4708
|
-
* @secure
|
|
4709
|
-
*/
|
|
4710
|
-
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
4689
|
+
quarter?: number;
|
|
4711
4690
|
/**
|
|
4712
4691
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4713
4692
|
* @default "en-US"
|
|
4714
4693
|
*/
|
|
4715
4694
|
language?: BridgeWiseLanguageEnum;
|
|
4716
4695
|
/**
|
|
4717
|
-
*
|
|
4718
|
-
*
|
|
4719
|
-
*/
|
|
4720
|
-
trading_item_id?: number;
|
|
4721
|
-
/**
|
|
4722
|
-
* Parameter Id
|
|
4723
|
-
* Get desired parameter by ID.
|
|
4696
|
+
* Show All
|
|
4697
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4724
4698
|
*/
|
|
4725
|
-
|
|
4726
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4699
|
+
show_all?: boolean;
|
|
4700
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
4727
4701
|
}
|
|
4728
|
-
export class
|
|
4702
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
4729
4703
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4730
4704
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4731
4705
|
/**
|
|
4732
|
-
* @description
|
|
4733
|
-
* @tags
|
|
4734
|
-
* @name
|
|
4735
|
-
* @summary Get
|
|
4736
|
-
* @request GET:/
|
|
4737
|
-
* @secure
|
|
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
|
|
4738
4712
|
*/
|
|
4739
|
-
|
|
4713
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
4740
4714
|
/**
|
|
4741
|
-
*
|
|
4742
|
-
*
|
|
4743
|
-
* @default "group,rank"
|
|
4715
|
+
* Limit
|
|
4716
|
+
* Number of historical periods to be returned (default is 1).
|
|
4744
4717
|
*/
|
|
4745
|
-
|
|
4718
|
+
limit?: number;
|
|
4746
4719
|
/**
|
|
4747
4720
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4748
4721
|
* @default "en-US"
|
|
4749
4722
|
*/
|
|
4750
|
-
language?:
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
|
|
4756
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
4757
|
-
/**
|
|
4758
|
-
* Page
|
|
4759
|
-
* Define the page number for pagination.
|
|
4760
|
-
* @min 1
|
|
4761
|
-
* @default 1
|
|
4762
|
-
*/
|
|
4763
|
-
page?: number;
|
|
4764
|
-
/**
|
|
4765
|
-
* Page Size
|
|
4766
|
-
* Define the number of records per page for pagination purposes.
|
|
4767
|
-
* @min 1
|
|
4768
|
-
* @default 10
|
|
4769
|
-
*/
|
|
4770
|
-
page_size?: number;
|
|
4771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
4723
|
+
language?: BridgeWiseLanguageEnum;
|
|
4724
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
4725
|
+
}
|
|
4726
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
4727
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4728
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4772
4729
|
/**
|
|
4773
|
-
* @description
|
|
4774
|
-
* @tags
|
|
4775
|
-
* @name
|
|
4776
|
-
* @summary Get
|
|
4777
|
-
* @request GET:/
|
|
4730
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
4731
|
+
* @tags Fund Market Data
|
|
4732
|
+
* @name GetFundsMarketData
|
|
4733
|
+
* @summary Get Funds Market Data
|
|
4734
|
+
* @request GET:/funds/{fund_id}/market
|
|
4778
4735
|
* @secure
|
|
4779
4736
|
*/
|
|
4780
|
-
|
|
4737
|
+
getFundsMarketData(fundId: number, query?: {
|
|
4781
4738
|
/**
|
|
4782
|
-
*
|
|
4783
|
-
*
|
|
4739
|
+
* Trading Item Id
|
|
4740
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4784
4741
|
*/
|
|
4785
|
-
|
|
4742
|
+
trading_item_id?: number | null;
|
|
4786
4743
|
/**
|
|
4787
|
-
*
|
|
4788
|
-
*
|
|
4789
|
-
* @default "rank"
|
|
4744
|
+
* Date Ge
|
|
4745
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4790
4746
|
*/
|
|
4791
|
-
|
|
4747
|
+
date__ge?: string | null;
|
|
4792
4748
|
/**
|
|
4793
|
-
*
|
|
4794
|
-
*
|
|
4749
|
+
* Date Le
|
|
4750
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4795
4751
|
*/
|
|
4796
|
-
|
|
4797
|
-
|
|
4798
|
-
|
|
4799
|
-
|
|
4800
|
-
|
|
4752
|
+
date__le?: string | null;
|
|
4753
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
4754
|
+
/**
|
|
4755
|
+
* @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.
|
|
4756
|
+
* @tags Fund Market Data
|
|
4757
|
+
* @name GetFundsMarketStatistics
|
|
4758
|
+
* @summary Get Funds Market Statistics
|
|
4759
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
4760
|
+
* @secure
|
|
4761
|
+
*/
|
|
4762
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
4801
4763
|
/**
|
|
4802
|
-
*
|
|
4803
|
-
*
|
|
4804
|
-
* @min 1
|
|
4805
|
-
* @default 1
|
|
4764
|
+
* Trading Item Id
|
|
4765
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4806
4766
|
*/
|
|
4807
|
-
|
|
4767
|
+
trading_item_id?: number | null;
|
|
4808
4768
|
/**
|
|
4809
|
-
*
|
|
4810
|
-
*
|
|
4811
|
-
* @min 1
|
|
4812
|
-
* @default 10
|
|
4769
|
+
* Identifier In
|
|
4770
|
+
* Specify a list of external identifiers.
|
|
4813
4771
|
*/
|
|
4814
|
-
|
|
4815
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4772
|
+
identifier__in?: string | null;
|
|
4773
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
4816
4774
|
/**
|
|
4817
|
-
* @description
|
|
4818
|
-
* @tags
|
|
4819
|
-
* @name
|
|
4820
|
-
* @summary Get
|
|
4821
|
-
* @request GET:/
|
|
4775
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
4776
|
+
* @tags Fund Market Data
|
|
4777
|
+
* @name GetFundTradingItems
|
|
4778
|
+
* @summary Get Fund Trading Items
|
|
4779
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
4822
4780
|
* @secure
|
|
4823
4781
|
*/
|
|
4824
|
-
|
|
4782
|
+
getFundTradingItems(fundId: number, query?: {
|
|
4825
4783
|
/**
|
|
4826
|
-
*
|
|
4827
|
-
*
|
|
4784
|
+
* Primary Flag
|
|
4785
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4828
4786
|
*/
|
|
4829
|
-
|
|
4787
|
+
primary_flag?: boolean;
|
|
4830
4788
|
/**
|
|
4831
|
-
*
|
|
4832
|
-
*
|
|
4833
|
-
* @default false
|
|
4789
|
+
* Security Primary Flag
|
|
4790
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4834
4791
|
*/
|
|
4835
|
-
|
|
4836
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4837
|
-
/**
|
|
4838
|
-
* @tags Themes
|
|
4839
|
-
* @name GetThemeFilters
|
|
4840
|
-
* @summary Get Theme Filters
|
|
4841
|
-
* @request GET:/themes/{theme_id}/filters
|
|
4842
|
-
* @secure
|
|
4843
|
-
*/
|
|
4844
|
-
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4792
|
+
security_primary_flag?: boolean;
|
|
4793
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
4845
4794
|
}
|
|
4846
4795
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4847
4796
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5229,114 +5178,190 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
5229
5178
|
language?: BridgeWiseLanguageEnum;
|
|
5230
5179
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
5231
5180
|
}
|
|
5232
|
-
export class
|
|
5181
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5233
5182
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5234
5183
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5235
5184
|
/**
|
|
5236
|
-
* @description
|
|
5237
|
-
* @tags
|
|
5238
|
-
* @name
|
|
5239
|
-
* @summary Get
|
|
5240
|
-
* @request GET:/funds/{fund_id}/
|
|
5185
|
+
* @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.
|
|
5186
|
+
* @tags Holdings
|
|
5187
|
+
* @name GetCompositions
|
|
5188
|
+
* @summary Get Compositions
|
|
5189
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
5241
5190
|
* @secure
|
|
5242
5191
|
*/
|
|
5243
|
-
|
|
5192
|
+
getCompositions(fundId: number, query?: {
|
|
5244
5193
|
/**
|
|
5245
5194
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5246
5195
|
* @default "en-US"
|
|
5247
5196
|
*/
|
|
5248
5197
|
language?: BridgeWiseLanguageEnum;
|
|
5249
|
-
/**
|
|
5250
|
-
|
|
5251
|
-
|
|
5252
|
-
*/
|
|
5253
|
-
year?: number;
|
|
5254
|
-
/**
|
|
5255
|
-
* Quarter
|
|
5256
|
-
* Specify the quarter for which the analysis is requested.
|
|
5257
|
-
*/
|
|
5258
|
-
quarter?: number;
|
|
5259
|
-
/**
|
|
5260
|
-
* Show All
|
|
5261
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5262
|
-
*/
|
|
5263
|
-
show_all?: boolean;
|
|
5264
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
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>>;
|
|
5265
5201
|
/**
|
|
5266
|
-
* @description
|
|
5267
|
-
* @tags
|
|
5268
|
-
* @name
|
|
5269
|
-
* @summary Get
|
|
5270
|
-
* @request GET:/funds/{fund_id}/
|
|
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
|
|
5271
5207
|
* @secure
|
|
5272
5208
|
*/
|
|
5273
|
-
|
|
5209
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
5274
5210
|
/**
|
|
5275
5211
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5276
5212
|
* @default "en-US"
|
|
5277
5213
|
*/
|
|
5278
5214
|
language?: BridgeWiseLanguageEnum;
|
|
5279
5215
|
/**
|
|
5280
|
-
*
|
|
5281
|
-
*
|
|
5216
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5217
|
+
* @default "stocks"
|
|
5282
5218
|
*/
|
|
5283
|
-
|
|
5219
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5284
5220
|
/**
|
|
5285
|
-
*
|
|
5286
|
-
*
|
|
5221
|
+
* Page
|
|
5222
|
+
* Define the page number for pagination.
|
|
5223
|
+
* @exclusiveMin 0
|
|
5287
5224
|
*/
|
|
5288
|
-
|
|
5289
|
-
|
|
5225
|
+
page?: number;
|
|
5226
|
+
/**
|
|
5227
|
+
* Page Size
|
|
5228
|
+
* Define the number of records per page for pagination purposes.
|
|
5229
|
+
* @exclusiveMin 0
|
|
5230
|
+
*/
|
|
5231
|
+
page_size?: number;
|
|
5232
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
5290
5233
|
/**
|
|
5291
|
-
* @description
|
|
5292
|
-
* @tags
|
|
5293
|
-
* @name
|
|
5294
|
-
* @summary Get
|
|
5295
|
-
* @request GET:/funds/{fund_id}/
|
|
5234
|
+
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
5235
|
+
* @tags Holdings
|
|
5236
|
+
* @name GetHoldings
|
|
5237
|
+
* @summary Get Holdings
|
|
5238
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
5296
5239
|
* @secure
|
|
5297
5240
|
*/
|
|
5298
|
-
|
|
5241
|
+
getHoldings(fundId: number, query?: {
|
|
5299
5242
|
/**
|
|
5300
5243
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5301
5244
|
* @default "en-US"
|
|
5302
5245
|
*/
|
|
5303
5246
|
language?: BridgeWiseLanguageEnum;
|
|
5304
5247
|
/**
|
|
5305
|
-
*
|
|
5306
|
-
*
|
|
5307
|
-
*/
|
|
5308
|
-
parameter_id?: number;
|
|
5309
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
5310
|
-
/**
|
|
5311
|
-
* @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.
|
|
5312
|
-
* @tags Fund Analysis
|
|
5313
|
-
* @name GetFundSections
|
|
5314
|
-
* @summary Get Fund Sections
|
|
5315
|
-
* @request GET:/funds/{fund_id}/sections
|
|
5316
|
-
* @secure
|
|
5317
|
-
*/
|
|
5318
|
-
getFundSections(fundId: number, query?: {
|
|
5319
|
-
/**
|
|
5320
|
-
* Year
|
|
5321
|
-
* Specify the year for which the analysis is requested.
|
|
5248
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5249
|
+
* @default "stocks"
|
|
5322
5250
|
*/
|
|
5323
|
-
|
|
5251
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5324
5252
|
/**
|
|
5325
|
-
*
|
|
5326
|
-
*
|
|
5253
|
+
* Page
|
|
5254
|
+
* Define the page number for pagination.
|
|
5255
|
+
* @exclusiveMin 0
|
|
5327
5256
|
*/
|
|
5328
|
-
|
|
5257
|
+
page?: number;
|
|
5329
5258
|
/**
|
|
5330
|
-
*
|
|
5331
|
-
*
|
|
5259
|
+
* Page Size
|
|
5260
|
+
* Define the number of records per page for pagination purposes.
|
|
5261
|
+
* @exclusiveMin 0
|
|
5332
5262
|
*/
|
|
5333
|
-
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5263
|
+
page_size?: number;
|
|
5264
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
5265
|
+
}
|
|
5266
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5267
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5268
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5269
|
+
/**
|
|
5270
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
5271
|
+
* @tags Logos
|
|
5272
|
+
* @name FetchLogos
|
|
5273
|
+
* @summary Fetch Logos
|
|
5274
|
+
* @request GET:/companies/logos
|
|
5275
|
+
* @secure
|
|
5276
|
+
*/
|
|
5277
|
+
fetchLogos(query?: {
|
|
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"
|
|
5337
5283
|
*/
|
|
5338
|
-
|
|
5339
|
-
|
|
5284
|
+
company_id__in?: string;
|
|
5285
|
+
/**
|
|
5286
|
+
* Size
|
|
5287
|
+
* Page size
|
|
5288
|
+
* @min 1
|
|
5289
|
+
* @max 100
|
|
5290
|
+
* @default 50
|
|
5291
|
+
*/
|
|
5292
|
+
size?: number;
|
|
5293
|
+
/**
|
|
5294
|
+
* Page
|
|
5295
|
+
* Page number
|
|
5296
|
+
* @min 1
|
|
5297
|
+
* @default 1
|
|
5298
|
+
*/
|
|
5299
|
+
page?: number;
|
|
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;
|
|
5325
|
+
/**
|
|
5326
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5327
|
+
* @default "en-US"
|
|
5328
|
+
*/
|
|
5329
|
+
language?: BridgeWiseLanguageEnum;
|
|
5330
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
5331
|
+
}
|
|
5332
|
+
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5333
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5334
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5335
|
+
/**
|
|
5336
|
+
* @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
|
|
5337
|
+
* @tags Sector Analysis
|
|
5338
|
+
* @name GetSectorAnalysis
|
|
5339
|
+
* @summary Get Sector Analysis
|
|
5340
|
+
* @request GET:/sectors/{sector_id}/analysis
|
|
5341
|
+
* @secure
|
|
5342
|
+
*/
|
|
5343
|
+
getSectorAnalysis(sectorId: number, query?: {
|
|
5344
|
+
/**
|
|
5345
|
+
* Year
|
|
5346
|
+
* Specify the year for which the analysis is requested.
|
|
5347
|
+
*/
|
|
5348
|
+
year?: number;
|
|
5349
|
+
/**
|
|
5350
|
+
* Quarter
|
|
5351
|
+
* Specify the quarter for which the analysis is requested.
|
|
5352
|
+
*/
|
|
5353
|
+
quarter?: number;
|
|
5354
|
+
/**
|
|
5355
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5356
|
+
* @default "en-US"
|
|
5357
|
+
*/
|
|
5358
|
+
language?: BridgeWiseLanguageEnum;
|
|
5359
|
+
/**
|
|
5360
|
+
* Limit
|
|
5361
|
+
* Number of sector strength periods to be returned (default is 1).
|
|
5362
|
+
*/
|
|
5363
|
+
limit?: number;
|
|
5364
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
5340
5365
|
}
|
|
5341
5366
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5342
5367
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5389,39 +5414,131 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
5389
5414
|
segment?: string;
|
|
5390
5415
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5391
5416
|
}
|
|
5392
|
-
export class
|
|
5417
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
5393
5418
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5394
5419
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5395
5420
|
/**
|
|
5396
|
-
* @description
|
|
5397
|
-
* @tags
|
|
5398
|
-
* @name
|
|
5399
|
-
* @summary Get
|
|
5400
|
-
* @request GET:/
|
|
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
|
|
5401
5426
|
* @secure
|
|
5402
5427
|
*/
|
|
5403
|
-
|
|
5428
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
5404
5429
|
/**
|
|
5405
|
-
*
|
|
5406
|
-
*
|
|
5430
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5431
|
+
* @default "en-US"
|
|
5407
5432
|
*/
|
|
5408
|
-
|
|
5433
|
+
language?: BridgeWiseLanguageEnum;
|
|
5409
5434
|
/**
|
|
5410
|
-
*
|
|
5411
|
-
* Specify
|
|
5435
|
+
* Trading Item Id
|
|
5436
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5412
5437
|
*/
|
|
5413
|
-
|
|
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?: {
|
|
5414
5449
|
/**
|
|
5415
5450
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5416
5451
|
* @default "en-US"
|
|
5417
5452
|
*/
|
|
5418
5453
|
language?: BridgeWiseLanguageEnum;
|
|
5419
5454
|
/**
|
|
5420
|
-
*
|
|
5421
|
-
*
|
|
5455
|
+
* Trading Item Id
|
|
5456
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5422
5457
|
*/
|
|
5423
|
-
|
|
5424
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
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>>;
|
|
5425
5542
|
}
|
|
5426
5543
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
5427
5544
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5596,263 +5713,146 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
5596
5713
|
*/
|
|
5597
5714
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5598
5715
|
}
|
|
5599
|
-
export class
|
|
5716
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
5600
5717
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5601
5718
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5602
5719
|
/**
|
|
5603
|
-
* @description
|
|
5604
|
-
* @tags
|
|
5605
|
-
* @name
|
|
5606
|
-
* @summary Get
|
|
5607
|
-
* @request GET:/
|
|
5720
|
+
* @description Retrieve a list of themes and their details associated with the company.
|
|
5721
|
+
* @tags Themes
|
|
5722
|
+
* @name GetCompanyThemes
|
|
5723
|
+
* @summary Get Company Themes
|
|
5724
|
+
* @request GET:/companies/{company_id}/themes
|
|
5608
5725
|
* @secure
|
|
5609
5726
|
*/
|
|
5610
|
-
|
|
5611
|
-
/** Tenant custom identifier status. */
|
|
5612
|
-
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5727
|
+
getCompanyThemes(companyId: number, query?: {
|
|
5613
5728
|
/**
|
|
5614
|
-
*
|
|
5615
|
-
*
|
|
5616
|
-
* @default
|
|
5617
|
-
* @example 1
|
|
5729
|
+
* Sort By
|
|
5730
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5731
|
+
* @default "group,rank"
|
|
5618
5732
|
*/
|
|
5619
|
-
|
|
5620
|
-
/**
|
|
5621
|
-
* Page Size
|
|
5622
|
-
* Define the maximum number of results to retrieve.
|
|
5623
|
-
* @default 20
|
|
5624
|
-
* @example 10
|
|
5625
|
-
*/
|
|
5626
|
-
page_size?: number;
|
|
5627
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5628
|
-
/**
|
|
5629
|
-
* @description Create a new identifier for a tenant
|
|
5630
|
-
* @tags Tenant Identifiers
|
|
5631
|
-
* @name CreateTenantIdentifier
|
|
5632
|
-
* @summary Create Tenant Identifier
|
|
5633
|
-
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5634
|
-
* @secure
|
|
5635
|
-
*/
|
|
5636
|
-
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5637
|
-
/**
|
|
5638
|
-
* @description Update an existing identifier for a tenant
|
|
5639
|
-
* @tags Tenant Identifiers
|
|
5640
|
-
* @name UpdateTenantIdentifier
|
|
5641
|
-
* @summary Update Tenant Identifier
|
|
5642
|
-
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5643
|
-
* @secure
|
|
5644
|
-
*/
|
|
5645
|
-
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5646
|
-
/**
|
|
5647
|
-
* @description Delete identifier for a tenant
|
|
5648
|
-
* @tags Tenant Identifiers
|
|
5649
|
-
* @name DeleteTenantIdentifier
|
|
5650
|
-
* @summary Delete Tenant Identifier
|
|
5651
|
-
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5652
|
-
* @secure
|
|
5653
|
-
*/
|
|
5654
|
-
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5655
|
-
}
|
|
5656
|
-
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5657
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5658
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5659
|
-
/**
|
|
5660
|
-
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5661
|
-
* @tags Fund ESG Analysis
|
|
5662
|
-
* @name GetFundEsgAnalysis
|
|
5663
|
-
* @summary Get Fund Esg Analysis
|
|
5664
|
-
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5665
|
-
* @secure
|
|
5666
|
-
*/
|
|
5667
|
-
getFundEsgAnalysis(fundId: number, query?: {
|
|
5668
|
-
/**
|
|
5669
|
-
* Limit
|
|
5670
|
-
* Number of historical periods to be returned (default is 1).
|
|
5671
|
-
*/
|
|
5672
|
-
limit?: number;
|
|
5733
|
+
sort_by?: string | null;
|
|
5673
5734
|
/**
|
|
5674
5735
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5675
5736
|
* @default "en-US"
|
|
5676
5737
|
*/
|
|
5677
|
-
language?:
|
|
5678
|
-
|
|
5679
|
-
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
* @tags Users
|
|
5685
|
-
* @name Authenticate
|
|
5686
|
-
* @summary Authenticate
|
|
5687
|
-
* @request POST:/users/authenticate
|
|
5688
|
-
* @secure
|
|
5689
|
-
*/
|
|
5690
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5691
|
-
/**
|
|
5692
|
-
* @tags Users
|
|
5693
|
-
* @name FetchClientDetails
|
|
5694
|
-
* @summary Fetch Client Details
|
|
5695
|
-
* @request GET:/users/machine
|
|
5696
|
-
* @secure
|
|
5697
|
-
*/
|
|
5698
|
-
fetchClientDetails(headers: {
|
|
5699
|
-
/** Authorization */
|
|
5700
|
-
authorization: string;
|
|
5701
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5702
|
-
}
|
|
5703
|
-
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5704
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5705
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5706
|
-
/**
|
|
5707
|
-
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5708
|
-
* @tags Fund Market Data
|
|
5709
|
-
* @name GetFundsMarketData
|
|
5710
|
-
* @summary Get Funds Market Data
|
|
5711
|
-
* @request GET:/funds/{fund_id}/market
|
|
5712
|
-
* @secure
|
|
5713
|
-
*/
|
|
5714
|
-
getFundsMarketData(fundId: number, query?: {
|
|
5715
|
-
/**
|
|
5716
|
-
* Trading Item Id
|
|
5717
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5718
|
-
*/
|
|
5719
|
-
trading_item_id?: number | null;
|
|
5720
|
-
/**
|
|
5721
|
-
* Date Ge
|
|
5722
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5723
|
-
*/
|
|
5724
|
-
date__ge?: string | null;
|
|
5725
|
-
/**
|
|
5726
|
-
* Date Le
|
|
5727
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5728
|
-
*/
|
|
5729
|
-
date__le?: string | null;
|
|
5730
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5731
|
-
/**
|
|
5732
|
-
* @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.
|
|
5733
|
-
* @tags Fund Market Data
|
|
5734
|
-
* @name GetFundsMarketStatistics
|
|
5735
|
-
* @summary Get Funds Market Statistics
|
|
5736
|
-
* @request GET:/funds/{fund_id}/market-statistics
|
|
5737
|
-
* @secure
|
|
5738
|
-
*/
|
|
5739
|
-
getFundsMarketStatistics(fundId: number, query?: {
|
|
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;
|
|
5740
5745
|
/**
|
|
5741
|
-
*
|
|
5742
|
-
*
|
|
5746
|
+
* Page
|
|
5747
|
+
* Define the page number for pagination.
|
|
5748
|
+
* @min 1
|
|
5749
|
+
* @default 1
|
|
5743
5750
|
*/
|
|
5744
|
-
|
|
5751
|
+
page?: number;
|
|
5745
5752
|
/**
|
|
5746
|
-
*
|
|
5747
|
-
*
|
|
5753
|
+
* Page Size
|
|
5754
|
+
* Define the number of records per page for pagination purposes.
|
|
5755
|
+
* @min 1
|
|
5756
|
+
* @default 10
|
|
5748
5757
|
*/
|
|
5749
|
-
|
|
5750
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5758
|
+
page_size?: number;
|
|
5759
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
5751
5760
|
/**
|
|
5752
|
-
* @description
|
|
5753
|
-
* @tags
|
|
5754
|
-
* @name
|
|
5755
|
-
* @summary Get
|
|
5756
|
-
* @request GET:/
|
|
5761
|
+
* @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.
|
|
5762
|
+
* @tags Themes
|
|
5763
|
+
* @name GetThemes
|
|
5764
|
+
* @summary Get Themes
|
|
5765
|
+
* @request GET:/themes
|
|
5757
5766
|
* @secure
|
|
5758
5767
|
*/
|
|
5759
|
-
|
|
5760
|
-
/**
|
|
5761
|
-
* Primary Flag
|
|
5762
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5763
|
-
*/
|
|
5764
|
-
primary_flag?: boolean;
|
|
5768
|
+
getThemes(query?: {
|
|
5765
5769
|
/**
|
|
5766
|
-
*
|
|
5767
|
-
*
|
|
5770
|
+
* Search
|
|
5771
|
+
* Search string to filter themes by name or description.
|
|
5768
5772
|
*/
|
|
5769
|
-
|
|
5770
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5771
|
-
}
|
|
5772
|
-
export class Holdings<HandleError extends boolean = boolean> {
|
|
5773
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5774
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5775
|
-
/**
|
|
5776
|
-
* @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.
|
|
5777
|
-
* @tags Holdings
|
|
5778
|
-
* @name GetCompositions
|
|
5779
|
-
* @summary Get Compositions
|
|
5780
|
-
* @request GET:/funds/{fund_id}/compositions
|
|
5781
|
-
* @secure
|
|
5782
|
-
*/
|
|
5783
|
-
getCompositions(fundId: number, query?: {
|
|
5773
|
+
search?: string | null;
|
|
5784
5774
|
/**
|
|
5785
|
-
*
|
|
5786
|
-
*
|
|
5775
|
+
* Sort By
|
|
5776
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5777
|
+
* @default "rank"
|
|
5787
5778
|
*/
|
|
5788
|
-
|
|
5789
|
-
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5790
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5791
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5792
|
-
/**
|
|
5793
|
-
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5794
|
-
* @tags Holdings
|
|
5795
|
-
* @name GetHoldingStatistics
|
|
5796
|
-
* @summary Get Holding Statistics
|
|
5797
|
-
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5798
|
-
* @secure
|
|
5799
|
-
*/
|
|
5800
|
-
getHoldingStatistics(fundId: number, query?: {
|
|
5779
|
+
sort_by?: string;
|
|
5801
5780
|
/**
|
|
5802
5781
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5803
5782
|
* @default "en-US"
|
|
5804
5783
|
*/
|
|
5805
|
-
language?:
|
|
5806
|
-
/**
|
|
5807
|
-
|
|
5808
|
-
|
|
5809
|
-
|
|
5810
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5784
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
5785
|
+
/** Filter basic and advanced theme packages. */
|
|
5786
|
+
package?: BridgeWiseThemePackageEnum;
|
|
5787
|
+
/** The type of the theme. */
|
|
5788
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
5811
5789
|
/**
|
|
5812
5790
|
* Page
|
|
5813
5791
|
* Define the page number for pagination.
|
|
5814
|
-
* @
|
|
5792
|
+
* @min 1
|
|
5793
|
+
* @default 1
|
|
5815
5794
|
*/
|
|
5816
5795
|
page?: number;
|
|
5817
5796
|
/**
|
|
5818
5797
|
* Page Size
|
|
5819
5798
|
* Define the number of records per page for pagination purposes.
|
|
5820
|
-
* @
|
|
5799
|
+
* @min 1
|
|
5800
|
+
* @default 10
|
|
5821
5801
|
*/
|
|
5822
5802
|
page_size?: number;
|
|
5823
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5803
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
5824
5804
|
/**
|
|
5825
|
-
* @description
|
|
5826
|
-
* @tags
|
|
5827
|
-
* @name
|
|
5828
|
-
* @summary Get
|
|
5829
|
-
* @request GET:/
|
|
5805
|
+
* @description Retrieve a specific theme by its ID.
|
|
5806
|
+
* @tags Themes
|
|
5807
|
+
* @name GetTheme
|
|
5808
|
+
* @summary Get Theme
|
|
5809
|
+
* @request GET:/themes/{theme_id}
|
|
5830
5810
|
* @secure
|
|
5831
5811
|
*/
|
|
5832
|
-
|
|
5812
|
+
getTheme(themeId: number, query?: {
|
|
5833
5813
|
/**
|
|
5834
5814
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5835
5815
|
* @default "en-US"
|
|
5836
5816
|
*/
|
|
5837
|
-
language?:
|
|
5838
|
-
/**
|
|
5839
|
-
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5840
|
-
* @default "stocks"
|
|
5841
|
-
*/
|
|
5842
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5843
|
-
/**
|
|
5844
|
-
* Page
|
|
5845
|
-
* Define the page number for pagination.
|
|
5846
|
-
* @exclusiveMin 0
|
|
5847
|
-
*/
|
|
5848
|
-
page?: number;
|
|
5817
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
5849
5818
|
/**
|
|
5850
|
-
*
|
|
5851
|
-
*
|
|
5852
|
-
* @
|
|
5819
|
+
* Include Filter
|
|
5820
|
+
* Include theme filters.
|
|
5821
|
+
* @default false
|
|
5853
5822
|
*/
|
|
5854
|
-
|
|
5855
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5823
|
+
include_filter?: boolean;
|
|
5824
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
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>>;
|
|
5833
|
+
}
|
|
5834
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5835
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5836
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5837
|
+
/**
|
|
5838
|
+
* @tags Users
|
|
5839
|
+
* @name Authenticate
|
|
5840
|
+
* @summary Authenticate
|
|
5841
|
+
* @request POST:/users/authenticate
|
|
5842
|
+
* @secure
|
|
5843
|
+
*/
|
|
5844
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5845
|
+
/**
|
|
5846
|
+
* @tags Users
|
|
5847
|
+
* @name FetchClientDetails
|
|
5848
|
+
* @summary Fetch Client Details
|
|
5849
|
+
* @request GET:/users/machine
|
|
5850
|
+
* @secure
|
|
5851
|
+
*/
|
|
5852
|
+
fetchClientDetails(headers: {
|
|
5853
|
+
/** Authorization */
|
|
5854
|
+
authorization: string;
|
|
5855
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5856
5856
|
}
|
|
5857
5857
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5858
5858
|
readonly config: JwtClientConfig<HandleError>;
|