@orbis-systems/orbis-api-clients 0.8.8 → 0.8.9
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 +43 -28
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +592 -592
- 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 +104 -104
- 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.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 +1274 -1274
- 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 +637 -637
- 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/package.json +1 -1
|
@@ -4114,253 +4114,6 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
4114
4114
|
Iso = "iso",
|
|
4115
4115
|
Epoch = "epoch"
|
|
4116
4116
|
}
|
|
4117
|
-
export class AlternativeAssets<HandleError extends boolean = boolean> {
|
|
4118
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4119
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4120
|
-
/**
|
|
4121
|
-
* @description Returns a asset profile data for a supported asset.
|
|
4122
|
-
* @tags Alternative Assets
|
|
4123
|
-
* @name GetAlternative
|
|
4124
|
-
* @summary Get Alternative
|
|
4125
|
-
* @request GET:/alternative-assets/{asset_id}
|
|
4126
|
-
* @secure
|
|
4127
|
-
*/
|
|
4128
|
-
getAlternative(assetId: number, query?: {
|
|
4129
|
-
/**
|
|
4130
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4131
|
-
* @default "en-US"
|
|
4132
|
-
*/
|
|
4133
|
-
language?: BridgeWiseLanguageEnum;
|
|
4134
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMetadata, HandleError>>;
|
|
4135
|
-
/**
|
|
4136
|
-
* @description Offers key market data for the specified alternative asset, including daily high, open, low, close prices, and market capitalization.
|
|
4137
|
-
* @tags Alternative Assets
|
|
4138
|
-
* @name GetAlternativesMarketData
|
|
4139
|
-
* @summary Get Alternatives Market Data
|
|
4140
|
-
* @request GET:/alternative-assets/{asset_id}/market
|
|
4141
|
-
* @secure
|
|
4142
|
-
*/
|
|
4143
|
-
getAlternativesMarketData(assetId: number, query?: {
|
|
4144
|
-
/**
|
|
4145
|
-
* Date Ge
|
|
4146
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4147
|
-
*/
|
|
4148
|
-
date__ge?: string | null;
|
|
4149
|
-
/**
|
|
4150
|
-
* Date Le
|
|
4151
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4152
|
-
*/
|
|
4153
|
-
date__le?: string | null;
|
|
4154
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketDataList, HandleError>>;
|
|
4155
|
-
/**
|
|
4156
|
-
* @description Provides detailed market statistics for the specified alternative asset, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4157
|
-
* @tags Alternative Assets
|
|
4158
|
-
* @name GetAlternativesMarketStatistics
|
|
4159
|
-
* @summary Get Alternatives Market Statistics
|
|
4160
|
-
* @request GET:/alternative-assets/{asset_id}/market-statistics
|
|
4161
|
-
* @secure
|
|
4162
|
-
*/
|
|
4163
|
-
getAlternativesMarketStatistics(assetId: number, query?: {
|
|
4164
|
-
/**
|
|
4165
|
-
* Trading Item Id
|
|
4166
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4167
|
-
*/
|
|
4168
|
-
trading_item_id?: number | null;
|
|
4169
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketStatisticsList, HandleError>>;
|
|
4170
|
-
/**
|
|
4171
|
-
* @description Return aggregated news articles for a supported alternative asset (crypto, forex, commodity), using the same data pipeline and response schema as the existing companies news endpoint (NewsAPI-backed).
|
|
4172
|
-
* @tags Alternative Assets
|
|
4173
|
-
* @name GetAlternativeNews
|
|
4174
|
-
* @summary Get Alternative News
|
|
4175
|
-
* @request GET:/alternative-assets/{asset_id}/news
|
|
4176
|
-
* @secure
|
|
4177
|
-
*/
|
|
4178
|
-
getAlternativeNews(assetId: number, query?: {
|
|
4179
|
-
/**
|
|
4180
|
-
* Languages
|
|
4181
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4182
|
-
* @default "en-US"
|
|
4183
|
-
* @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))*$
|
|
4184
|
-
*/
|
|
4185
|
-
languages?: string;
|
|
4186
|
-
/**
|
|
4187
|
-
* Published Date Gte
|
|
4188
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4189
|
-
* @format date
|
|
4190
|
-
* @default "2025-12-07"
|
|
4191
|
-
*/
|
|
4192
|
-
published_date__gte?: string;
|
|
4193
|
-
/**
|
|
4194
|
-
* Published Date Lte
|
|
4195
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4196
|
-
* @format date
|
|
4197
|
-
* @default "2025-12-07"
|
|
4198
|
-
*/
|
|
4199
|
-
published_date__lte?: string;
|
|
4200
|
-
/**
|
|
4201
|
-
* Specify the field by which to sort the results.
|
|
4202
|
-
* @default "publication_date"
|
|
4203
|
-
*/
|
|
4204
|
-
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4205
|
-
/**
|
|
4206
|
-
* Size
|
|
4207
|
-
* Define the number of records per page for pagination purposes.
|
|
4208
|
-
* @default 10
|
|
4209
|
-
* @example 10
|
|
4210
|
-
*/
|
|
4211
|
-
size?: number;
|
|
4212
|
-
/**
|
|
4213
|
-
* Page
|
|
4214
|
-
* Define the page number for pagination.
|
|
4215
|
-
* @default 1
|
|
4216
|
-
* @example 1
|
|
4217
|
-
*/
|
|
4218
|
-
page?: number;
|
|
4219
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4220
|
-
/**
|
|
4221
|
-
* @description Return a daily-updated sentiment score for a supported alternative asset (crypto, forex, commodity) based on news from the past 7 days.
|
|
4222
|
-
* @tags Alternative Assets
|
|
4223
|
-
* @name GetAverageAlternativeNewsSentiment
|
|
4224
|
-
* @summary Get Average Alternative News Sentiment
|
|
4225
|
-
* @request GET:/alternative-assets/{asset_id}/news-sentiment
|
|
4226
|
-
* @secure
|
|
4227
|
-
*/
|
|
4228
|
-
getAverageAlternativeNewsSentiment(assetId: number, query?: {
|
|
4229
|
-
/**
|
|
4230
|
-
* Published Date Gte
|
|
4231
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4232
|
-
* @format date
|
|
4233
|
-
* @default "2025-12-07"
|
|
4234
|
-
*/
|
|
4235
|
-
published_date__gte?: string;
|
|
4236
|
-
/**
|
|
4237
|
-
* Published Date Lte
|
|
4238
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4239
|
-
* @format date
|
|
4240
|
-
* @default "2025-12-07"
|
|
4241
|
-
*/
|
|
4242
|
-
published_date__lte?: string;
|
|
4243
|
-
/**
|
|
4244
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4245
|
-
* @default "en-US"
|
|
4246
|
-
*/
|
|
4247
|
-
language?: BridgeWiseLanguageEnum;
|
|
4248
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4249
|
-
/**
|
|
4250
|
-
* @description `section_type='description' ->` Returns a static asset description (as ordered paragraphs) for a supported asset. `section_type='news-summary' ->` Returns an LLM-generated news summary for a supported alternative asset (crypto, forex, commodity) over a recent window (default: past 7 days), including 100–300 word overview, 3–5 highlights (positives), 3–5 lowlights (negatives), and metadata. Output is refreshed daily.`section_type='technical' ->` Paragraph reflects the most recent technical analysis rating and the relevant parameter sentiments.
|
|
4251
|
-
* @tags Alternative Assets
|
|
4252
|
-
* @name GetAlternativesParagraphs
|
|
4253
|
-
* @summary Get Alternatives Paragraphs
|
|
4254
|
-
* @request GET:/alternative-assets/{asset_id}/paragraphs
|
|
4255
|
-
* @secure
|
|
4256
|
-
*/
|
|
4257
|
-
getAlternativesParagraphs(assetId: number, query?: {
|
|
4258
|
-
/**
|
|
4259
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4260
|
-
* @default "en-US"
|
|
4261
|
-
*/
|
|
4262
|
-
language?: BridgeWiseLanguageEnum;
|
|
4263
|
-
/**
|
|
4264
|
-
* Section Type
|
|
4265
|
-
* Specify the component of the text paragraph (e.g., `description`, `technical`, `news_summary`).
|
|
4266
|
-
* @default "description"
|
|
4267
|
-
*/
|
|
4268
|
-
section_type?: BridgeWiseParagraphTextEnum | null;
|
|
4269
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetParagraph | BridgeWiseAssetLLMNewsParagraph | BridgeWiseAssetLLMTechnicalParagraph, HandleError>>;
|
|
4270
|
-
/**
|
|
4271
|
-
* @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.
|
|
4272
|
-
* @tags Alternative Assets
|
|
4273
|
-
* @name GetAltTechnicalAnalysis
|
|
4274
|
-
* @summary Get Alt Technical Analysis
|
|
4275
|
-
* @request GET:/alternative-assets/{asset_id}/technical-analysis
|
|
4276
|
-
* @secure
|
|
4277
|
-
*/
|
|
4278
|
-
getAltTechnicalAnalysis(assetId: number, query?: {
|
|
4279
|
-
/**
|
|
4280
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4281
|
-
* @default "en-US"
|
|
4282
|
-
*/
|
|
4283
|
-
language?: BridgeWiseLanguageEnum;
|
|
4284
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkAlterModelsTechAnalysisItem, HandleError>>;
|
|
4285
|
-
/**
|
|
4286
|
-
* @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.
|
|
4287
|
-
* @tags Alternative Assets
|
|
4288
|
-
* @name GetAltTechnicalParameters
|
|
4289
|
-
* @summary Get Alt Technical Parameters
|
|
4290
|
-
* @request GET:/alternative-assets/{asset_id}/technical-parameters
|
|
4291
|
-
* @secure
|
|
4292
|
-
*/
|
|
4293
|
-
getAltTechnicalParameters(assetId: number, query?: {
|
|
4294
|
-
/**
|
|
4295
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4296
|
-
* @default "en-US"
|
|
4297
|
-
*/
|
|
4298
|
-
language?: BridgeWiseLanguageEnum;
|
|
4299
|
-
/**
|
|
4300
|
-
* Parameter Id
|
|
4301
|
-
* Get desired parameter by ID.
|
|
4302
|
-
*/
|
|
4303
|
-
parameter_id?: number;
|
|
4304
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetTechParameterItemList, HandleError>>;
|
|
4305
|
-
}
|
|
4306
|
-
export class Alerts<HandleError extends boolean = boolean> {
|
|
4307
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4308
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4309
|
-
/**
|
|
4310
|
-
* @description Get alerts with optional inclusion of related resources
|
|
4311
|
-
* @tags Alerts
|
|
4312
|
-
* @name GetAlerts
|
|
4313
|
-
* @summary Get Alerts
|
|
4314
|
-
* @request GET:/alerts
|
|
4315
|
-
* @secure
|
|
4316
|
-
*/
|
|
4317
|
-
getAlerts(query?: {
|
|
4318
|
-
/** @default "en-US" */
|
|
4319
|
-
language?: BridgeWiseAlertLanguagesEnum;
|
|
4320
|
-
/** Date Gte */
|
|
4321
|
-
date__gte?: string | null;
|
|
4322
|
-
/** Date Lte */
|
|
4323
|
-
date__lte?: string | null;
|
|
4324
|
-
/** Sentiment */
|
|
4325
|
-
sentiment?: BridgeWiseEventSentimentEnum | null;
|
|
4326
|
-
/** Importance Level */
|
|
4327
|
-
importance_level?: number | null;
|
|
4328
|
-
/** Alert Type */
|
|
4329
|
-
alert_type?: BridgeWiseAlertTypeEnum | null;
|
|
4330
|
-
/**
|
|
4331
|
-
* Limit
|
|
4332
|
-
* @default 10
|
|
4333
|
-
*/
|
|
4334
|
-
limit?: number;
|
|
4335
|
-
/**
|
|
4336
|
-
* Offset
|
|
4337
|
-
* @default 0
|
|
4338
|
-
*/
|
|
4339
|
-
offset?: number;
|
|
4340
|
-
/** Asset Type */
|
|
4341
|
-
asset_type?: BridgeWiseAssetTypeEnum | null;
|
|
4342
|
-
/** Ticker Exchange */
|
|
4343
|
-
ticker_exchange?: string | null;
|
|
4344
|
-
/** Ticker Symbol */
|
|
4345
|
-
ticker_symbol?: string | null;
|
|
4346
|
-
/** Include */
|
|
4347
|
-
include?: string | null;
|
|
4348
|
-
/** Company Id */
|
|
4349
|
-
company_id?: string | null;
|
|
4350
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlert[], HandleError>>;
|
|
4351
|
-
/**
|
|
4352
|
-
* @description Get reasons for a specific alert by alert ID.
|
|
4353
|
-
* @tags Alerts
|
|
4354
|
-
* @name GetAlertReasons
|
|
4355
|
-
* @summary Get Alert Reasons
|
|
4356
|
-
* @request GET:/alerts/{alert_id}/reasons
|
|
4357
|
-
* @secure
|
|
4358
|
-
*/
|
|
4359
|
-
getAlertReasons(alertId: string, query?: {
|
|
4360
|
-
/** @default "en-US" */
|
|
4361
|
-
language?: BridgeWiseAlertLanguagesEnum;
|
|
4362
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlertReason[], HandleError>>;
|
|
4363
|
-
}
|
|
4364
4117
|
export class Bonds<HandleError extends boolean = boolean> {
|
|
4365
4118
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4366
4119
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4851,17 +4604,206 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
4851
4604
|
identifier: string;
|
|
4852
4605
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
4853
4606
|
}
|
|
4854
|
-
export class
|
|
4607
|
+
export class AlternativeAssets<HandleError extends boolean = boolean> {
|
|
4855
4608
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4856
4609
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4857
4610
|
/**
|
|
4858
|
-
* @description
|
|
4859
|
-
* @tags
|
|
4860
|
-
* @name
|
|
4861
|
-
* @summary Get
|
|
4862
|
-
* @request GET:/
|
|
4863
|
-
* @secure
|
|
4864
|
-
*/
|
|
4611
|
+
* @description Returns a asset profile data for a supported asset.
|
|
4612
|
+
* @tags Alternative Assets
|
|
4613
|
+
* @name GetAlternative
|
|
4614
|
+
* @summary Get Alternative
|
|
4615
|
+
* @request GET:/alternative-assets/{asset_id}
|
|
4616
|
+
* @secure
|
|
4617
|
+
*/
|
|
4618
|
+
getAlternative(assetId: number, query?: {
|
|
4619
|
+
/**
|
|
4620
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4621
|
+
* @default "en-US"
|
|
4622
|
+
*/
|
|
4623
|
+
language?: BridgeWiseLanguageEnum;
|
|
4624
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMetadata, HandleError>>;
|
|
4625
|
+
/**
|
|
4626
|
+
* @description Offers key market data for the specified alternative asset, including daily high, open, low, close prices, and market capitalization.
|
|
4627
|
+
* @tags Alternative Assets
|
|
4628
|
+
* @name GetAlternativesMarketData
|
|
4629
|
+
* @summary Get Alternatives Market Data
|
|
4630
|
+
* @request GET:/alternative-assets/{asset_id}/market
|
|
4631
|
+
* @secure
|
|
4632
|
+
*/
|
|
4633
|
+
getAlternativesMarketData(assetId: number, query?: {
|
|
4634
|
+
/**
|
|
4635
|
+
* Date Ge
|
|
4636
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4637
|
+
*/
|
|
4638
|
+
date__ge?: string | null;
|
|
4639
|
+
/**
|
|
4640
|
+
* Date Le
|
|
4641
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4642
|
+
*/
|
|
4643
|
+
date__le?: string | null;
|
|
4644
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketDataList, HandleError>>;
|
|
4645
|
+
/**
|
|
4646
|
+
* @description Provides detailed market statistics for the specified alternative asset, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4647
|
+
* @tags Alternative Assets
|
|
4648
|
+
* @name GetAlternativesMarketStatistics
|
|
4649
|
+
* @summary Get Alternatives Market Statistics
|
|
4650
|
+
* @request GET:/alternative-assets/{asset_id}/market-statistics
|
|
4651
|
+
* @secure
|
|
4652
|
+
*/
|
|
4653
|
+
getAlternativesMarketStatistics(assetId: number, query?: {
|
|
4654
|
+
/**
|
|
4655
|
+
* Trading Item Id
|
|
4656
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4657
|
+
*/
|
|
4658
|
+
trading_item_id?: number | null;
|
|
4659
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketStatisticsList, HandleError>>;
|
|
4660
|
+
/**
|
|
4661
|
+
* @description Return aggregated news articles for a supported alternative asset (crypto, forex, commodity), using the same data pipeline and response schema as the existing companies news endpoint (NewsAPI-backed).
|
|
4662
|
+
* @tags Alternative Assets
|
|
4663
|
+
* @name GetAlternativeNews
|
|
4664
|
+
* @summary Get Alternative News
|
|
4665
|
+
* @request GET:/alternative-assets/{asset_id}/news
|
|
4666
|
+
* @secure
|
|
4667
|
+
*/
|
|
4668
|
+
getAlternativeNews(assetId: number, query?: {
|
|
4669
|
+
/**
|
|
4670
|
+
* Languages
|
|
4671
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4672
|
+
* @default "en-US"
|
|
4673
|
+
* @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))*$
|
|
4674
|
+
*/
|
|
4675
|
+
languages?: string;
|
|
4676
|
+
/**
|
|
4677
|
+
* Published Date Gte
|
|
4678
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4679
|
+
* @format date
|
|
4680
|
+
* @default "2025-12-07"
|
|
4681
|
+
*/
|
|
4682
|
+
published_date__gte?: string;
|
|
4683
|
+
/**
|
|
4684
|
+
* Published Date Lte
|
|
4685
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4686
|
+
* @format date
|
|
4687
|
+
* @default "2025-12-07"
|
|
4688
|
+
*/
|
|
4689
|
+
published_date__lte?: string;
|
|
4690
|
+
/**
|
|
4691
|
+
* Specify the field by which to sort the results.
|
|
4692
|
+
* @default "publication_date"
|
|
4693
|
+
*/
|
|
4694
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4695
|
+
/**
|
|
4696
|
+
* Size
|
|
4697
|
+
* Define the number of records per page for pagination purposes.
|
|
4698
|
+
* @default 10
|
|
4699
|
+
* @example 10
|
|
4700
|
+
*/
|
|
4701
|
+
size?: number;
|
|
4702
|
+
/**
|
|
4703
|
+
* Page
|
|
4704
|
+
* Define the page number for pagination.
|
|
4705
|
+
* @default 1
|
|
4706
|
+
* @example 1
|
|
4707
|
+
*/
|
|
4708
|
+
page?: number;
|
|
4709
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4710
|
+
/**
|
|
4711
|
+
* @description Return a daily-updated sentiment score for a supported alternative asset (crypto, forex, commodity) based on news from the past 7 days.
|
|
4712
|
+
* @tags Alternative Assets
|
|
4713
|
+
* @name GetAverageAlternativeNewsSentiment
|
|
4714
|
+
* @summary Get Average Alternative News Sentiment
|
|
4715
|
+
* @request GET:/alternative-assets/{asset_id}/news-sentiment
|
|
4716
|
+
* @secure
|
|
4717
|
+
*/
|
|
4718
|
+
getAverageAlternativeNewsSentiment(assetId: number, query?: {
|
|
4719
|
+
/**
|
|
4720
|
+
* Published Date Gte
|
|
4721
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4722
|
+
* @format date
|
|
4723
|
+
* @default "2025-12-07"
|
|
4724
|
+
*/
|
|
4725
|
+
published_date__gte?: string;
|
|
4726
|
+
/**
|
|
4727
|
+
* Published Date Lte
|
|
4728
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4729
|
+
* @format date
|
|
4730
|
+
* @default "2025-12-07"
|
|
4731
|
+
*/
|
|
4732
|
+
published_date__lte?: string;
|
|
4733
|
+
/**
|
|
4734
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4735
|
+
* @default "en-US"
|
|
4736
|
+
*/
|
|
4737
|
+
language?: BridgeWiseLanguageEnum;
|
|
4738
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4739
|
+
/**
|
|
4740
|
+
* @description `section_type='description' ->` Returns a static asset description (as ordered paragraphs) for a supported asset. `section_type='news-summary' ->` Returns an LLM-generated news summary for a supported alternative asset (crypto, forex, commodity) over a recent window (default: past 7 days), including 100–300 word overview, 3–5 highlights (positives), 3–5 lowlights (negatives), and metadata. Output is refreshed daily.`section_type='technical' ->` Paragraph reflects the most recent technical analysis rating and the relevant parameter sentiments.
|
|
4741
|
+
* @tags Alternative Assets
|
|
4742
|
+
* @name GetAlternativesParagraphs
|
|
4743
|
+
* @summary Get Alternatives Paragraphs
|
|
4744
|
+
* @request GET:/alternative-assets/{asset_id}/paragraphs
|
|
4745
|
+
* @secure
|
|
4746
|
+
*/
|
|
4747
|
+
getAlternativesParagraphs(assetId: number, query?: {
|
|
4748
|
+
/**
|
|
4749
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4750
|
+
* @default "en-US"
|
|
4751
|
+
*/
|
|
4752
|
+
language?: BridgeWiseLanguageEnum;
|
|
4753
|
+
/**
|
|
4754
|
+
* Section Type
|
|
4755
|
+
* Specify the component of the text paragraph (e.g., `description`, `technical`, `news_summary`).
|
|
4756
|
+
* @default "description"
|
|
4757
|
+
*/
|
|
4758
|
+
section_type?: BridgeWiseParagraphTextEnum | null;
|
|
4759
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetParagraph | BridgeWiseAssetLLMNewsParagraph | BridgeWiseAssetLLMTechnicalParagraph, HandleError>>;
|
|
4760
|
+
/**
|
|
4761
|
+
* @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.
|
|
4762
|
+
* @tags Alternative Assets
|
|
4763
|
+
* @name GetAltTechnicalAnalysis
|
|
4764
|
+
* @summary Get Alt Technical Analysis
|
|
4765
|
+
* @request GET:/alternative-assets/{asset_id}/technical-analysis
|
|
4766
|
+
* @secure
|
|
4767
|
+
*/
|
|
4768
|
+
getAltTechnicalAnalysis(assetId: number, query?: {
|
|
4769
|
+
/**
|
|
4770
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4771
|
+
* @default "en-US"
|
|
4772
|
+
*/
|
|
4773
|
+
language?: BridgeWiseLanguageEnum;
|
|
4774
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkAlterModelsTechAnalysisItem, HandleError>>;
|
|
4775
|
+
/**
|
|
4776
|
+
* @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.
|
|
4777
|
+
* @tags Alternative Assets
|
|
4778
|
+
* @name GetAltTechnicalParameters
|
|
4779
|
+
* @summary Get Alt Technical Parameters
|
|
4780
|
+
* @request GET:/alternative-assets/{asset_id}/technical-parameters
|
|
4781
|
+
* @secure
|
|
4782
|
+
*/
|
|
4783
|
+
getAltTechnicalParameters(assetId: number, query?: {
|
|
4784
|
+
/**
|
|
4785
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4786
|
+
* @default "en-US"
|
|
4787
|
+
*/
|
|
4788
|
+
language?: BridgeWiseLanguageEnum;
|
|
4789
|
+
/**
|
|
4790
|
+
* Parameter Id
|
|
4791
|
+
* Get desired parameter by ID.
|
|
4792
|
+
*/
|
|
4793
|
+
parameter_id?: number;
|
|
4794
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetTechParameterItemList, HandleError>>;
|
|
4795
|
+
}
|
|
4796
|
+
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
4797
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4798
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4799
|
+
/**
|
|
4800
|
+
* @description Enables users to search and filter companies based on a range of financial and non-financial criteria, returning a detailed list of companies that match the specified parameters.
|
|
4801
|
+
* @tags Company Metadata, Themes
|
|
4802
|
+
* @name GetCompanies
|
|
4803
|
+
* @summary Get Companies
|
|
4804
|
+
* @request GET:/companies
|
|
4805
|
+
* @secure
|
|
4806
|
+
*/
|
|
4865
4807
|
getCompanies(query?: {
|
|
4866
4808
|
/**
|
|
4867
4809
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -5553,51 +5495,64 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
5553
5495
|
identifier_type: string;
|
|
5554
5496
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
5555
5497
|
}
|
|
5556
|
-
export class
|
|
5498
|
+
export class Alerts<HandleError extends boolean = boolean> {
|
|
5557
5499
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5558
5500
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5559
5501
|
/**
|
|
5560
|
-
* @description
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary
|
|
5564
|
-
* @request GET:/
|
|
5502
|
+
* @description Get alerts with optional inclusion of related resources
|
|
5503
|
+
* @tags Alerts
|
|
5504
|
+
* @name GetAlerts
|
|
5505
|
+
* @summary Get Alerts
|
|
5506
|
+
* @request GET:/alerts
|
|
5565
5507
|
* @secure
|
|
5566
5508
|
*/
|
|
5567
|
-
|
|
5568
|
-
/**
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5509
|
+
getAlerts(query?: {
|
|
5510
|
+
/** @default "en-US" */
|
|
5511
|
+
language?: BridgeWiseAlertLanguagesEnum;
|
|
5512
|
+
/** Date Gte */
|
|
5513
|
+
date__gte?: string | null;
|
|
5514
|
+
/** Date Lte */
|
|
5515
|
+
date__lte?: string | null;
|
|
5516
|
+
/** Sentiment */
|
|
5517
|
+
sentiment?: BridgeWiseEventSentimentEnum | null;
|
|
5518
|
+
/** Importance Level */
|
|
5519
|
+
importance_level?: number | null;
|
|
5520
|
+
/** Alert Type */
|
|
5521
|
+
alert_type?: BridgeWiseAlertTypeEnum | null;
|
|
5575
5522
|
/**
|
|
5576
|
-
*
|
|
5577
|
-
*
|
|
5578
|
-
* @min 1
|
|
5579
|
-
* @max 100
|
|
5580
|
-
* @default 50
|
|
5523
|
+
* Limit
|
|
5524
|
+
* @default 10
|
|
5581
5525
|
*/
|
|
5582
|
-
|
|
5526
|
+
limit?: number;
|
|
5583
5527
|
/**
|
|
5584
|
-
*
|
|
5585
|
-
*
|
|
5586
|
-
* @min 1
|
|
5587
|
-
* @default 1
|
|
5528
|
+
* Offset
|
|
5529
|
+
* @default 0
|
|
5588
5530
|
*/
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
|
|
5595
|
-
|
|
5596
|
-
|
|
5597
|
-
|
|
5598
|
-
|
|
5599
|
-
|
|
5600
|
-
}
|
|
5531
|
+
offset?: number;
|
|
5532
|
+
/** Asset Type */
|
|
5533
|
+
asset_type?: BridgeWiseAssetTypeEnum | null;
|
|
5534
|
+
/** Ticker Exchange */
|
|
5535
|
+
ticker_exchange?: string | null;
|
|
5536
|
+
/** Ticker Symbol */
|
|
5537
|
+
ticker_symbol?: string | null;
|
|
5538
|
+
/** Include */
|
|
5539
|
+
include?: string | null;
|
|
5540
|
+
/** Company Id */
|
|
5541
|
+
company_id?: string | null;
|
|
5542
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlert[], HandleError>>;
|
|
5543
|
+
/**
|
|
5544
|
+
* @description Get reasons for a specific alert by alert ID.
|
|
5545
|
+
* @tags Alerts
|
|
5546
|
+
* @name GetAlertReasons
|
|
5547
|
+
* @summary Get Alert Reasons
|
|
5548
|
+
* @request GET:/alerts/{alert_id}/reasons
|
|
5549
|
+
* @secure
|
|
5550
|
+
*/
|
|
5551
|
+
getAlertReasons(alertId: string, query?: {
|
|
5552
|
+
/** @default "en-US" */
|
|
5553
|
+
language?: BridgeWiseAlertLanguagesEnum;
|
|
5554
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlertReason[], HandleError>>;
|
|
5555
|
+
}
|
|
5601
5556
|
export class Activities<HandleError extends boolean = boolean> {
|
|
5602
5557
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5603
5558
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5648,34 +5603,50 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
5648
5603
|
importance?: string;
|
|
5649
5604
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
5650
5605
|
}
|
|
5651
|
-
export class
|
|
5606
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5652
5607
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5653
5608
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5654
5609
|
/**
|
|
5655
|
-
* @description
|
|
5656
|
-
* @tags
|
|
5657
|
-
* @name
|
|
5658
|
-
* @summary
|
|
5659
|
-
* @request GET:/companies/
|
|
5610
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
5611
|
+
* @tags Logos
|
|
5612
|
+
* @name FetchLogos
|
|
5613
|
+
* @summary Fetch Logos
|
|
5614
|
+
* @request GET:/companies/logos
|
|
5660
5615
|
* @secure
|
|
5661
5616
|
*/
|
|
5662
|
-
|
|
5617
|
+
fetchLogos(query?: {
|
|
5663
5618
|
/**
|
|
5664
|
-
*
|
|
5665
|
-
* Specify a
|
|
5619
|
+
* Company Id In
|
|
5620
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5621
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5622
|
+
* @example "74822,83343211"
|
|
5666
5623
|
*/
|
|
5667
|
-
|
|
5624
|
+
company_id__in?: string;
|
|
5668
5625
|
/**
|
|
5669
|
-
*
|
|
5670
|
-
*
|
|
5626
|
+
* Size
|
|
5627
|
+
* Page size
|
|
5628
|
+
* @min 1
|
|
5629
|
+
* @max 100
|
|
5630
|
+
* @default 50
|
|
5671
5631
|
*/
|
|
5672
|
-
|
|
5632
|
+
size?: number;
|
|
5673
5633
|
/**
|
|
5674
|
-
*
|
|
5675
|
-
*
|
|
5634
|
+
* Page
|
|
5635
|
+
* Page number
|
|
5636
|
+
* @min 1
|
|
5637
|
+
* @default 1
|
|
5676
5638
|
*/
|
|
5677
|
-
|
|
5678
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5639
|
+
page?: number;
|
|
5640
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
5641
|
+
/**
|
|
5642
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
5643
|
+
* @tags Logos
|
|
5644
|
+
* @name FetchLogo
|
|
5645
|
+
* @summary Fetch Logo
|
|
5646
|
+
* @request GET:/companies/{company_id}/logos
|
|
5647
|
+
* @secure
|
|
5648
|
+
*/
|
|
5649
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
5679
5650
|
}
|
|
5680
5651
|
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
5681
5652
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5723,6 +5694,35 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
5723
5694
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
5724
5695
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
5725
5696
|
}
|
|
5697
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
5698
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5699
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5700
|
+
/**
|
|
5701
|
+
* @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
|
|
5702
|
+
* @tags Consensus Analysts
|
|
5703
|
+
* @name GetConsensusRatings
|
|
5704
|
+
* @summary Get Consensus Ratings
|
|
5705
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
5706
|
+
* @secure
|
|
5707
|
+
*/
|
|
5708
|
+
getConsensusRatings(companyId: number, query?: {
|
|
5709
|
+
/**
|
|
5710
|
+
* Trading Item Id
|
|
5711
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5712
|
+
*/
|
|
5713
|
+
trading_item_id?: number;
|
|
5714
|
+
/**
|
|
5715
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5716
|
+
* @default "en-US"
|
|
5717
|
+
*/
|
|
5718
|
+
language?: BridgeWiseLanguageEnum;
|
|
5719
|
+
/**
|
|
5720
|
+
* Date Gte
|
|
5721
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5722
|
+
*/
|
|
5723
|
+
date__gte?: string | null;
|
|
5724
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
5725
|
+
}
|
|
5726
5726
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
5727
5727
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5728
5728
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6155,27 +6155,6 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
6155
6155
|
language?: BridgeWiseLanguageEnum;
|
|
6156
6156
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
6157
6157
|
}
|
|
6158
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
6159
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6160
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6161
|
-
/**
|
|
6162
|
-
* @description This endpoint provides filters
|
|
6163
|
-
* @tags Metadata
|
|
6164
|
-
* @name GetCompanyFilters
|
|
6165
|
-
* @summary Get Company Filters
|
|
6166
|
-
* @request GET:/filters
|
|
6167
|
-
* @secure
|
|
6168
|
-
*/
|
|
6169
|
-
getCompanyFilters(query: {
|
|
6170
|
-
/** Desired filter type. */
|
|
6171
|
-
type: BridgeWiseCompanyFilterType;
|
|
6172
|
-
/**
|
|
6173
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6174
|
-
* @default "en-US"
|
|
6175
|
-
*/
|
|
6176
|
-
language?: BridgeWiseLanguageEnum;
|
|
6177
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
6178
|
-
}
|
|
6179
6158
|
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
6180
6159
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6181
6160
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6245,6 +6224,27 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
6245
6224
|
parameter_id?: number;
|
|
6246
6225
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
6247
6226
|
}
|
|
6227
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
6228
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6229
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6230
|
+
/**
|
|
6231
|
+
* @description This endpoint provides filters
|
|
6232
|
+
* @tags Metadata
|
|
6233
|
+
* @name GetCompanyFilters
|
|
6234
|
+
* @summary Get Company Filters
|
|
6235
|
+
* @request GET:/filters
|
|
6236
|
+
* @secure
|
|
6237
|
+
*/
|
|
6238
|
+
getCompanyFilters(query: {
|
|
6239
|
+
/** Desired filter type. */
|
|
6240
|
+
type: BridgeWiseCompanyFilterType;
|
|
6241
|
+
/**
|
|
6242
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6243
|
+
* @default "en-US"
|
|
6244
|
+
*/
|
|
6245
|
+
language?: BridgeWiseLanguageEnum;
|
|
6246
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
6247
|
+
}
|
|
6248
6248
|
export class PdfReportGeneration<HandleError extends boolean = boolean> {
|
|
6249
6249
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6250
6250
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6696,6 +6696,89 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
6696
6696
|
include?: string;
|
|
6697
6697
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
6698
6698
|
}
|
|
6699
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
6700
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6701
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6702
|
+
/**
|
|
6703
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
6704
|
+
* @tags Fund ESG Analysis
|
|
6705
|
+
* @name GetFundEsgAnalysis
|
|
6706
|
+
* @summary Get Fund Esg Analysis
|
|
6707
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
6708
|
+
* @secure
|
|
6709
|
+
*/
|
|
6710
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
6711
|
+
/**
|
|
6712
|
+
* Limit
|
|
6713
|
+
* Limit for ESG analysis results
|
|
6714
|
+
*/
|
|
6715
|
+
limit?: number;
|
|
6716
|
+
/**
|
|
6717
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6718
|
+
* @default "en-US"
|
|
6719
|
+
*/
|
|
6720
|
+
language?: BridgeWiseLanguageEnum;
|
|
6721
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
6722
|
+
}
|
|
6723
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
6724
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6725
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6726
|
+
/**
|
|
6727
|
+
* @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.
|
|
6728
|
+
* @tags Holdings
|
|
6729
|
+
* @name GetCompositions
|
|
6730
|
+
* @summary Get Compositions
|
|
6731
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
6732
|
+
* @secure
|
|
6733
|
+
*/
|
|
6734
|
+
getCompositions(fundId: number, query?: {
|
|
6735
|
+
/**
|
|
6736
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6737
|
+
* @default "en-US"
|
|
6738
|
+
*/
|
|
6739
|
+
language?: BridgeWiseLanguageEnum;
|
|
6740
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
6741
|
+
/**
|
|
6742
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
6743
|
+
* @tags Holdings
|
|
6744
|
+
* @name GetHoldingStatistics
|
|
6745
|
+
* @summary Get Holding Statistics
|
|
6746
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
6747
|
+
* @secure
|
|
6748
|
+
*/
|
|
6749
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
6750
|
+
/**
|
|
6751
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6752
|
+
* @default "en-US"
|
|
6753
|
+
*/
|
|
6754
|
+
language?: BridgeWiseLanguageEnum;
|
|
6755
|
+
/**
|
|
6756
|
+
* Composition Type
|
|
6757
|
+
* Composition type for fund holding statistics
|
|
6758
|
+
*/
|
|
6759
|
+
composition_type?: string;
|
|
6760
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
6761
|
+
/**
|
|
6762
|
+
* @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.
|
|
6763
|
+
* @tags Holdings
|
|
6764
|
+
* @name GetHoldings
|
|
6765
|
+
* @summary Get Holdings
|
|
6766
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
6767
|
+
* @secure
|
|
6768
|
+
*/
|
|
6769
|
+
getHoldings(fundId: number, query?: {
|
|
6770
|
+
/**
|
|
6771
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6772
|
+
* @default "en-US"
|
|
6773
|
+
*/
|
|
6774
|
+
language?: BridgeWiseLanguageEnum;
|
|
6775
|
+
/**
|
|
6776
|
+
* Composition Type
|
|
6777
|
+
* Composition type for fund holdings
|
|
6778
|
+
*/
|
|
6779
|
+
composition_type?: string;
|
|
6780
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
6781
|
+
}
|
|
6699
6782
|
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
6700
6783
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6701
6784
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6805,104 +6888,21 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
6805
6888
|
show_all?: boolean;
|
|
6806
6889
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
6807
6890
|
}
|
|
6808
|
-
export class
|
|
6891
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
6809
6892
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6810
6893
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6811
6894
|
/**
|
|
6812
|
-
* @description
|
|
6813
|
-
* @tags
|
|
6814
|
-
* @name
|
|
6815
|
-
* @summary Get
|
|
6816
|
-
* @request GET:/funds/{fund_id}/
|
|
6895
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
6896
|
+
* @tags Fund Market Data
|
|
6897
|
+
* @name GetFundsMarketData
|
|
6898
|
+
* @summary Get Funds Market Data
|
|
6899
|
+
* @request GET:/funds/{fund_id}/market
|
|
6817
6900
|
* @secure
|
|
6818
6901
|
*/
|
|
6819
|
-
|
|
6902
|
+
getFundsMarketData(fundId: number, query?: {
|
|
6820
6903
|
/**
|
|
6821
|
-
*
|
|
6822
|
-
*
|
|
6823
|
-
*/
|
|
6824
|
-
language?: BridgeWiseLanguageEnum;
|
|
6825
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
6826
|
-
/**
|
|
6827
|
-
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
6828
|
-
* @tags Holdings
|
|
6829
|
-
* @name GetHoldingStatistics
|
|
6830
|
-
* @summary Get Holding Statistics
|
|
6831
|
-
* @request GET:/funds/{fund_id}/holding-statistics
|
|
6832
|
-
* @secure
|
|
6833
|
-
*/
|
|
6834
|
-
getHoldingStatistics(fundId: number, query?: {
|
|
6835
|
-
/**
|
|
6836
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6837
|
-
* @default "en-US"
|
|
6838
|
-
*/
|
|
6839
|
-
language?: BridgeWiseLanguageEnum;
|
|
6840
|
-
/**
|
|
6841
|
-
* Composition Type
|
|
6842
|
-
* Composition type for fund holding statistics
|
|
6843
|
-
*/
|
|
6844
|
-
composition_type?: string;
|
|
6845
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
6846
|
-
/**
|
|
6847
|
-
* @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.
|
|
6848
|
-
* @tags Holdings
|
|
6849
|
-
* @name GetHoldings
|
|
6850
|
-
* @summary Get Holdings
|
|
6851
|
-
* @request GET:/funds/{fund_id}/holdings
|
|
6852
|
-
* @secure
|
|
6853
|
-
*/
|
|
6854
|
-
getHoldings(fundId: number, query?: {
|
|
6855
|
-
/**
|
|
6856
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6857
|
-
* @default "en-US"
|
|
6858
|
-
*/
|
|
6859
|
-
language?: BridgeWiseLanguageEnum;
|
|
6860
|
-
/**
|
|
6861
|
-
* Composition Type
|
|
6862
|
-
* Composition type for fund holdings
|
|
6863
|
-
*/
|
|
6864
|
-
composition_type?: string;
|
|
6865
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
6866
|
-
}
|
|
6867
|
-
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
6868
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6869
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6870
|
-
/**
|
|
6871
|
-
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
6872
|
-
* @tags Fund ESG Analysis
|
|
6873
|
-
* @name GetFundEsgAnalysis
|
|
6874
|
-
* @summary Get Fund Esg Analysis
|
|
6875
|
-
* @request GET:/funds/{fund_id}/esg-analysis
|
|
6876
|
-
* @secure
|
|
6877
|
-
*/
|
|
6878
|
-
getFundEsgAnalysis(fundId: number, query?: {
|
|
6879
|
-
/**
|
|
6880
|
-
* Limit
|
|
6881
|
-
* Limit for ESG analysis results
|
|
6882
|
-
*/
|
|
6883
|
-
limit?: number;
|
|
6884
|
-
/**
|
|
6885
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6886
|
-
* @default "en-US"
|
|
6887
|
-
*/
|
|
6888
|
-
language?: BridgeWiseLanguageEnum;
|
|
6889
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
6890
|
-
}
|
|
6891
|
-
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
6892
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6893
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6894
|
-
/**
|
|
6895
|
-
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
6896
|
-
* @tags Fund Market Data
|
|
6897
|
-
* @name GetFundsMarketData
|
|
6898
|
-
* @summary Get Funds Market Data
|
|
6899
|
-
* @request GET:/funds/{fund_id}/market
|
|
6900
|
-
* @secure
|
|
6901
|
-
*/
|
|
6902
|
-
getFundsMarketData(fundId: number, query?: {
|
|
6903
|
-
/**
|
|
6904
|
-
* Trading Item Id
|
|
6905
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
6904
|
+
* Trading Item Id
|
|
6905
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
6906
6906
|
*/
|
|
6907
6907
|
trading_item_id?: number | null;
|
|
6908
6908
|
/**
|
|
@@ -13704,6 +13704,177 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
|
13704
13704
|
limit?: number;
|
|
13705
13705
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
13706
13706
|
}
|
|
13707
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
13708
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
13709
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
13710
|
+
/**
|
|
13711
|
+
* @description Get list of tenant identifiers
|
|
13712
|
+
* @tags Tenant Identifiers
|
|
13713
|
+
* @name GetTenantIdentifiers
|
|
13714
|
+
* @summary Get Tenant Identifiers
|
|
13715
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
13716
|
+
* @secure
|
|
13717
|
+
*/
|
|
13718
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
13719
|
+
/** Tenant custom identifier status. */
|
|
13720
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
13721
|
+
/**
|
|
13722
|
+
* Page
|
|
13723
|
+
* Define the page number for the results.
|
|
13724
|
+
* @default 1
|
|
13725
|
+
* @example 1
|
|
13726
|
+
*/
|
|
13727
|
+
page?: number;
|
|
13728
|
+
/**
|
|
13729
|
+
* Page Size
|
|
13730
|
+
* Define the maximum number of results to retrieve.
|
|
13731
|
+
* @default 20
|
|
13732
|
+
* @example 10
|
|
13733
|
+
*/
|
|
13734
|
+
page_size?: number;
|
|
13735
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
13736
|
+
/**
|
|
13737
|
+
* @description Create a new identifier for a tenant
|
|
13738
|
+
* @tags Tenant Identifiers
|
|
13739
|
+
* @name CreateTenantIdentifier
|
|
13740
|
+
* @summary Create Tenant Identifier
|
|
13741
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
13742
|
+
* @secure
|
|
13743
|
+
*/
|
|
13744
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
13745
|
+
/**
|
|
13746
|
+
* @description Update an existing identifier for a tenant
|
|
13747
|
+
* @tags Tenant Identifiers
|
|
13748
|
+
* @name UpdateTenantIdentifier
|
|
13749
|
+
* @summary Update Tenant Identifier
|
|
13750
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
13751
|
+
* @secure
|
|
13752
|
+
*/
|
|
13753
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
13754
|
+
/**
|
|
13755
|
+
* @description Delete identifier for a tenant
|
|
13756
|
+
* @tags Tenant Identifiers
|
|
13757
|
+
* @name DeleteTenantIdentifier
|
|
13758
|
+
* @summary Delete Tenant Identifier
|
|
13759
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
13760
|
+
* @secure
|
|
13761
|
+
*/
|
|
13762
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
13763
|
+
}
|
|
13764
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
13765
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
13766
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
13767
|
+
/**
|
|
13768
|
+
* @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.
|
|
13769
|
+
* @tags Themes
|
|
13770
|
+
* @name GetThemes
|
|
13771
|
+
* @summary Get Themes
|
|
13772
|
+
* @request GET:/themes
|
|
13773
|
+
* @secure
|
|
13774
|
+
*/
|
|
13775
|
+
getThemes(query?: {
|
|
13776
|
+
/**
|
|
13777
|
+
* Search
|
|
13778
|
+
* Search string to filter themes by name or description.
|
|
13779
|
+
*/
|
|
13780
|
+
search?: string | null;
|
|
13781
|
+
/**
|
|
13782
|
+
* Company Id
|
|
13783
|
+
* Filter themes by company id
|
|
13784
|
+
*/
|
|
13785
|
+
company_id?: number;
|
|
13786
|
+
/**
|
|
13787
|
+
* Fund Id
|
|
13788
|
+
* Filter themes by fund id
|
|
13789
|
+
*/
|
|
13790
|
+
fund_id?: number;
|
|
13791
|
+
/**
|
|
13792
|
+
* Sort By
|
|
13793
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
13794
|
+
* @default "rank"
|
|
13795
|
+
*/
|
|
13796
|
+
sort_by?: string;
|
|
13797
|
+
/**
|
|
13798
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
13799
|
+
* @default "en-US"
|
|
13800
|
+
*/
|
|
13801
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
13802
|
+
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
13803
|
+
group?: BridgeWiseThemeGroupEnum;
|
|
13804
|
+
/** Filter themes by asset class. Allowed values: stocks, funds. */
|
|
13805
|
+
asset_class?: BridgeWiseThemeAssetClassEnum;
|
|
13806
|
+
/** Filter basic and advanced theme packages. */
|
|
13807
|
+
package?: BridgeWiseThemePackageEnum;
|
|
13808
|
+
/** The type of the theme. */
|
|
13809
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
13810
|
+
/**
|
|
13811
|
+
* Page
|
|
13812
|
+
* Define the page number for pagination.
|
|
13813
|
+
* @min 1
|
|
13814
|
+
* @default 1
|
|
13815
|
+
*/
|
|
13816
|
+
page?: number;
|
|
13817
|
+
/**
|
|
13818
|
+
* Page Size
|
|
13819
|
+
* Define the number of records per page for pagination purposes.
|
|
13820
|
+
* @min 1
|
|
13821
|
+
* @default 10
|
|
13822
|
+
*/
|
|
13823
|
+
page_size?: number;
|
|
13824
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
13825
|
+
/**
|
|
13826
|
+
* @description Retrieve a specific theme by its ID.
|
|
13827
|
+
* @tags Themes
|
|
13828
|
+
* @name GetTheme
|
|
13829
|
+
* @summary Get Theme
|
|
13830
|
+
* @request GET:/themes/{theme_id}
|
|
13831
|
+
* @secure
|
|
13832
|
+
*/
|
|
13833
|
+
getTheme(themeId: number, query?: {
|
|
13834
|
+
/**
|
|
13835
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
13836
|
+
* @default "en-US"
|
|
13837
|
+
*/
|
|
13838
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
13839
|
+
/**
|
|
13840
|
+
* Include Filter
|
|
13841
|
+
* Include theme filters.
|
|
13842
|
+
* @default false
|
|
13843
|
+
*/
|
|
13844
|
+
include_filter?: boolean;
|
|
13845
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
13846
|
+
/**
|
|
13847
|
+
* @tags Themes
|
|
13848
|
+
* @name GetThemeFilters
|
|
13849
|
+
* @summary Get Theme Filters
|
|
13850
|
+
* @request GET:/themes/{theme_id}/filters
|
|
13851
|
+
* @secure
|
|
13852
|
+
*/
|
|
13853
|
+
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
13854
|
+
}
|
|
13855
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
13856
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
13857
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
13858
|
+
/**
|
|
13859
|
+
* @tags Users
|
|
13860
|
+
* @name Authenticate
|
|
13861
|
+
* @summary Authenticate
|
|
13862
|
+
* @request POST:/users/authenticate
|
|
13863
|
+
* @secure
|
|
13864
|
+
*/
|
|
13865
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
13866
|
+
/**
|
|
13867
|
+
* @tags Users
|
|
13868
|
+
* @name FetchClientDetails
|
|
13869
|
+
* @summary Fetch Client Details
|
|
13870
|
+
* @request GET:/users/machine
|
|
13871
|
+
* @secure
|
|
13872
|
+
*/
|
|
13873
|
+
fetchClientDetails(headers: {
|
|
13874
|
+
/** Authorization */
|
|
13875
|
+
authorization: string;
|
|
13876
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
13877
|
+
}
|
|
13707
13878
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
13708
13879
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
13709
13880
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -13877,177 +14048,6 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
13877
14048
|
*/
|
|
13878
14049
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
13879
14050
|
}
|
|
13880
|
-
export class Themes<HandleError extends boolean = boolean> {
|
|
13881
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13882
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13883
|
-
/**
|
|
13884
|
-
* @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.
|
|
13885
|
-
* @tags Themes
|
|
13886
|
-
* @name GetThemes
|
|
13887
|
-
* @summary Get Themes
|
|
13888
|
-
* @request GET:/themes
|
|
13889
|
-
* @secure
|
|
13890
|
-
*/
|
|
13891
|
-
getThemes(query?: {
|
|
13892
|
-
/**
|
|
13893
|
-
* Search
|
|
13894
|
-
* Search string to filter themes by name or description.
|
|
13895
|
-
*/
|
|
13896
|
-
search?: string | null;
|
|
13897
|
-
/**
|
|
13898
|
-
* Company Id
|
|
13899
|
-
* Filter themes by company id
|
|
13900
|
-
*/
|
|
13901
|
-
company_id?: number;
|
|
13902
|
-
/**
|
|
13903
|
-
* Fund Id
|
|
13904
|
-
* Filter themes by fund id
|
|
13905
|
-
*/
|
|
13906
|
-
fund_id?: number;
|
|
13907
|
-
/**
|
|
13908
|
-
* Sort By
|
|
13909
|
-
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
13910
|
-
* @default "rank"
|
|
13911
|
-
*/
|
|
13912
|
-
sort_by?: string;
|
|
13913
|
-
/**
|
|
13914
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
13915
|
-
* @default "en-US"
|
|
13916
|
-
*/
|
|
13917
|
-
language?: BridgeWiseThemeLanguageEnum;
|
|
13918
|
-
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
13919
|
-
group?: BridgeWiseThemeGroupEnum;
|
|
13920
|
-
/** Filter themes by asset class. Allowed values: stocks, funds. */
|
|
13921
|
-
asset_class?: BridgeWiseThemeAssetClassEnum;
|
|
13922
|
-
/** Filter basic and advanced theme packages. */
|
|
13923
|
-
package?: BridgeWiseThemePackageEnum;
|
|
13924
|
-
/** The type of the theme. */
|
|
13925
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
13926
|
-
/**
|
|
13927
|
-
* Page
|
|
13928
|
-
* Define the page number for pagination.
|
|
13929
|
-
* @min 1
|
|
13930
|
-
* @default 1
|
|
13931
|
-
*/
|
|
13932
|
-
page?: number;
|
|
13933
|
-
/**
|
|
13934
|
-
* Page Size
|
|
13935
|
-
* Define the number of records per page for pagination purposes.
|
|
13936
|
-
* @min 1
|
|
13937
|
-
* @default 10
|
|
13938
|
-
*/
|
|
13939
|
-
page_size?: number;
|
|
13940
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
13941
|
-
/**
|
|
13942
|
-
* @description Retrieve a specific theme by its ID.
|
|
13943
|
-
* @tags Themes
|
|
13944
|
-
* @name GetTheme
|
|
13945
|
-
* @summary Get Theme
|
|
13946
|
-
* @request GET:/themes/{theme_id}
|
|
13947
|
-
* @secure
|
|
13948
|
-
*/
|
|
13949
|
-
getTheme(themeId: number, query?: {
|
|
13950
|
-
/**
|
|
13951
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
13952
|
-
* @default "en-US"
|
|
13953
|
-
*/
|
|
13954
|
-
language?: BridgeWiseThemeLanguageEnum;
|
|
13955
|
-
/**
|
|
13956
|
-
* Include Filter
|
|
13957
|
-
* Include theme filters.
|
|
13958
|
-
* @default false
|
|
13959
|
-
*/
|
|
13960
|
-
include_filter?: boolean;
|
|
13961
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
13962
|
-
/**
|
|
13963
|
-
* @tags Themes
|
|
13964
|
-
* @name GetThemeFilters
|
|
13965
|
-
* @summary Get Theme Filters
|
|
13966
|
-
* @request GET:/themes/{theme_id}/filters
|
|
13967
|
-
* @secure
|
|
13968
|
-
*/
|
|
13969
|
-
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
13970
|
-
}
|
|
13971
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
13972
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13973
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13974
|
-
/**
|
|
13975
|
-
* @tags Users
|
|
13976
|
-
* @name Authenticate
|
|
13977
|
-
* @summary Authenticate
|
|
13978
|
-
* @request POST:/users/authenticate
|
|
13979
|
-
* @secure
|
|
13980
|
-
*/
|
|
13981
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
13982
|
-
/**
|
|
13983
|
-
* @tags Users
|
|
13984
|
-
* @name FetchClientDetails
|
|
13985
|
-
* @summary Fetch Client Details
|
|
13986
|
-
* @request GET:/users/machine
|
|
13987
|
-
* @secure
|
|
13988
|
-
*/
|
|
13989
|
-
fetchClientDetails(headers: {
|
|
13990
|
-
/** Authorization */
|
|
13991
|
-
authorization: string;
|
|
13992
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
13993
|
-
}
|
|
13994
|
-
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
13995
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13996
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13997
|
-
/**
|
|
13998
|
-
* @description Get list of tenant identifiers
|
|
13999
|
-
* @tags Tenant Identifiers
|
|
14000
|
-
* @name GetTenantIdentifiers
|
|
14001
|
-
* @summary Get Tenant Identifiers
|
|
14002
|
-
* @request GET:/tenants/{tenant_id}/identifiers
|
|
14003
|
-
* @secure
|
|
14004
|
-
*/
|
|
14005
|
-
getTenantIdentifiers(tenantId: string, query?: {
|
|
14006
|
-
/** Tenant custom identifier status. */
|
|
14007
|
-
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
14008
|
-
/**
|
|
14009
|
-
* Page
|
|
14010
|
-
* Define the page number for the results.
|
|
14011
|
-
* @default 1
|
|
14012
|
-
* @example 1
|
|
14013
|
-
*/
|
|
14014
|
-
page?: number;
|
|
14015
|
-
/**
|
|
14016
|
-
* Page Size
|
|
14017
|
-
* Define the maximum number of results to retrieve.
|
|
14018
|
-
* @default 20
|
|
14019
|
-
* @example 10
|
|
14020
|
-
*/
|
|
14021
|
-
page_size?: number;
|
|
14022
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
14023
|
-
/**
|
|
14024
|
-
* @description Create a new identifier for a tenant
|
|
14025
|
-
* @tags Tenant Identifiers
|
|
14026
|
-
* @name CreateTenantIdentifier
|
|
14027
|
-
* @summary Create Tenant Identifier
|
|
14028
|
-
* @request POST:/tenants/{tenant_id}/identifiers
|
|
14029
|
-
* @secure
|
|
14030
|
-
*/
|
|
14031
|
-
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
14032
|
-
/**
|
|
14033
|
-
* @description Update an existing identifier for a tenant
|
|
14034
|
-
* @tags Tenant Identifiers
|
|
14035
|
-
* @name UpdateTenantIdentifier
|
|
14036
|
-
* @summary Update Tenant Identifier
|
|
14037
|
-
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
14038
|
-
* @secure
|
|
14039
|
-
*/
|
|
14040
|
-
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
14041
|
-
/**
|
|
14042
|
-
* @description Delete identifier for a tenant
|
|
14043
|
-
* @tags Tenant Identifiers
|
|
14044
|
-
* @name DeleteTenantIdentifier
|
|
14045
|
-
* @summary Delete Tenant Identifier
|
|
14046
|
-
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
14047
|
-
* @secure
|
|
14048
|
-
*/
|
|
14049
|
-
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
14050
|
-
}
|
|
14051
14051
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
14052
14052
|
readonly config: JwtClientConfig<HandleError>;
|
|
14053
14053
|
activities: Activities<HandleError>;
|