@orbis-systems/orbis-api-clients 0.7.13 → 0.7.14
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 +214 -114
- 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 +865 -865
- 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 +1180 -1180
- 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 +46 -46
- 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 +4036 -4036
- 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 +618 -618
- 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 +720 -720
- 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,56 +3031,6 @@ 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
|
-
}
|
|
3084
3034
|
export class Bridget<HandleError extends boolean = boolean> {
|
|
3085
3035
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3086
3036
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3450,75 +3400,6 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
3450
3400
|
identifier: string;
|
|
3451
3401
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3452
3402
|
}
|
|
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
3403
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3523
3404
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3524
3405
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4158,83 +4039,100 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4158
4039
|
identifier_type: string;
|
|
4159
4040
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4160
4041
|
}
|
|
4161
|
-
export class
|
|
4042
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
4162
4043
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4163
4044
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4164
4045
|
/**
|
|
4165
|
-
* @description
|
|
4166
|
-
* @tags
|
|
4167
|
-
* @name
|
|
4168
|
-
* @summary
|
|
4169
|
-
* @request GET:/companies/
|
|
4046
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4047
|
+
* @tags Logos
|
|
4048
|
+
* @name FetchLogos
|
|
4049
|
+
* @summary Fetch Logos
|
|
4050
|
+
* @request GET:/companies/logos
|
|
4170
4051
|
* @secure
|
|
4171
4052
|
*/
|
|
4172
|
-
|
|
4173
|
-
/**
|
|
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))*$
|
|
4178
|
-
*/
|
|
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;
|
|
4053
|
+
fetchLogos(query?: {
|
|
4194
4054
|
/**
|
|
4195
|
-
*
|
|
4196
|
-
*
|
|
4055
|
+
* Company Id In
|
|
4056
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
4057
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4058
|
+
* @example "74822,83343211"
|
|
4197
4059
|
*/
|
|
4198
|
-
|
|
4060
|
+
company_id__in?: string;
|
|
4199
4061
|
/**
|
|
4200
4062
|
* Size
|
|
4201
|
-
*
|
|
4202
|
-
* @
|
|
4203
|
-
* @
|
|
4063
|
+
* Page size
|
|
4064
|
+
* @min 1
|
|
4065
|
+
* @max 100
|
|
4066
|
+
* @default 50
|
|
4204
4067
|
*/
|
|
4205
4068
|
size?: number;
|
|
4206
4069
|
/**
|
|
4207
4070
|
* Page
|
|
4208
|
-
*
|
|
4071
|
+
* Page number
|
|
4072
|
+
* @min 1
|
|
4209
4073
|
* @default 1
|
|
4210
|
-
* @example 1
|
|
4211
4074
|
*/
|
|
4212
4075
|
page?: number;
|
|
4213
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4076
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4214
4077
|
/**
|
|
4215
|
-
* @description
|
|
4216
|
-
* @tags
|
|
4217
|
-
* @name
|
|
4218
|
-
* @summary
|
|
4219
|
-
* @request GET:/companies/{company_id}/
|
|
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
|
|
4220
4083
|
* @secure
|
|
4221
4084
|
*/
|
|
4222
|
-
|
|
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?: {
|
|
4223
4099
|
/**
|
|
4224
|
-
*
|
|
4225
|
-
*
|
|
4226
|
-
* @format date
|
|
4227
|
-
* @default "2025-07-22"
|
|
4100
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4101
|
+
* @default "en-US"
|
|
4228
4102
|
*/
|
|
4229
|
-
|
|
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;
|
|
4230
4108
|
/**
|
|
4231
|
-
*
|
|
4232
|
-
*
|
|
4233
|
-
* @format date
|
|
4234
|
-
* @default "2025-07-22"
|
|
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
|
|
4235
4111
|
*/
|
|
4236
|
-
|
|
4237
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4112
|
+
importance?: string | null;
|
|
4113
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
4114
|
+
/**
|
|
4115
|
+
* @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.
|
|
4116
|
+
* @tags Activities
|
|
4117
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
4118
|
+
* @summary Get Company Forecasts Key Development
|
|
4119
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
4120
|
+
* @secure
|
|
4121
|
+
*/
|
|
4122
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
4123
|
+
/**
|
|
4124
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4125
|
+
* @default "en-US"
|
|
4126
|
+
*/
|
|
4127
|
+
language?: BridgeWiseLanguageEnum;
|
|
4128
|
+
/**
|
|
4129
|
+
* Importance
|
|
4130
|
+
* 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
|
|
4131
|
+
* @default "0,1"
|
|
4132
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4133
|
+
*/
|
|
4134
|
+
importance?: string;
|
|
4135
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
4238
4136
|
}
|
|
4239
4137
|
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
4240
4138
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4311,120 +4209,15 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4311
4209
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4312
4210
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
4313
4211
|
}
|
|
4314
|
-
export class
|
|
4212
|
+
export class Forecasts<HandleError extends boolean = boolean> {
|
|
4315
4213
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4316
4214
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4317
4215
|
/**
|
|
4318
|
-
* @description
|
|
4319
|
-
* @tags
|
|
4320
|
-
* @name
|
|
4321
|
-
* @summary Get Company
|
|
4322
|
-
* @request GET:/companies/{company_id}/
|
|
4323
|
-
* @secure
|
|
4324
|
-
*/
|
|
4325
|
-
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
4326
|
-
/**
|
|
4327
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4328
|
-
* @default "en-US"
|
|
4329
|
-
*/
|
|
4330
|
-
language?: BridgeWiseLanguageEnum;
|
|
4331
|
-
/**
|
|
4332
|
-
* Show All
|
|
4333
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4334
|
-
*/
|
|
4335
|
-
show_all?: boolean;
|
|
4336
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
4337
|
-
/**
|
|
4338
|
-
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
4339
|
-
* @tags ESG Analysis
|
|
4340
|
-
* @name GetCompanyEsgParagraphs
|
|
4341
|
-
* @summary Get Company Esg Paragraphs
|
|
4342
|
-
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
4343
|
-
* @secure
|
|
4344
|
-
*/
|
|
4345
|
-
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
4346
|
-
/**
|
|
4347
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4348
|
-
* @default "en-US"
|
|
4349
|
-
*/
|
|
4350
|
-
language?: BridgeWiseLanguageEnum;
|
|
4351
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4352
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4353
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4354
|
-
/**
|
|
4355
|
-
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
4356
|
-
* @tags ESG Analysis
|
|
4357
|
-
* @name GetCompanyEsgParameters
|
|
4358
|
-
* @summary Get Company Esg Parameters
|
|
4359
|
-
* @request GET:/companies/{company_id}/esg-parameters
|
|
4360
|
-
* @secure
|
|
4361
|
-
*/
|
|
4362
|
-
getCompanyEsgParameters(companyId: number, query?: {
|
|
4363
|
-
/**
|
|
4364
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4365
|
-
* @default "en-US"
|
|
4366
|
-
*/
|
|
4367
|
-
language?: BridgeWiseLanguageEnum;
|
|
4368
|
-
/**
|
|
4369
|
-
* Parameter Id
|
|
4370
|
-
* Get desired parameter by ID.
|
|
4371
|
-
*/
|
|
4372
|
-
parameter_id?: number;
|
|
4373
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4374
|
-
section_type?: BridgeWiseESGSectionTypeParamEnumV2;
|
|
4375
|
-
/**
|
|
4376
|
-
* Show All
|
|
4377
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4378
|
-
*/
|
|
4379
|
-
show_all?: boolean;
|
|
4380
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
4381
|
-
/**
|
|
4382
|
-
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
4383
|
-
* @tags ESG Analysis
|
|
4384
|
-
* @name GetCompanyEsgSections
|
|
4385
|
-
* @summary Get Company Esg Sections
|
|
4386
|
-
* @request GET:/companies/{company_id}/esg-sections
|
|
4387
|
-
* @secure
|
|
4388
|
-
*/
|
|
4389
|
-
getCompanyEsgSections(companyId: number, query?: {
|
|
4390
|
-
/**
|
|
4391
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4392
|
-
* @default "en-US"
|
|
4393
|
-
*/
|
|
4394
|
-
language?: BridgeWiseLanguageEnum;
|
|
4395
|
-
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4396
|
-
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4397
|
-
/**
|
|
4398
|
-
* Show All
|
|
4399
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4400
|
-
*/
|
|
4401
|
-
show_all?: boolean;
|
|
4402
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
4403
|
-
/**
|
|
4404
|
-
* @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
|
|
4405
|
-
* @tags ESG Analysis
|
|
4406
|
-
* @name GetCompanyForecastsMsa
|
|
4407
|
-
* @summary Get Company Forecasts Msa
|
|
4408
|
-
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
4409
|
-
* @secure
|
|
4410
|
-
*/
|
|
4411
|
-
getCompanyForecastsMsa(companyId: number, query?: {
|
|
4412
|
-
/**
|
|
4413
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4414
|
-
* @default "en-US"
|
|
4415
|
-
*/
|
|
4416
|
-
language?: BridgeWiseLanguageEnum;
|
|
4417
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
4418
|
-
}
|
|
4419
|
-
export class Forecasts<HandleError extends boolean = boolean> {
|
|
4420
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4421
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4422
|
-
/**
|
|
4423
|
-
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
4424
|
-
* @tags Forecasts
|
|
4425
|
-
* @name GetCompanyForecasts
|
|
4426
|
-
* @summary Get Company Forecasts
|
|
4427
|
-
* @request GET:/companies/{company_id}/forecasts
|
|
4216
|
+
* @description <b>!!!WILL BE DEPRECATED!!!</b>
|
|
4217
|
+
* @tags Forecasts
|
|
4218
|
+
* @name GetCompanyForecasts
|
|
4219
|
+
* @summary Get Company Forecasts
|
|
4220
|
+
* @request GET:/companies/{company_id}/forecasts
|
|
4428
4221
|
* @secure
|
|
4429
4222
|
*/
|
|
4430
4223
|
getCompanyForecasts(companyId: number, query?: {
|
|
@@ -4590,263 +4383,500 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4590
4383
|
date__lte?: string;
|
|
4591
4384
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4592
4385
|
}
|
|
4593
|
-
export class
|
|
4386
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
4594
4387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4595
4388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4596
4389
|
/**
|
|
4597
|
-
* @description
|
|
4598
|
-
* @tags
|
|
4599
|
-
* @name
|
|
4600
|
-
* @summary Get
|
|
4601
|
-
* @request GET:/
|
|
4390
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
4391
|
+
* @tags Company Market Data
|
|
4392
|
+
* @name GetCompanyMarketData
|
|
4393
|
+
* @summary Get Company Market Data
|
|
4394
|
+
* @request GET:/companies/{company_id}/market
|
|
4602
4395
|
* @secure
|
|
4603
4396
|
*/
|
|
4604
|
-
|
|
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;
|
|
4397
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
4610
4398
|
/**
|
|
4611
|
-
*
|
|
4612
|
-
* Specify
|
|
4399
|
+
* Trading Item Id
|
|
4400
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4613
4401
|
*/
|
|
4614
|
-
|
|
4402
|
+
trading_item_id?: number | null;
|
|
4615
4403
|
/**
|
|
4616
|
-
*
|
|
4617
|
-
* Specify the
|
|
4404
|
+
* Date Ge
|
|
4405
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4618
4406
|
*/
|
|
4619
|
-
|
|
4407
|
+
date__ge?: string | null;
|
|
4620
4408
|
/**
|
|
4621
|
-
*
|
|
4622
|
-
*
|
|
4409
|
+
* Date Le
|
|
4410
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4623
4411
|
*/
|
|
4624
|
-
|
|
4625
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4412
|
+
date__le?: string | null;
|
|
4413
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4626
4414
|
/**
|
|
4627
|
-
* @description
|
|
4628
|
-
* @tags
|
|
4629
|
-
* @name
|
|
4630
|
-
* @summary Get
|
|
4631
|
-
* @request GET:/
|
|
4415
|
+
* @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.
|
|
4416
|
+
* @tags Company Market Data
|
|
4417
|
+
* @name GetCompanyMarketStatistics
|
|
4418
|
+
* @summary Get Company Market Statistics
|
|
4419
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
4632
4420
|
* @secure
|
|
4633
4421
|
*/
|
|
4634
|
-
|
|
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;
|
|
4422
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4640
4423
|
/**
|
|
4641
|
-
*
|
|
4642
|
-
* Specify
|
|
4424
|
+
* Trading Item Id
|
|
4425
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4643
4426
|
*/
|
|
4644
|
-
|
|
4427
|
+
trading_item_id?: number | null;
|
|
4645
4428
|
/**
|
|
4646
|
-
*
|
|
4647
|
-
* Specify
|
|
4429
|
+
* Identifier In
|
|
4430
|
+
* Specify a list of external identifiers.
|
|
4648
4431
|
*/
|
|
4649
|
-
|
|
4650
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4432
|
+
identifier__in?: string | null;
|
|
4433
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4651
4434
|
/**
|
|
4652
|
-
* @description Returns
|
|
4653
|
-
* @tags
|
|
4654
|
-
* @name
|
|
4655
|
-
* @summary Get
|
|
4656
|
-
* @request GET:/
|
|
4435
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4436
|
+
* @tags Company Market Data
|
|
4437
|
+
* @name GetTradingItems
|
|
4438
|
+
* @summary Get Trading Items
|
|
4439
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
4657
4440
|
* @secure
|
|
4658
4441
|
*/
|
|
4659
|
-
|
|
4442
|
+
getTradingItems(companyId: number, query?: {
|
|
4660
4443
|
/**
|
|
4661
|
-
*
|
|
4662
|
-
*
|
|
4444
|
+
* Primary Flag
|
|
4445
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4663
4446
|
*/
|
|
4664
|
-
|
|
4447
|
+
primary_flag?: boolean;
|
|
4665
4448
|
/**
|
|
4666
|
-
*
|
|
4667
|
-
*
|
|
4449
|
+
* Security Primary Flag
|
|
4450
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4668
4451
|
*/
|
|
4669
|
-
|
|
4670
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4452
|
+
security_primary_flag?: boolean;
|
|
4453
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4454
|
+
}
|
|
4455
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4456
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4457
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4671
4458
|
/**
|
|
4672
|
-
* @description
|
|
4673
|
-
* @tags
|
|
4674
|
-
* @name
|
|
4675
|
-
* @summary Get
|
|
4676
|
-
* @request GET:/
|
|
4459
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
4460
|
+
* @tags Company News
|
|
4461
|
+
* @name GetCompanyNews
|
|
4462
|
+
* @summary Get Company News
|
|
4463
|
+
* @request GET:/companies/{company_id}/news
|
|
4677
4464
|
* @secure
|
|
4678
4465
|
*/
|
|
4679
|
-
|
|
4466
|
+
getCompanyNews(companyId: number, query?: {
|
|
4680
4467
|
/**
|
|
4681
|
-
*
|
|
4682
|
-
*
|
|
4468
|
+
* Languages
|
|
4469
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4470
|
+
* @default "en-US"
|
|
4471
|
+
* @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))*$
|
|
4683
4472
|
*/
|
|
4684
|
-
|
|
4473
|
+
languages?: string;
|
|
4685
4474
|
/**
|
|
4686
|
-
*
|
|
4687
|
-
* Specify the
|
|
4475
|
+
* Published Date Gte
|
|
4476
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4477
|
+
* @format date
|
|
4478
|
+
* @default "2025-07-22"
|
|
4688
4479
|
*/
|
|
4689
|
-
|
|
4480
|
+
published_date__gte?: string;
|
|
4690
4481
|
/**
|
|
4691
|
-
*
|
|
4692
|
-
*
|
|
4482
|
+
* Published Date Lte
|
|
4483
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4484
|
+
* @format date
|
|
4485
|
+
* @default "2025-07-22"
|
|
4693
4486
|
*/
|
|
4694
|
-
|
|
4487
|
+
published_date__lte?: string;
|
|
4695
4488
|
/**
|
|
4696
|
-
*
|
|
4697
|
-
*
|
|
4489
|
+
* Specify the field by which to sort the results.
|
|
4490
|
+
* @default "publication_date"
|
|
4698
4491
|
*/
|
|
4699
|
-
|
|
4700
|
-
|
|
4701
|
-
|
|
4702
|
-
|
|
4703
|
-
|
|
4704
|
-
|
|
4705
|
-
|
|
4706
|
-
|
|
4707
|
-
|
|
4708
|
-
|
|
4709
|
-
|
|
4710
|
-
|
|
4492
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4493
|
+
/**
|
|
4494
|
+
* Size
|
|
4495
|
+
* Define the number of records per page for pagination purposes.
|
|
4496
|
+
* @default 10
|
|
4497
|
+
* @example 10
|
|
4498
|
+
*/
|
|
4499
|
+
size?: number;
|
|
4500
|
+
/**
|
|
4501
|
+
* Page
|
|
4502
|
+
* Define the page number for pagination.
|
|
4503
|
+
* @default 1
|
|
4504
|
+
* @example 1
|
|
4505
|
+
*/
|
|
4506
|
+
page?: number;
|
|
4507
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4508
|
+
/**
|
|
4509
|
+
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
4510
|
+
* @tags Company News
|
|
4511
|
+
* @name GetAverageCompanyNewsSentiment
|
|
4512
|
+
* @summary Get Average Company News Sentiment
|
|
4513
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
4711
4514
|
* @secure
|
|
4712
4515
|
*/
|
|
4713
|
-
|
|
4516
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4714
4517
|
/**
|
|
4715
|
-
*
|
|
4716
|
-
*
|
|
4518
|
+
* Published Date Gte
|
|
4519
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4520
|
+
* @format date
|
|
4521
|
+
* @default "2025-07-22"
|
|
4717
4522
|
*/
|
|
4718
|
-
|
|
4523
|
+
published_date__gte?: string;
|
|
4719
4524
|
/**
|
|
4720
|
-
*
|
|
4721
|
-
*
|
|
4525
|
+
* Published Date Lte
|
|
4526
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4527
|
+
* @format date
|
|
4528
|
+
* @default "2025-07-22"
|
|
4722
4529
|
*/
|
|
4723
|
-
|
|
4724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4530
|
+
published_date__lte?: string;
|
|
4531
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4725
4532
|
}
|
|
4726
|
-
export class
|
|
4533
|
+
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4727
4534
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4728
4535
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4729
4536
|
/**
|
|
4730
|
-
* @description
|
|
4731
|
-
* @tags
|
|
4732
|
-
* @name
|
|
4733
|
-
* @summary Get
|
|
4734
|
-
* @request GET:/
|
|
4537
|
+
* @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
|
|
4538
|
+
* @tags ESG Analysis
|
|
4539
|
+
* @name GetCompanyEsgAnalysis
|
|
4540
|
+
* @summary Get Company Esg Analysis
|
|
4541
|
+
* @request GET:/companies/{company_id}/esg-analysis
|
|
4735
4542
|
* @secure
|
|
4736
4543
|
*/
|
|
4737
|
-
|
|
4544
|
+
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
4738
4545
|
/**
|
|
4739
|
-
*
|
|
4740
|
-
*
|
|
4546
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4547
|
+
* @default "en-US"
|
|
4741
4548
|
*/
|
|
4742
|
-
|
|
4549
|
+
language?: BridgeWiseLanguageEnum;
|
|
4743
4550
|
/**
|
|
4744
|
-
*
|
|
4745
|
-
*
|
|
4551
|
+
* Show All
|
|
4552
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4746
4553
|
*/
|
|
4747
|
-
|
|
4554
|
+
show_all?: boolean;
|
|
4555
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
|
|
4556
|
+
/**
|
|
4557
|
+
* @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
|
|
4558
|
+
* @tags ESG Analysis
|
|
4559
|
+
* @name GetCompanyEsgParagraphs
|
|
4560
|
+
* @summary Get Company Esg Paragraphs
|
|
4561
|
+
* @request GET:/companies/{company_id}/esg-paragraphs
|
|
4562
|
+
* @secure
|
|
4563
|
+
*/
|
|
4564
|
+
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
4748
4565
|
/**
|
|
4749
|
-
*
|
|
4750
|
-
*
|
|
4566
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4567
|
+
* @default "en-US"
|
|
4751
4568
|
*/
|
|
4752
|
-
|
|
4753
|
-
|
|
4569
|
+
language?: BridgeWiseLanguageEnum;
|
|
4570
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4571
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4572
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4754
4573
|
/**
|
|
4755
|
-
* @description
|
|
4756
|
-
* @tags
|
|
4757
|
-
* @name
|
|
4758
|
-
* @summary Get
|
|
4759
|
-
* @request GET:/
|
|
4574
|
+
* @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
|
|
4575
|
+
* @tags ESG Analysis
|
|
4576
|
+
* @name GetCompanyEsgParameters
|
|
4577
|
+
* @summary Get Company Esg Parameters
|
|
4578
|
+
* @request GET:/companies/{company_id}/esg-parameters
|
|
4760
4579
|
* @secure
|
|
4761
4580
|
*/
|
|
4762
|
-
|
|
4581
|
+
getCompanyEsgParameters(companyId: number, query?: {
|
|
4763
4582
|
/**
|
|
4764
|
-
*
|
|
4765
|
-
*
|
|
4583
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4584
|
+
* @default "en-US"
|
|
4766
4585
|
*/
|
|
4767
|
-
|
|
4586
|
+
language?: BridgeWiseLanguageEnum;
|
|
4768
4587
|
/**
|
|
4769
|
-
*
|
|
4770
|
-
*
|
|
4588
|
+
* Parameter Id
|
|
4589
|
+
* Get desired parameter by ID.
|
|
4771
4590
|
*/
|
|
4772
|
-
|
|
4773
|
-
|
|
4591
|
+
parameter_id?: number;
|
|
4592
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4593
|
+
section_type?: BridgeWiseESGSectionTypeParamEnumV2;
|
|
4594
|
+
/**
|
|
4595
|
+
* Show All
|
|
4596
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4597
|
+
*/
|
|
4598
|
+
show_all?: boolean;
|
|
4599
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
|
|
4774
4600
|
/**
|
|
4775
|
-
* @description
|
|
4776
|
-
* @tags
|
|
4777
|
-
* @name
|
|
4778
|
-
* @summary Get
|
|
4779
|
-
* @request GET:/
|
|
4601
|
+
* @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
|
|
4602
|
+
* @tags ESG Analysis
|
|
4603
|
+
* @name GetCompanyEsgSections
|
|
4604
|
+
* @summary Get Company Esg Sections
|
|
4605
|
+
* @request GET:/companies/{company_id}/esg-sections
|
|
4780
4606
|
* @secure
|
|
4781
4607
|
*/
|
|
4782
|
-
|
|
4608
|
+
getCompanyEsgSections(companyId: number, query?: {
|
|
4783
4609
|
/**
|
|
4784
|
-
*
|
|
4785
|
-
*
|
|
4610
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4611
|
+
* @default "en-US"
|
|
4786
4612
|
*/
|
|
4787
|
-
|
|
4613
|
+
language?: BridgeWiseLanguageEnum;
|
|
4614
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
4615
|
+
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
4788
4616
|
/**
|
|
4789
|
-
*
|
|
4790
|
-
* Boolean flag. Indicate
|
|
4617
|
+
* Show All
|
|
4618
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4791
4619
|
*/
|
|
4792
|
-
|
|
4793
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4620
|
+
show_all?: boolean;
|
|
4621
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
|
|
4622
|
+
/**
|
|
4623
|
+
* @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
|
|
4624
|
+
* @tags ESG Analysis
|
|
4625
|
+
* @name GetCompanyForecastsMsa
|
|
4626
|
+
* @summary Get Company Forecasts Msa
|
|
4627
|
+
* @request GET:/companies/{company_id}/sustainability-incidents
|
|
4628
|
+
* @secure
|
|
4629
|
+
*/
|
|
4630
|
+
getCompanyForecastsMsa(companyId: number, query?: {
|
|
4631
|
+
/**
|
|
4632
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4633
|
+
* @default "en-US"
|
|
4634
|
+
*/
|
|
4635
|
+
language?: BridgeWiseLanguageEnum;
|
|
4636
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
|
|
4794
4637
|
}
|
|
4795
|
-
export class
|
|
4638
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4796
4639
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4797
4640
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4798
4641
|
/**
|
|
4799
|
-
* @description
|
|
4800
|
-
* @tags
|
|
4801
|
-
* @name
|
|
4802
|
-
* @summary Get
|
|
4803
|
-
* @request GET:/
|
|
4642
|
+
* @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.
|
|
4643
|
+
* @tags Technical Analysis
|
|
4644
|
+
* @name GetCompanyTechnicalAnalysis
|
|
4645
|
+
* @summary Get Company Technical Analysis
|
|
4646
|
+
* @request GET:/companies/{company_id}/technical-analysis
|
|
4804
4647
|
* @secure
|
|
4805
4648
|
*/
|
|
4806
|
-
|
|
4649
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
4807
4650
|
/**
|
|
4808
|
-
*
|
|
4809
|
-
*
|
|
4651
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4652
|
+
* @default "en-US"
|
|
4810
4653
|
*/
|
|
4811
|
-
|
|
4654
|
+
language?: BridgeWiseLanguageEnum;
|
|
4812
4655
|
/**
|
|
4813
|
-
*
|
|
4814
|
-
*
|
|
4656
|
+
* Trading Item Id
|
|
4657
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4815
4658
|
*/
|
|
4816
|
-
|
|
4817
|
-
|
|
4818
|
-
|
|
4659
|
+
trading_item_id?: number;
|
|
4660
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
4661
|
+
/**
|
|
4662
|
+
* @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.
|
|
4663
|
+
* @tags Technical Analysis
|
|
4664
|
+
* @name GetCompanyTechnicalParagraphs
|
|
4665
|
+
* @summary Get Company Technical Paragraphs
|
|
4666
|
+
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
4667
|
+
* @secure
|
|
4668
|
+
*/
|
|
4669
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
4819
4670
|
/**
|
|
4820
4671
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4821
4672
|
* @default "en-US"
|
|
4822
4673
|
*/
|
|
4823
4674
|
language?: BridgeWiseLanguageEnum;
|
|
4824
4675
|
/**
|
|
4825
|
-
*
|
|
4826
|
-
*
|
|
4827
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4676
|
+
* Trading Item Id
|
|
4677
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4828
4678
|
*/
|
|
4829
|
-
|
|
4679
|
+
trading_item_id?: number;
|
|
4680
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
4681
|
+
/**
|
|
4682
|
+
* @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.
|
|
4683
|
+
* @tags Technical Analysis
|
|
4684
|
+
* @name GetCompanyTechnicalParameters
|
|
4685
|
+
* @summary Get Company Technical Parameters
|
|
4686
|
+
* @request GET:/companies/{company_id}/technical-parameters
|
|
4687
|
+
* @secure
|
|
4688
|
+
*/
|
|
4689
|
+
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
4830
4690
|
/**
|
|
4831
|
-
*
|
|
4832
|
-
*
|
|
4691
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4692
|
+
* @default "en-US"
|
|
4833
4693
|
*/
|
|
4834
|
-
|
|
4694
|
+
language?: BridgeWiseLanguageEnum;
|
|
4835
4695
|
/**
|
|
4836
|
-
*
|
|
4837
|
-
*
|
|
4838
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4696
|
+
* Trading Item Id
|
|
4697
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4839
4698
|
*/
|
|
4840
|
-
|
|
4699
|
+
trading_item_id?: number;
|
|
4841
4700
|
/**
|
|
4842
|
-
*
|
|
4843
|
-
*
|
|
4844
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4701
|
+
* Parameter Id
|
|
4702
|
+
* Get desired parameter by ID.
|
|
4845
4703
|
*/
|
|
4846
|
-
|
|
4704
|
+
parameter_id?: number;
|
|
4705
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
4706
|
+
}
|
|
4707
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
4708
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4709
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4710
|
+
/**
|
|
4711
|
+
* @description Retrieve a list of themes and their details associated with the company.
|
|
4712
|
+
* @tags Themes
|
|
4713
|
+
* @name GetCompanyThemes
|
|
4714
|
+
* @summary Get Company Themes
|
|
4715
|
+
* @request GET:/companies/{company_id}/themes
|
|
4716
|
+
* @secure
|
|
4717
|
+
*/
|
|
4718
|
+
getCompanyThemes(companyId: number, query?: {
|
|
4847
4719
|
/**
|
|
4848
|
-
*
|
|
4849
|
-
*
|
|
4720
|
+
* Sort By
|
|
4721
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4722
|
+
* @default "group,rank"
|
|
4723
|
+
*/
|
|
4724
|
+
sort_by?: string | null;
|
|
4725
|
+
/**
|
|
4726
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4727
|
+
* @default "en-US"
|
|
4728
|
+
*/
|
|
4729
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4730
|
+
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
4731
|
+
group?: BridgeWiseThemeGroupEnum;
|
|
4732
|
+
/** Filter basic and advanced theme packages. */
|
|
4733
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4734
|
+
/** The type of the theme. */
|
|
4735
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4736
|
+
/**
|
|
4737
|
+
* Page
|
|
4738
|
+
* Define the page number for pagination.
|
|
4739
|
+
* @min 1
|
|
4740
|
+
* @default 1
|
|
4741
|
+
*/
|
|
4742
|
+
page?: number;
|
|
4743
|
+
/**
|
|
4744
|
+
* Page Size
|
|
4745
|
+
* Define the number of records per page for pagination purposes.
|
|
4746
|
+
* @min 1
|
|
4747
|
+
* @default 10
|
|
4748
|
+
*/
|
|
4749
|
+
page_size?: number;
|
|
4750
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
4751
|
+
/**
|
|
4752
|
+
* @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.
|
|
4753
|
+
* @tags Themes
|
|
4754
|
+
* @name GetThemes
|
|
4755
|
+
* @summary Get Themes
|
|
4756
|
+
* @request GET:/themes
|
|
4757
|
+
* @secure
|
|
4758
|
+
*/
|
|
4759
|
+
getThemes(query?: {
|
|
4760
|
+
/**
|
|
4761
|
+
* Search
|
|
4762
|
+
* Search string to filter themes by name or description.
|
|
4763
|
+
*/
|
|
4764
|
+
search?: string | null;
|
|
4765
|
+
/**
|
|
4766
|
+
* Sort By
|
|
4767
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4768
|
+
* @default "rank"
|
|
4769
|
+
*/
|
|
4770
|
+
sort_by?: string;
|
|
4771
|
+
/**
|
|
4772
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4773
|
+
* @default "en-US"
|
|
4774
|
+
*/
|
|
4775
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4776
|
+
/** Filter basic and advanced theme packages. */
|
|
4777
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4778
|
+
/** The type of the theme. */
|
|
4779
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4780
|
+
/**
|
|
4781
|
+
* Page
|
|
4782
|
+
* Define the page number for pagination.
|
|
4783
|
+
* @min 1
|
|
4784
|
+
* @default 1
|
|
4785
|
+
*/
|
|
4786
|
+
page?: number;
|
|
4787
|
+
/**
|
|
4788
|
+
* Page Size
|
|
4789
|
+
* Define the number of records per page for pagination purposes.
|
|
4790
|
+
* @min 1
|
|
4791
|
+
* @default 10
|
|
4792
|
+
*/
|
|
4793
|
+
page_size?: number;
|
|
4794
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
4795
|
+
/**
|
|
4796
|
+
* @description Retrieve a specific theme by its ID.
|
|
4797
|
+
* @tags Themes
|
|
4798
|
+
* @name GetTheme
|
|
4799
|
+
* @summary Get Theme
|
|
4800
|
+
* @request GET:/themes/{theme_id}
|
|
4801
|
+
* @secure
|
|
4802
|
+
*/
|
|
4803
|
+
getTheme(themeId: number, query?: {
|
|
4804
|
+
/**
|
|
4805
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4806
|
+
* @default "en-US"
|
|
4807
|
+
*/
|
|
4808
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4809
|
+
/**
|
|
4810
|
+
* Include Filter
|
|
4811
|
+
* Include theme filters.
|
|
4812
|
+
* @default false
|
|
4813
|
+
*/
|
|
4814
|
+
include_filter?: boolean;
|
|
4815
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
4816
|
+
/**
|
|
4817
|
+
* @tags Themes
|
|
4818
|
+
* @name GetThemeFilters
|
|
4819
|
+
* @summary Get Theme Filters
|
|
4820
|
+
* @request GET:/themes/{theme_id}/filters
|
|
4821
|
+
* @secure
|
|
4822
|
+
*/
|
|
4823
|
+
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4824
|
+
}
|
|
4825
|
+
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4826
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4827
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4828
|
+
/**
|
|
4829
|
+
* @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.
|
|
4830
|
+
* @tags Fund Metadata
|
|
4831
|
+
* @name GetFunds
|
|
4832
|
+
* @summary Get Funds
|
|
4833
|
+
* @request GET:/funds
|
|
4834
|
+
* @secure
|
|
4835
|
+
*/
|
|
4836
|
+
getFunds(query?: {
|
|
4837
|
+
/**
|
|
4838
|
+
* Search
|
|
4839
|
+
* Funds search.
|
|
4840
|
+
*/
|
|
4841
|
+
search?: string;
|
|
4842
|
+
/**
|
|
4843
|
+
* Peers Of
|
|
4844
|
+
* Get peers funds of a specific fund.
|
|
4845
|
+
*/
|
|
4846
|
+
peers_of?: number;
|
|
4847
|
+
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
|
|
4848
|
+
sort_by?: BridgeWiseFundsSortByEnum;
|
|
4849
|
+
/**
|
|
4850
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4851
|
+
* @default "en-US"
|
|
4852
|
+
*/
|
|
4853
|
+
language?: BridgeWiseLanguageEnum;
|
|
4854
|
+
/**
|
|
4855
|
+
* Sponsor Id
|
|
4856
|
+
* Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
|
|
4857
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4858
|
+
*/
|
|
4859
|
+
sponsor_id?: string;
|
|
4860
|
+
/**
|
|
4861
|
+
* Vehicle Type
|
|
4862
|
+
* Desired vehicle type for the fund.
|
|
4863
|
+
*/
|
|
4864
|
+
vehicle_type?: string;
|
|
4865
|
+
/**
|
|
4866
|
+
* Management Style Id
|
|
4867
|
+
* Comma-separated unique identifiers of the management style for the fund. <br>Example: 9617760,9617759</br>
|
|
4868
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4869
|
+
*/
|
|
4870
|
+
management_style_id?: string;
|
|
4871
|
+
/**
|
|
4872
|
+
* Market Cap Emphasis Id
|
|
4873
|
+
* Comma-separated unique identifiers of market capitalization emphasis. <br>Example: 4072,4073</br>
|
|
4874
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4875
|
+
*/
|
|
4876
|
+
market_cap_emphasis_id?: string;
|
|
4877
|
+
/**
|
|
4878
|
+
* Sector Emphasis Id
|
|
4879
|
+
* Comma-separated unique identifiers of sector emphasis <br>Example: 50,60</br>.
|
|
4850
4880
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4851
4881
|
*/
|
|
4852
4882
|
sector_emphasis_id?: string;
|
|
@@ -5178,156 +5208,101 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
5178
5208
|
language?: BridgeWiseLanguageEnum;
|
|
5179
5209
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
5180
5210
|
}
|
|
5181
|
-
export class
|
|
5211
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5182
5212
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5183
5213
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5184
5214
|
/**
|
|
5185
|
-
* @description
|
|
5186
|
-
* @tags
|
|
5187
|
-
* @name
|
|
5188
|
-
* @summary Get
|
|
5189
|
-
* @request GET:/funds/{fund_id}/
|
|
5215
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5216
|
+
* @tags Fund ESG Analysis
|
|
5217
|
+
* @name GetFundEsgAnalysis
|
|
5218
|
+
* @summary Get Fund Esg Analysis
|
|
5219
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5190
5220
|
* @secure
|
|
5191
5221
|
*/
|
|
5192
|
-
|
|
5222
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5223
|
+
/**
|
|
5224
|
+
* Limit
|
|
5225
|
+
* Number of historical periods to be returned (default is 1).
|
|
5226
|
+
*/
|
|
5227
|
+
limit?: number;
|
|
5193
5228
|
/**
|
|
5194
5229
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5195
5230
|
* @default "en-US"
|
|
5196
5231
|
*/
|
|
5197
5232
|
language?: BridgeWiseLanguageEnum;
|
|
5198
|
-
|
|
5199
|
-
|
|
5200
|
-
|
|
5233
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5234
|
+
}
|
|
5235
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
5236
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5237
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5201
5238
|
/**
|
|
5202
|
-
* @description
|
|
5203
|
-
* @tags
|
|
5204
|
-
* @name
|
|
5205
|
-
* @summary Get
|
|
5206
|
-
* @request GET:/
|
|
5239
|
+
* @description This endpoint provides filters
|
|
5240
|
+
* @tags Metadata
|
|
5241
|
+
* @name GetCompanyFilters
|
|
5242
|
+
* @summary Get Company Filters
|
|
5243
|
+
* @request GET:/filters
|
|
5207
5244
|
* @secure
|
|
5208
5245
|
*/
|
|
5209
|
-
|
|
5246
|
+
getCompanyFilters(query: {
|
|
5247
|
+
/** Desired filter type. */
|
|
5248
|
+
type: BridgeWiseCompanyFilterType;
|
|
5210
5249
|
/**
|
|
5211
5250
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5212
5251
|
* @default "en-US"
|
|
5213
5252
|
*/
|
|
5214
5253
|
language?: BridgeWiseLanguageEnum;
|
|
5254
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
5255
|
+
}
|
|
5256
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5257
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5258
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5259
|
+
/**
|
|
5260
|
+
* @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.
|
|
5261
|
+
* @tags Segmentations
|
|
5262
|
+
* @name GetSegmentParameters
|
|
5263
|
+
* @summary Get Segment Parameters
|
|
5264
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5265
|
+
* @secure
|
|
5266
|
+
*/
|
|
5267
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5215
5268
|
/**
|
|
5216
|
-
*
|
|
5217
|
-
* @default "
|
|
5269
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5270
|
+
* @default "en-US"
|
|
5218
5271
|
*/
|
|
5219
|
-
|
|
5272
|
+
language?: BridgeWiseLanguageEnum;
|
|
5220
5273
|
/**
|
|
5221
|
-
*
|
|
5222
|
-
*
|
|
5223
|
-
* @exclusiveMin 0
|
|
5274
|
+
* Segment
|
|
5275
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5224
5276
|
*/
|
|
5225
|
-
|
|
5277
|
+
segment?: string;
|
|
5226
5278
|
/**
|
|
5227
|
-
*
|
|
5228
|
-
*
|
|
5229
|
-
* @exclusiveMin 0
|
|
5279
|
+
* Segment Type
|
|
5280
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5230
5281
|
*/
|
|
5231
|
-
|
|
5232
|
-
|
|
5282
|
+
segment_type?: string;
|
|
5283
|
+
/** Desired segment parameter type. */
|
|
5284
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5285
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5233
5286
|
/**
|
|
5234
|
-
* @description
|
|
5235
|
-
* @tags
|
|
5236
|
-
* @name
|
|
5237
|
-
* @summary Get
|
|
5238
|
-
* @request GET:/funds/{fund_id}/
|
|
5287
|
+
* @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.
|
|
5288
|
+
* @tags Segmentations
|
|
5289
|
+
* @name GetSegment
|
|
5290
|
+
* @summary Get Segment
|
|
5291
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5239
5292
|
* @secure
|
|
5240
5293
|
*/
|
|
5241
|
-
|
|
5294
|
+
getSegment(fundId: number, query?: {
|
|
5242
5295
|
/**
|
|
5243
5296
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5244
5297
|
* @default "en-US"
|
|
5245
5298
|
*/
|
|
5246
5299
|
language?: BridgeWiseLanguageEnum;
|
|
5247
5300
|
/**
|
|
5248
|
-
*
|
|
5249
|
-
*
|
|
5301
|
+
* Segment
|
|
5302
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5250
5303
|
*/
|
|
5251
|
-
|
|
5252
|
-
|
|
5253
|
-
* Page
|
|
5254
|
-
* Define the page number for pagination.
|
|
5255
|
-
* @exclusiveMin 0
|
|
5256
|
-
*/
|
|
5257
|
-
page?: number;
|
|
5258
|
-
/**
|
|
5259
|
-
* Page Size
|
|
5260
|
-
* Define the number of records per page for pagination purposes.
|
|
5261
|
-
* @exclusiveMin 0
|
|
5262
|
-
*/
|
|
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"
|
|
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;
|
|
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>>;
|
|
5304
|
+
segment?: string;
|
|
5305
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5331
5306
|
}
|
|
5332
5307
|
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5333
5308
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5363,140 +5338,58 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
|
5363
5338
|
limit?: number;
|
|
5364
5339
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
5365
5340
|
}
|
|
5366
|
-
export class
|
|
5367
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5368
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5369
|
-
/**
|
|
5370
|
-
* @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.
|
|
5371
|
-
* @tags Segmentations
|
|
5372
|
-
* @name GetSegmentParameters
|
|
5373
|
-
* @summary Get Segment Parameters
|
|
5374
|
-
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5375
|
-
* @secure
|
|
5376
|
-
*/
|
|
5377
|
-
getSegmentParameters(fundId: number, query?: {
|
|
5378
|
-
/**
|
|
5379
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5380
|
-
* @default "en-US"
|
|
5381
|
-
*/
|
|
5382
|
-
language?: BridgeWiseLanguageEnum;
|
|
5383
|
-
/**
|
|
5384
|
-
* Segment
|
|
5385
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5386
|
-
*/
|
|
5387
|
-
segment?: string;
|
|
5388
|
-
/**
|
|
5389
|
-
* Segment Type
|
|
5390
|
-
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5391
|
-
*/
|
|
5392
|
-
segment_type?: string;
|
|
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?: {
|
|
5405
|
-
/**
|
|
5406
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5407
|
-
* @default "en-US"
|
|
5408
|
-
*/
|
|
5409
|
-
language?: BridgeWiseLanguageEnum;
|
|
5410
|
-
/**
|
|
5411
|
-
* Segment
|
|
5412
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5413
|
-
*/
|
|
5414
|
-
segment?: string;
|
|
5415
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5416
|
-
}
|
|
5417
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
5341
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
5418
5342
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5419
5343
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5420
5344
|
/**
|
|
5421
|
-
* @
|
|
5422
|
-
* @
|
|
5423
|
-
* @
|
|
5424
|
-
* @
|
|
5425
|
-
* @request GET:/companies/{company_id}/technical-analysis
|
|
5345
|
+
* @tags Tenants
|
|
5346
|
+
* @name FetchTenant
|
|
5347
|
+
* @summary Fetch Tenant
|
|
5348
|
+
* @request GET:/tenants/{tenant_id}
|
|
5426
5349
|
* @secure
|
|
5427
5350
|
*/
|
|
5428
|
-
|
|
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>>;
|
|
5351
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
5440
5352
|
/**
|
|
5441
|
-
* @
|
|
5442
|
-
* @
|
|
5443
|
-
* @
|
|
5444
|
-
* @
|
|
5445
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
5353
|
+
* @tags Tenants
|
|
5354
|
+
* @name GetHistoricalPolicyChanges
|
|
5355
|
+
* @summary Get Historical Policy Changes
|
|
5356
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
5446
5357
|
* @secure
|
|
5447
5358
|
*/
|
|
5448
|
-
|
|
5359
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
5449
5360
|
/**
|
|
5450
|
-
*
|
|
5451
|
-
*
|
|
5361
|
+
* Company Ids
|
|
5362
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5363
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5364
|
+
* @example "74822,83343211"
|
|
5452
5365
|
*/
|
|
5453
|
-
|
|
5366
|
+
company_ids?: string;
|
|
5454
5367
|
/**
|
|
5455
|
-
*
|
|
5456
|
-
* Specify
|
|
5368
|
+
* Start Date Gte
|
|
5369
|
+
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5370
|
+
* @format date
|
|
5457
5371
|
*/
|
|
5458
|
-
|
|
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?: {
|
|
5372
|
+
start_date__gte?: string;
|
|
5469
5373
|
/**
|
|
5470
|
-
*
|
|
5471
|
-
*
|
|
5374
|
+
* End Date Lte
|
|
5375
|
+
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5376
|
+
* @format date
|
|
5472
5377
|
*/
|
|
5473
|
-
|
|
5378
|
+
end_date__lte?: string;
|
|
5474
5379
|
/**
|
|
5475
|
-
*
|
|
5476
|
-
* Specify
|
|
5380
|
+
* Current Value
|
|
5381
|
+
* Specify the current value reflecting the policy change
|
|
5477
5382
|
*/
|
|
5478
|
-
|
|
5383
|
+
current_value?: number | boolean;
|
|
5384
|
+
/** Type of event that is being requested. */
|
|
5385
|
+
event_type?: BridgeWiseEventTypeEnum;
|
|
5479
5386
|
/**
|
|
5480
|
-
*
|
|
5481
|
-
*
|
|
5387
|
+
* Size
|
|
5388
|
+
* Define the maximum number of results to retrieve.
|
|
5389
|
+
* @default 10
|
|
5390
|
+
* @example 10
|
|
5482
5391
|
*/
|
|
5483
|
-
|
|
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;
|
|
5392
|
+
size?: number;
|
|
5500
5393
|
/**
|
|
5501
5394
|
* Page
|
|
5502
5395
|
* Define the page number for the results.
|
|
@@ -5504,110 +5397,15 @@ export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
|
5504
5397
|
* @example 1
|
|
5505
5398
|
*/
|
|
5506
5399
|
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>>;
|
|
5400
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
5515
5401
|
/**
|
|
5516
|
-
* @
|
|
5517
|
-
* @
|
|
5518
|
-
* @
|
|
5519
|
-
* @
|
|
5520
|
-
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5402
|
+
* @tags Tenants
|
|
5403
|
+
* @name CreateTenantInvestmentPoliciesConfig
|
|
5404
|
+
* @summary Create Tenant Investment Policies Config
|
|
5405
|
+
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
5521
5406
|
* @secure
|
|
5522
5407
|
*/
|
|
5523
|
-
|
|
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
|
|
5593
|
-
*/
|
|
5594
|
-
size?: number;
|
|
5595
|
-
/**
|
|
5596
|
-
* Page
|
|
5597
|
-
* Define the page number for the results.
|
|
5598
|
-
* @default 1
|
|
5599
|
-
* @example 1
|
|
5600
|
-
*/
|
|
5601
|
-
page?: number;
|
|
5602
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
5603
|
-
/**
|
|
5604
|
-
* @tags Tenants
|
|
5605
|
-
* @name CreateTenantInvestmentPoliciesConfig
|
|
5606
|
-
* @summary Create Tenant Investment Policies Config
|
|
5607
|
-
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
5608
|
-
* @secure
|
|
5609
|
-
*/
|
|
5610
|
-
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
5408
|
+
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
5611
5409
|
/**
|
|
5612
5410
|
* @tags Tenants
|
|
5613
5411
|
* @name ListTenantInvestmentPoliciesConfigs
|
|
@@ -5713,146 +5511,348 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
5713
5511
|
*/
|
|
5714
5512
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5715
5513
|
}
|
|
5716
|
-
export class
|
|
5514
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5717
5515
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5718
5516
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5719
5517
|
/**
|
|
5720
|
-
* @description
|
|
5721
|
-
* @tags
|
|
5722
|
-
* @name
|
|
5723
|
-
* @summary Get
|
|
5724
|
-
* @request GET:/
|
|
5518
|
+
* @description Get list of tenant identifiers
|
|
5519
|
+
* @tags Tenant Identifiers
|
|
5520
|
+
* @name GetTenantIdentifiers
|
|
5521
|
+
* @summary Get Tenant Identifiers
|
|
5522
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5725
5523
|
* @secure
|
|
5726
5524
|
*/
|
|
5727
|
-
|
|
5525
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
5526
|
+
/** Tenant custom identifier status. */
|
|
5527
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5728
5528
|
/**
|
|
5729
|
-
*
|
|
5730
|
-
*
|
|
5731
|
-
* @default
|
|
5529
|
+
* Page
|
|
5530
|
+
* Define the page number for the results.
|
|
5531
|
+
* @default 1
|
|
5532
|
+
* @example 1
|
|
5732
5533
|
*/
|
|
5733
|
-
|
|
5534
|
+
page?: number;
|
|
5535
|
+
/**
|
|
5536
|
+
* Page Size
|
|
5537
|
+
* Define the maximum number of results to retrieve.
|
|
5538
|
+
* @default 20
|
|
5539
|
+
* @example 10
|
|
5540
|
+
*/
|
|
5541
|
+
page_size?: number;
|
|
5542
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5543
|
+
/**
|
|
5544
|
+
* @description Create a new identifier for a tenant
|
|
5545
|
+
* @tags Tenant Identifiers
|
|
5546
|
+
* @name CreateTenantIdentifier
|
|
5547
|
+
* @summary Create Tenant Identifier
|
|
5548
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5549
|
+
* @secure
|
|
5550
|
+
*/
|
|
5551
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5552
|
+
/**
|
|
5553
|
+
* @description Update an existing identifier for a tenant
|
|
5554
|
+
* @tags Tenant Identifiers
|
|
5555
|
+
* @name UpdateTenantIdentifier
|
|
5556
|
+
* @summary Update Tenant Identifier
|
|
5557
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5558
|
+
* @secure
|
|
5559
|
+
*/
|
|
5560
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5561
|
+
/**
|
|
5562
|
+
* @description Delete identifier for a tenant
|
|
5563
|
+
* @tags Tenant Identifiers
|
|
5564
|
+
* @name DeleteTenantIdentifier
|
|
5565
|
+
* @summary Delete Tenant Identifier
|
|
5566
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5567
|
+
* @secure
|
|
5568
|
+
*/
|
|
5569
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5570
|
+
}
|
|
5571
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5572
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5573
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5574
|
+
/**
|
|
5575
|
+
* @tags Users
|
|
5576
|
+
* @name Authenticate
|
|
5577
|
+
* @summary Authenticate
|
|
5578
|
+
* @request POST:/users/authenticate
|
|
5579
|
+
* @secure
|
|
5580
|
+
*/
|
|
5581
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5582
|
+
/**
|
|
5583
|
+
* @tags Users
|
|
5584
|
+
* @name FetchClientDetails
|
|
5585
|
+
* @summary Fetch Client Details
|
|
5586
|
+
* @request GET:/users/machine
|
|
5587
|
+
* @secure
|
|
5588
|
+
*/
|
|
5589
|
+
fetchClientDetails(headers: {
|
|
5590
|
+
/** Authorization */
|
|
5591
|
+
authorization: string;
|
|
5592
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5593
|
+
}
|
|
5594
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5595
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5596
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5597
|
+
/**
|
|
5598
|
+
* @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.
|
|
5599
|
+
* @tags Holdings
|
|
5600
|
+
* @name GetCompositions
|
|
5601
|
+
* @summary Get Compositions
|
|
5602
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
5603
|
+
* @secure
|
|
5604
|
+
*/
|
|
5605
|
+
getCompositions(fundId: number, query?: {
|
|
5734
5606
|
/**
|
|
5735
5607
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5736
5608
|
* @default "en-US"
|
|
5737
5609
|
*/
|
|
5738
|
-
language?:
|
|
5739
|
-
/** Filter
|
|
5740
|
-
|
|
5741
|
-
|
|
5742
|
-
|
|
5743
|
-
|
|
5744
|
-
|
|
5610
|
+
language?: BridgeWiseLanguageEnum;
|
|
5611
|
+
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5612
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5613
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5614
|
+
/**
|
|
5615
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5616
|
+
* @tags Holdings
|
|
5617
|
+
* @name GetHoldingStatistics
|
|
5618
|
+
* @summary Get Holding Statistics
|
|
5619
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5620
|
+
* @secure
|
|
5621
|
+
*/
|
|
5622
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
5623
|
+
/**
|
|
5624
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5625
|
+
* @default "en-US"
|
|
5626
|
+
*/
|
|
5627
|
+
language?: BridgeWiseLanguageEnum;
|
|
5628
|
+
/**
|
|
5629
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5630
|
+
* @default "stocks"
|
|
5631
|
+
*/
|
|
5632
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5745
5633
|
/**
|
|
5746
5634
|
* Page
|
|
5747
5635
|
* Define the page number for pagination.
|
|
5748
|
-
* @
|
|
5749
|
-
* @default 1
|
|
5636
|
+
* @exclusiveMin 0
|
|
5750
5637
|
*/
|
|
5751
5638
|
page?: number;
|
|
5752
5639
|
/**
|
|
5753
5640
|
* Page Size
|
|
5754
5641
|
* Define the number of records per page for pagination purposes.
|
|
5755
|
-
* @
|
|
5756
|
-
* @default 10
|
|
5642
|
+
* @exclusiveMin 0
|
|
5757
5643
|
*/
|
|
5758
5644
|
page_size?: number;
|
|
5759
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5645
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
5760
5646
|
/**
|
|
5761
|
-
* @description
|
|
5762
|
-
* @tags
|
|
5763
|
-
* @name
|
|
5764
|
-
* @summary Get
|
|
5765
|
-
* @request GET:/
|
|
5647
|
+
* @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.
|
|
5648
|
+
* @tags Holdings
|
|
5649
|
+
* @name GetHoldings
|
|
5650
|
+
* @summary Get Holdings
|
|
5651
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
5766
5652
|
* @secure
|
|
5767
5653
|
*/
|
|
5768
|
-
|
|
5769
|
-
/**
|
|
5770
|
-
* Search
|
|
5771
|
-
* Search string to filter themes by name or description.
|
|
5772
|
-
*/
|
|
5773
|
-
search?: string | null;
|
|
5774
|
-
/**
|
|
5775
|
-
* Sort By
|
|
5776
|
-
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5777
|
-
* @default "rank"
|
|
5778
|
-
*/
|
|
5779
|
-
sort_by?: string;
|
|
5654
|
+
getHoldings(fundId: number, query?: {
|
|
5780
5655
|
/**
|
|
5781
5656
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5782
5657
|
* @default "en-US"
|
|
5783
5658
|
*/
|
|
5784
|
-
language?:
|
|
5785
|
-
/**
|
|
5786
|
-
|
|
5787
|
-
|
|
5788
|
-
|
|
5659
|
+
language?: BridgeWiseLanguageEnum;
|
|
5660
|
+
/**
|
|
5661
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5662
|
+
* @default "stocks"
|
|
5663
|
+
*/
|
|
5664
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5789
5665
|
/**
|
|
5790
5666
|
* Page
|
|
5791
5667
|
* Define the page number for pagination.
|
|
5792
|
-
* @
|
|
5793
|
-
* @default 1
|
|
5668
|
+
* @exclusiveMin 0
|
|
5794
5669
|
*/
|
|
5795
5670
|
page?: number;
|
|
5796
5671
|
/**
|
|
5797
5672
|
* Page Size
|
|
5798
5673
|
* Define the number of records per page for pagination purposes.
|
|
5799
|
-
* @
|
|
5800
|
-
* @default 10
|
|
5674
|
+
* @exclusiveMin 0
|
|
5801
5675
|
*/
|
|
5802
5676
|
page_size?: number;
|
|
5803
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5677
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
5678
|
+
}
|
|
5679
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5680
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5681
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5804
5682
|
/**
|
|
5805
|
-
* @description
|
|
5806
|
-
* @tags
|
|
5807
|
-
* @name
|
|
5808
|
-
* @summary Get
|
|
5809
|
-
* @request GET:/
|
|
5683
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5684
|
+
* @tags Fund Market Data
|
|
5685
|
+
* @name GetFundsMarketData
|
|
5686
|
+
* @summary Get Funds Market Data
|
|
5687
|
+
* @request GET:/funds/{fund_id}/market
|
|
5810
5688
|
* @secure
|
|
5811
5689
|
*/
|
|
5812
|
-
|
|
5690
|
+
getFundsMarketData(fundId: number, query?: {
|
|
5813
5691
|
/**
|
|
5814
|
-
*
|
|
5815
|
-
*
|
|
5692
|
+
* Trading Item Id
|
|
5693
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5816
5694
|
*/
|
|
5817
|
-
|
|
5695
|
+
trading_item_id?: number | null;
|
|
5818
5696
|
/**
|
|
5819
|
-
*
|
|
5820
|
-
*
|
|
5821
|
-
* @default false
|
|
5697
|
+
* Date Ge
|
|
5698
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5822
5699
|
*/
|
|
5823
|
-
|
|
5824
|
-
|
|
5700
|
+
date__ge?: string | null;
|
|
5701
|
+
/**
|
|
5702
|
+
* Date Le
|
|
5703
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5704
|
+
*/
|
|
5705
|
+
date__le?: string | null;
|
|
5706
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5825
5707
|
/**
|
|
5826
|
-
* @
|
|
5827
|
-
* @
|
|
5828
|
-
* @
|
|
5829
|
-
* @
|
|
5708
|
+
* @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.
|
|
5709
|
+
* @tags Fund Market Data
|
|
5710
|
+
* @name GetFundsMarketStatistics
|
|
5711
|
+
* @summary Get Funds Market Statistics
|
|
5712
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
5830
5713
|
* @secure
|
|
5831
5714
|
*/
|
|
5832
|
-
|
|
5715
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
5716
|
+
/**
|
|
5717
|
+
* Trading Item Id
|
|
5718
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5719
|
+
*/
|
|
5720
|
+
trading_item_id?: number | null;
|
|
5721
|
+
/**
|
|
5722
|
+
* Identifier In
|
|
5723
|
+
* Specify a list of external identifiers.
|
|
5724
|
+
*/
|
|
5725
|
+
identifier__in?: string | null;
|
|
5726
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5727
|
+
/**
|
|
5728
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5729
|
+
* @tags Fund Market Data
|
|
5730
|
+
* @name GetFundTradingItems
|
|
5731
|
+
* @summary Get Fund Trading Items
|
|
5732
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
5733
|
+
* @secure
|
|
5734
|
+
*/
|
|
5735
|
+
getFundTradingItems(fundId: number, query?: {
|
|
5736
|
+
/**
|
|
5737
|
+
* Primary Flag
|
|
5738
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5739
|
+
*/
|
|
5740
|
+
primary_flag?: boolean;
|
|
5741
|
+
/**
|
|
5742
|
+
* Security Primary Flag
|
|
5743
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
5744
|
+
*/
|
|
5745
|
+
security_primary_flag?: boolean;
|
|
5746
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5833
5747
|
}
|
|
5834
|
-
export class
|
|
5748
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
5835
5749
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5836
5750
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5837
5751
|
/**
|
|
5838
|
-
* @
|
|
5839
|
-
* @
|
|
5840
|
-
* @
|
|
5841
|
-
* @
|
|
5752
|
+
* @description Returns Bridgewise final analysis for a specified fund.
|
|
5753
|
+
* @tags Fund Analysis
|
|
5754
|
+
* @name GetFundAnalysis
|
|
5755
|
+
* @summary Get Fund Analysis
|
|
5756
|
+
* @request GET:/funds/{fund_id}/analysis
|
|
5842
5757
|
* @secure
|
|
5843
5758
|
*/
|
|
5844
|
-
|
|
5759
|
+
getFundAnalysis(fundId: number, query?: {
|
|
5760
|
+
/**
|
|
5761
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5762
|
+
* @default "en-US"
|
|
5763
|
+
*/
|
|
5764
|
+
language?: BridgeWiseLanguageEnum;
|
|
5765
|
+
/**
|
|
5766
|
+
* Year
|
|
5767
|
+
* Specify the year for which the analysis is requested.
|
|
5768
|
+
*/
|
|
5769
|
+
year?: number;
|
|
5770
|
+
/**
|
|
5771
|
+
* Quarter
|
|
5772
|
+
* Specify the quarter for which the analysis is requested.
|
|
5773
|
+
*/
|
|
5774
|
+
quarter?: number;
|
|
5775
|
+
/**
|
|
5776
|
+
* Show All
|
|
5777
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5778
|
+
*/
|
|
5779
|
+
show_all?: boolean;
|
|
5780
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
5845
5781
|
/**
|
|
5846
|
-
* @
|
|
5847
|
-
* @
|
|
5848
|
-
* @
|
|
5849
|
-
* @
|
|
5782
|
+
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
5783
|
+
* @tags Fund Analysis
|
|
5784
|
+
* @name GetFundsParagraphs
|
|
5785
|
+
* @summary Get Funds Paragraphs
|
|
5786
|
+
* @request GET:/funds/{fund_id}/paragraphs
|
|
5850
5787
|
* @secure
|
|
5851
5788
|
*/
|
|
5852
|
-
|
|
5853
|
-
/**
|
|
5854
|
-
|
|
5855
|
-
|
|
5789
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
5790
|
+
/**
|
|
5791
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5792
|
+
* @default "en-US"
|
|
5793
|
+
*/
|
|
5794
|
+
language?: BridgeWiseLanguageEnum;
|
|
5795
|
+
/**
|
|
5796
|
+
* Year
|
|
5797
|
+
* Specify the year for which the analysis is requested.
|
|
5798
|
+
*/
|
|
5799
|
+
year?: number | null;
|
|
5800
|
+
/**
|
|
5801
|
+
* Quarter
|
|
5802
|
+
* Specify the quarter for which the analysis is requested.
|
|
5803
|
+
*/
|
|
5804
|
+
quarter?: number | null;
|
|
5805
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
5806
|
+
/**
|
|
5807
|
+
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
5808
|
+
* @tags Fund Analysis
|
|
5809
|
+
* @name GetFundParameters
|
|
5810
|
+
* @summary Get Fund Parameters
|
|
5811
|
+
* @request GET:/funds/{fund_id}/parameters
|
|
5812
|
+
* @secure
|
|
5813
|
+
*/
|
|
5814
|
+
getFundParameters(fundId: number, query?: {
|
|
5815
|
+
/**
|
|
5816
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5817
|
+
* @default "en-US"
|
|
5818
|
+
*/
|
|
5819
|
+
language?: BridgeWiseLanguageEnum;
|
|
5820
|
+
/**
|
|
5821
|
+
* Parameter Id
|
|
5822
|
+
* ID of the parameter for analysis.
|
|
5823
|
+
*/
|
|
5824
|
+
parameter_id?: number;
|
|
5825
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
5826
|
+
/**
|
|
5827
|
+
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
5828
|
+
* @tags Fund Analysis
|
|
5829
|
+
* @name GetFundSections
|
|
5830
|
+
* @summary Get Fund Sections
|
|
5831
|
+
* @request GET:/funds/{fund_id}/sections
|
|
5832
|
+
* @secure
|
|
5833
|
+
*/
|
|
5834
|
+
getFundSections(fundId: number, query?: {
|
|
5835
|
+
/**
|
|
5836
|
+
* Year
|
|
5837
|
+
* Specify the year for which the analysis is requested.
|
|
5838
|
+
*/
|
|
5839
|
+
year?: number;
|
|
5840
|
+
/**
|
|
5841
|
+
* Quarter
|
|
5842
|
+
* Specify the quarter for which the analysis is requested.
|
|
5843
|
+
*/
|
|
5844
|
+
quarter?: number;
|
|
5845
|
+
/**
|
|
5846
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5847
|
+
* @default "en-US"
|
|
5848
|
+
*/
|
|
5849
|
+
language?: BridgeWiseLanguageEnum;
|
|
5850
|
+
/**
|
|
5851
|
+
* Show All
|
|
5852
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5853
|
+
*/
|
|
5854
|
+
show_all?: boolean;
|
|
5855
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
5856
5856
|
}
|
|
5857
5857
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5858
5858
|
readonly config: JwtClientConfig<HandleError>;
|