@orbis-systems/orbis-api-clients 0.7.10 → 0.7.11

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.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +114 -114
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +500 -491
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +622 -544
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/orbis/index.d.ts +1469 -1469
  20. package/dist/orbis/index.d.ts.map +1 -1
  21. package/dist/orbis/index.esm.js +1 -1
  22. package/dist/orbis/index.esm.js.map +1 -1
  23. package/dist/orbis/index.js +1 -1
  24. package/dist/orbis/index.js.map +1 -1
  25. package/dist/uma/index.d.ts +319 -319
  26. package/dist/uma/index.d.ts.map +1 -1
  27. package/dist/uma/index.esm.js +1 -1
  28. package/dist/uma/index.esm.js.map +1 -1
  29. package/dist/uma/index.js +1 -1
  30. package/dist/uma/index.js.map +1 -1
  31. package/dist/zerohash/index.d.ts +130 -130
  32. package/dist/zerohash/index.d.ts.map +1 -1
  33. package/dist/zerohash/index.esm.js +1 -1
  34. package/dist/zerohash/index.esm.js.map +1 -1
  35. package/dist/zerohash/index.js +1 -1
  36. package/dist/zerohash/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -95,12 +95,21 @@ export interface BridgeWiseExportRow {
95
95
  answer_requested_by_user: boolean;
96
96
  }
97
97
  export interface BridgeWiseExternalQuestionRequest {
98
- /** @maxLength 2000 */
98
+ /**
99
+ * Question to ask like: What are the latest news about Nvidia?
100
+ * @maxLength 2000
101
+ */
99
102
  message: string;
100
- /** @maxLength 256 */
103
+ /**
104
+ * Single chat session ID like: ccbe7a22-b98c-41c0-8fe0-b4858d80dd92
105
+ * @maxLength 256
106
+ */
101
107
  session_id: string;
102
- /** @maxLength 256 */
103
- language: string;
108
+ /**
109
+ * Language type like 'en', 'ja', 'he'
110
+ * @maxLength 256
111
+ */
112
+ language?: string;
104
113
  }
105
114
  export interface BridgeWiseExternalQuestionResponse {
106
115
  message: string;
@@ -3349,6 +3358,48 @@ export class Bwc<HandleError extends boolean = boolean> {
3349
3358
  identifier: string;
3350
3359
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
3351
3360
  }
3361
+ export class Bridget<HandleError extends boolean = boolean> {
3362
+ protected readonly apiClient: JwtClient<HandleError>;
3363
+ constructor(apiClient: JwtClient<HandleError>);
3364
+ /**
3365
+ * @tags Bridget
3366
+ * @name QuestionCreate
3367
+ * @request POST:/bridget/question
3368
+ * @secure
3369
+ */
3370
+ questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
3371
+ /**
3372
+ * @tags Bridget
3373
+ * @name TenantsExportRetrieve
3374
+ * @request GET:/bridget/tenants/{tenant_id}/export
3375
+ * @secure
3376
+ */
3377
+ tenantsExportRetrieve(tenantId: string, query?: {
3378
+ /** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
3379
+ client_id?: string;
3380
+ /**
3381
+ * Returns logs only for the specified calendar day (00:00–23:59 tenant time zone). Use either this field or the start_date + end_date pair — never both in the same request.
3382
+ * @format date
3383
+ */
3384
+ date?: string;
3385
+ /**
3386
+ * Inclusive end of a date range (must be ≥ start_date). Use either the date field or this start_date + end_date pair — never both in the same request.
3387
+ * @format date
3388
+ */
3389
+ end_date?: string;
3390
+ /** Filters by user feedback on each answer. Allowed values: like | dislike */
3391
+ feedback_type?: string;
3392
+ /** Filters to a single chat session ID. */
3393
+ session_id?: string;
3394
+ /**
3395
+ * Inclusive start of a date range. Use either the date field or this start_date + end_date pair — never both in the same request. Required when end_date is provided.
3396
+ * @format date
3397
+ */
3398
+ start_date?: string;
3399
+ /** Filters logs to a single end-user within the tenant. */
3400
+ user_id?: string;
3401
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
3402
+ }
3352
3403
  export class CompanyMetadata<HandleError extends boolean = boolean> {
3353
3404
  protected readonly apiClient: JwtClient<HandleError>;
3354
3405
  constructor(apiClient: JwtClient<HandleError>);
@@ -3988,93 +4039,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
3988
4039
  identifier_type: string;
3989
4040
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
3990
4041
  }
3991
- export class Bridget<HandleError extends boolean = boolean> {
3992
- protected readonly apiClient: JwtClient<HandleError>;
3993
- constructor(apiClient: JwtClient<HandleError>);
3994
- /**
3995
- * @tags Bridget
3996
- * @name QuestionCreate
3997
- * @request POST:/bridget/v2/external/question
3998
- * @secure
3999
- */
4000
- questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
4001
- /**
4002
- * @tags Bridget
4003
- * @name TenantsExportRetrieve
4004
- * @request GET:/bridget/v2/external/tenants/{tenant_id}/export
4005
- * @secure
4006
- */
4007
- tenantsExportRetrieve(tenantId: string, query: {
4008
- /** Client ID for filtering logs */
4009
- client_id?: string;
4010
- /**
4011
- * Date for filtering logs
4012
- * @format date
4013
- */
4014
- date: string;
4015
- /**
4016
- * End date for filtering logs
4017
- * @format date
4018
- */
4019
- end_date: string;
4020
- /** Feedback type for filtering logs */
4021
- feedback_type?: string;
4022
- /** Session ID for filtering logs */
4023
- session_id?: string;
4024
- /**
4025
- * Start date for filtering logs
4026
- * @format date
4027
- */
4028
- start_date: string;
4029
- /** User ID for filtering logs */
4030
- user_id?: string;
4031
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
4032
- }
4033
- export class Logos<HandleError extends boolean = boolean> {
4034
- protected readonly apiClient: JwtClient<HandleError>;
4035
- constructor(apiClient: JwtClient<HandleError>);
4036
- /**
4037
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
4038
- * @tags Logos
4039
- * @name FetchLogos
4040
- * @summary Fetch Logos
4041
- * @request GET:/companies/logos
4042
- * @secure
4043
- */
4044
- fetchLogos(query?: {
4045
- /**
4046
- * Company Id In
4047
- * Specify a list of BW identifiers for bulk queries.
4048
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4049
- * @example "74822,83343211"
4050
- */
4051
- company_id__in?: string;
4052
- /**
4053
- * Size
4054
- * Page size
4055
- * @min 1
4056
- * @max 100
4057
- * @default 50
4058
- */
4059
- size?: number;
4060
- /**
4061
- * Page
4062
- * Page number
4063
- * @min 1
4064
- * @default 1
4065
- */
4066
- page?: number;
4067
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
4068
- /**
4069
- * @description Retrieves the logo for a specified company using the provided company_id.
4070
- * @tags Logos
4071
- * @name FetchLogo
4072
- * @summary Fetch Logo
4073
- * @request GET:/companies/{company_id}/logos
4074
- * @secure
4075
- */
4076
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
4077
- }
4078
4042
  export class Activities<HandleError extends boolean = boolean> {
4079
4043
  protected readonly apiClient: JwtClient<HandleError>;
4080
4044
  constructor(apiClient: JwtClient<HandleError>);
@@ -4200,6 +4164,51 @@ export class EarningCalls<HandleError extends boolean = boolean> {
4200
4164
  type?: BridgeWiseEarningsCallRecapEnum;
4201
4165
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
4202
4166
  }
4167
+ export class Logos<HandleError extends boolean = boolean> {
4168
+ protected readonly apiClient: JwtClient<HandleError>;
4169
+ constructor(apiClient: JwtClient<HandleError>);
4170
+ /**
4171
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
4172
+ * @tags Logos
4173
+ * @name FetchLogos
4174
+ * @summary Fetch Logos
4175
+ * @request GET:/companies/logos
4176
+ * @secure
4177
+ */
4178
+ fetchLogos(query?: {
4179
+ /**
4180
+ * Company Id In
4181
+ * Specify a list of BW identifiers for bulk queries.
4182
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4183
+ * @example "74822,83343211"
4184
+ */
4185
+ company_id__in?: string;
4186
+ /**
4187
+ * Size
4188
+ * Page size
4189
+ * @min 1
4190
+ * @max 100
4191
+ * @default 50
4192
+ */
4193
+ size?: number;
4194
+ /**
4195
+ * Page
4196
+ * Page number
4197
+ * @min 1
4198
+ * @default 1
4199
+ */
4200
+ page?: number;
4201
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
4202
+ /**
4203
+ * @description Retrieves the logo for a specified company using the provided company_id.
4204
+ * @tags Logos
4205
+ * @name FetchLogo
4206
+ * @summary Fetch Logo
4207
+ * @request GET:/companies/{company_id}/logos
4208
+ * @secure
4209
+ */
4210
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
4211
+ }
4203
4212
  export class EsgAnalysis<HandleError extends boolean = boolean> {
4204
4213
  protected readonly apiClient: JwtClient<HandleError>;
4205
4214
  constructor(apiClient: JwtClient<HandleError>);
@@ -4305,6 +4314,39 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
4305
4314
  language?: BridgeWiseLanguageEnum;
4306
4315
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
4307
4316
  }
4317
+ export class Forecasts<HandleError extends boolean = boolean> {
4318
+ protected readonly apiClient: JwtClient<HandleError>;
4319
+ constructor(apiClient: JwtClient<HandleError>);
4320
+ /**
4321
+ * @description <b>!!!WILL BE DEPRECATED!!!</b>
4322
+ * @tags Forecasts
4323
+ * @name GetCompanyForecasts
4324
+ * @summary Get Company Forecasts
4325
+ * @request GET:/companies/{company_id}/forecasts
4326
+ * @secure
4327
+ */
4328
+ getCompanyForecasts(companyId: number, query?: {
4329
+ /**
4330
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4331
+ * @default "en-US"
4332
+ */
4333
+ language?: BridgeWiseLanguageEnum;
4334
+ /** Desired forecast type. */
4335
+ forecast_type?: BridgeWiseForecastType;
4336
+ /**
4337
+ * Page
4338
+ * Define the page number for pagination.
4339
+ * @exclusiveMin 0
4340
+ */
4341
+ page?: number;
4342
+ /**
4343
+ * Page Size
4344
+ * Define the number of records per page for pagination purposes.
4345
+ * @exclusiveMin 0
4346
+ */
4347
+ page_size?: number;
4348
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4349
+ }
4308
4350
  export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4309
4351
  protected readonly apiClient: JwtClient<HandleError>;
4310
4352
  constructor(apiClient: JwtClient<HandleError>);
@@ -4446,39 +4488,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4446
4488
  date__lte?: string;
4447
4489
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
4448
4490
  }
4449
- export class Forecasts<HandleError extends boolean = boolean> {
4450
- protected readonly apiClient: JwtClient<HandleError>;
4451
- constructor(apiClient: JwtClient<HandleError>);
4452
- /**
4453
- * @description <b>!!!WILL BE DEPRECATED!!!</b>
4454
- * @tags Forecasts
4455
- * @name GetCompanyForecasts
4456
- * @summary Get Company Forecasts
4457
- * @request GET:/companies/{company_id}/forecasts
4458
- * @secure
4459
- */
4460
- getCompanyForecasts(companyId: number, query?: {
4461
- /**
4462
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4463
- * @default "en-US"
4464
- */
4465
- language?: BridgeWiseLanguageEnum;
4466
- /** Desired forecast type. */
4467
- forecast_type?: BridgeWiseForecastType;
4468
- /**
4469
- * Page
4470
- * Define the page number for pagination.
4471
- * @exclusiveMin 0
4472
- */
4473
- page?: number;
4474
- /**
4475
- * Page Size
4476
- * Define the number of records per page for pagination purposes.
4477
- * @exclusiveMin 0
4478
- */
4479
- page_size?: number;
4480
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4481
- }
4482
4491
  export class CompanyMarketData<HandleError extends boolean = boolean> {
4483
4492
  protected readonly apiClient: JwtClient<HandleError>;
4484
4493
  constructor(apiClient: JwtClient<HandleError>);
@@ -4548,38 +4557,116 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
4548
4557
  security_primary_flag?: boolean;
4549
4558
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4550
4559
  }
4551
- export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4560
+ export class CompanyNews<HandleError extends boolean = boolean> {
4552
4561
  protected readonly apiClient: JwtClient<HandleError>;
4553
4562
  constructor(apiClient: JwtClient<HandleError>);
4554
4563
  /**
4555
- * @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.
4556
- * @tags Technical Analysis
4557
- * @name GetCompanyTechnicalAnalysis
4558
- * @summary Get Company Technical Analysis
4559
- * @request GET:/companies/{company_id}/technical-analysis
4564
+ * @description This endpoint provides news articles related to the specified company.
4565
+ * @tags Company News
4566
+ * @name GetCompanyNews
4567
+ * @summary Get Company News
4568
+ * @request GET:/companies/{company_id}/news
4560
4569
  * @secure
4561
4570
  */
4562
- getCompanyTechnicalAnalysis(companyId: number, query?: {
4571
+ getCompanyNews(companyId: number, query?: {
4563
4572
  /**
4573
+ * Languages
4564
4574
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4565
4575
  * @default "en-US"
4576
+ * @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
4566
4577
  */
4567
- language?: BridgeWiseLanguageEnum;
4578
+ languages?: string;
4568
4579
  /**
4569
- * Trading Item Id
4570
- * Specify a BW trading asset identifier for a targeted query.
4580
+ * Published Date Gte
4581
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4582
+ * @format date
4583
+ * @default "2025-07-22"
4571
4584
  */
4572
- trading_item_id?: number;
4573
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
4574
- /**
4575
- * @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.
4576
- * @tags Technical Analysis
4577
- * @name GetCompanyTechnicalParagraphs
4578
- * @summary Get Company Technical Paragraphs
4579
- * @request GET:/companies/{company_id}/technical-paragraphs
4580
- * @secure
4581
- */
4582
- getCompanyTechnicalParagraphs(companyId: number, query?: {
4585
+ published_date__gte?: string;
4586
+ /**
4587
+ * Published Date Lte
4588
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4589
+ * @format date
4590
+ * @default "2025-07-22"
4591
+ */
4592
+ published_date__lte?: string;
4593
+ /**
4594
+ * Specify the field by which to sort the results.
4595
+ * @default "publication_date"
4596
+ */
4597
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
4598
+ /**
4599
+ * Size
4600
+ * Define the number of records per page for pagination purposes.
4601
+ * @default 10
4602
+ * @example 10
4603
+ */
4604
+ size?: number;
4605
+ /**
4606
+ * Page
4607
+ * Define the page number for pagination.
4608
+ * @default 1
4609
+ * @example 1
4610
+ */
4611
+ page?: number;
4612
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
4613
+ /**
4614
+ * @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.
4615
+ * @tags Company News
4616
+ * @name GetAverageCompanyNewsSentiment
4617
+ * @summary Get Average Company News Sentiment
4618
+ * @request GET:/companies/{company_id}/news-sentiment
4619
+ * @secure
4620
+ */
4621
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
4622
+ /**
4623
+ * Published Date Gte
4624
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4625
+ * @format date
4626
+ * @default "2025-07-22"
4627
+ */
4628
+ published_date__gte?: string;
4629
+ /**
4630
+ * Published Date Lte
4631
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4632
+ * @format date
4633
+ * @default "2025-07-22"
4634
+ */
4635
+ published_date__lte?: string;
4636
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
4637
+ }
4638
+ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4639
+ protected readonly apiClient: JwtClient<HandleError>;
4640
+ constructor(apiClient: JwtClient<HandleError>);
4641
+ /**
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
4647
+ * @secure
4648
+ */
4649
+ getCompanyTechnicalAnalysis(companyId: number, query?: {
4650
+ /**
4651
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4652
+ * @default "en-US"
4653
+ */
4654
+ language?: BridgeWiseLanguageEnum;
4655
+ /**
4656
+ * Trading Item Id
4657
+ * Specify a BW trading asset identifier for a targeted query.
4658
+ */
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?: {
4583
4670
  /**
4584
4671
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4585
4672
  * @default "en-US"
@@ -5370,58 +5457,140 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
5370
5457
  limit?: number;
5371
5458
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
5372
5459
  }
5373
- export class Tenants<HandleError extends boolean = boolean> {
5460
+ export class Segmentations<HandleError extends boolean = boolean> {
5374
5461
  protected readonly apiClient: JwtClient<HandleError>;
5375
5462
  constructor(apiClient: JwtClient<HandleError>);
5376
5463
  /**
5377
- * @tags Tenants
5378
- * @name FetchTenant
5379
- * @summary Fetch Tenant
5380
- * @request GET:/tenants/{tenant_id}
5464
+ * @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.
5465
+ * @tags Segmentations
5466
+ * @name GetSegmentParameters
5467
+ * @summary Get Segment Parameters
5468
+ * @request GET:/funds/{fund_id}/segment-parameters
5381
5469
  * @secure
5382
5470
  */
5383
- fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
5471
+ getSegmentParameters(fundId: number, query?: {
5472
+ /**
5473
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5474
+ * @default "en-US"
5475
+ */
5476
+ language?: BridgeWiseLanguageEnum;
5477
+ /**
5478
+ * Segment
5479
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5480
+ */
5481
+ segment?: string;
5482
+ /**
5483
+ * Segment Type
5484
+ * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5485
+ */
5486
+ segment_type?: string;
5487
+ /** Desired segment parameter type. */
5488
+ parameter_type?: BridgeWiseFundsSegmentParameterEnum;
5489
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
5384
5490
  /**
5385
- * @tags Tenants
5386
- * @name GetHistoricalPolicyChanges
5387
- * @summary Get Historical Policy Changes
5388
- * @request GET:/tenants/{tenant_id}/historical-policy-changes
5491
+ * @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.
5492
+ * @tags Segmentations
5493
+ * @name GetSegment
5494
+ * @summary Get Segment
5495
+ * @request GET:/funds/{fund_id}/segments
5389
5496
  * @secure
5390
5497
  */
5391
- getHistoricalPolicyChanges(tenantId: string, query?: {
5498
+ getSegment(fundId: number, query?: {
5392
5499
  /**
5393
- * Company Ids
5394
- * Specify a list of BW identifiers for bulk queries.
5395
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5396
- * @example "74822,83343211"
5500
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5501
+ * @default "en-US"
5397
5502
  */
5398
- company_ids?: string;
5503
+ language?: BridgeWiseLanguageEnum;
5399
5504
  /**
5400
- * Start Date Gte
5401
- * Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
5402
- * @format date
5505
+ * Segment
5506
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5403
5507
  */
5404
- start_date__gte?: string;
5508
+ segment?: string;
5509
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
5510
+ }
5511
+ export class FundMarketData<HandleError extends boolean = boolean> {
5512
+ protected readonly apiClient: JwtClient<HandleError>;
5513
+ constructor(apiClient: JwtClient<HandleError>);
5514
+ /**
5515
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
5516
+ * @tags Fund Market Data
5517
+ * @name GetFundsMarketData
5518
+ * @summary Get Funds Market Data
5519
+ * @request GET:/funds/{fund_id}/market
5520
+ * @secure
5521
+ */
5522
+ getFundsMarketData(fundId: number, query?: {
5405
5523
  /**
5406
- * End Date Lte
5407
- * Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
5408
- * @format date
5524
+ * Trading Item Id
5525
+ * Specify a BW trading asset identifier for a targeted query.
5409
5526
  */
5410
- end_date__lte?: string;
5527
+ trading_item_id?: number | null;
5411
5528
  /**
5412
- * Current Value
5413
- * Specify the current value reflecting the policy change
5529
+ * Date Ge
5530
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
5414
5531
  */
5415
- current_value?: number | boolean;
5416
- /** Type of event that is being requested. */
5417
- event_type?: BridgeWiseEventTypeEnum;
5532
+ date__ge?: string | null;
5418
5533
  /**
5419
- * Size
5420
- * Define the maximum number of results to retrieve.
5421
- * @default 10
5422
- * @example 10
5534
+ * Date Le
5535
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
5423
5536
  */
5424
- size?: number;
5537
+ date__le?: string | null;
5538
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
5539
+ /**
5540
+ * @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.
5541
+ * @tags Fund Market Data
5542
+ * @name GetFundsMarketStatistics
5543
+ * @summary Get Funds Market Statistics
5544
+ * @request GET:/funds/{fund_id}/market-statistics
5545
+ * @secure
5546
+ */
5547
+ getFundsMarketStatistics(fundId: number, query?: {
5548
+ /**
5549
+ * Trading Item Id
5550
+ * Specify a BW trading asset identifier for a targeted query.
5551
+ */
5552
+ trading_item_id?: number | null;
5553
+ /**
5554
+ * Identifier In
5555
+ * Specify a list of external identifiers.
5556
+ */
5557
+ identifier__in?: string | null;
5558
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
5559
+ /**
5560
+ * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
5561
+ * @tags Fund Market Data
5562
+ * @name GetFundTradingItems
5563
+ * @summary Get Fund Trading Items
5564
+ * @request GET:/funds/{fund_id}/trading-items
5565
+ * @secure
5566
+ */
5567
+ getFundTradingItems(fundId: number, query?: {
5568
+ /**
5569
+ * Primary Flag
5570
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
5571
+ */
5572
+ primary_flag?: boolean;
5573
+ /**
5574
+ * Security Primary Flag
5575
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
5576
+ */
5577
+ security_primary_flag?: boolean;
5578
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
5579
+ }
5580
+ export class TenantIdentifiers<HandleError extends boolean = boolean> {
5581
+ protected readonly apiClient: JwtClient<HandleError>;
5582
+ constructor(apiClient: JwtClient<HandleError>);
5583
+ /**
5584
+ * @description Get list of tenant identifiers
5585
+ * @tags Tenant Identifiers
5586
+ * @name GetTenantIdentifiers
5587
+ * @summary Get Tenant Identifiers
5588
+ * @request GET:/tenants/{tenant_id}/identifiers
5589
+ * @secure
5590
+ */
5591
+ getTenantIdentifiers(tenantId: string, query?: {
5592
+ /** Tenant custom identifier status. */
5593
+ status?: BridgeWiseTenantIdentifierStatusEnum;
5425
5594
  /**
5426
5595
  * Page
5427
5596
  * Define the page number for the results.
@@ -5429,20 +5598,162 @@ export class Tenants<HandleError extends boolean = boolean> {
5429
5598
  * @example 1
5430
5599
  */
5431
5600
  page?: number;
5432
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
5601
+ /**
5602
+ * Page Size
5603
+ * Define the maximum number of results to retrieve.
5604
+ * @default 20
5605
+ * @example 10
5606
+ */
5607
+ page_size?: number;
5608
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
5433
5609
  /**
5434
- * @tags Tenants
5435
- * @name CreateTenantInvestmentPoliciesConfig
5436
- * @summary Create Tenant Investment Policies Config
5437
- * @request POST:/tenants/{tenant_id}/investment-policies-config
5610
+ * @description Create a new identifier for a tenant
5611
+ * @tags Tenant Identifiers
5612
+ * @name CreateTenantIdentifier
5613
+ * @summary Create Tenant Identifier
5614
+ * @request POST:/tenants/{tenant_id}/identifiers
5438
5615
  * @secure
5439
5616
  */
5440
- createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
5617
+ createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5441
5618
  /**
5442
- * @tags Tenants
5443
- * @name ListTenantInvestmentPoliciesConfigs
5444
- * @summary List Tenant Investment Policies Configs
5445
- * @request GET:/tenants/{tenant_id}/investment-policies-config
5619
+ * @description Update an existing identifier for a tenant
5620
+ * @tags Tenant Identifiers
5621
+ * @name UpdateTenantIdentifier
5622
+ * @summary Update Tenant Identifier
5623
+ * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
5624
+ * @secure
5625
+ */
5626
+ updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5627
+ /**
5628
+ * @description Delete identifier for a tenant
5629
+ * @tags Tenant Identifiers
5630
+ * @name DeleteTenantIdentifier
5631
+ * @summary Delete Tenant Identifier
5632
+ * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
5633
+ * @secure
5634
+ */
5635
+ deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5636
+ }
5637
+ export class Users<HandleError extends boolean = boolean> {
5638
+ protected readonly apiClient: JwtClient<HandleError>;
5639
+ constructor(apiClient: JwtClient<HandleError>);
5640
+ /**
5641
+ * @tags Users
5642
+ * @name Authenticate
5643
+ * @summary Authenticate
5644
+ * @request POST:/users/authenticate
5645
+ * @secure
5646
+ */
5647
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
5648
+ /**
5649
+ * @tags Users
5650
+ * @name FetchClientDetails
5651
+ * @summary Fetch Client Details
5652
+ * @request GET:/users/machine
5653
+ * @secure
5654
+ */
5655
+ fetchClientDetails(headers: {
5656
+ /** Authorization */
5657
+ authorization: string;
5658
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
5659
+ }
5660
+ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5661
+ protected readonly apiClient: JwtClient<HandleError>;
5662
+ constructor(apiClient: JwtClient<HandleError>);
5663
+ /**
5664
+ * @description Provide the user all the minimum required data for the fund ESG score.
5665
+ * @tags Fund ESG Analysis
5666
+ * @name GetFundEsgAnalysis
5667
+ * @summary Get Fund Esg Analysis
5668
+ * @request GET:/funds/{fund_id}/esg-analysis
5669
+ * @secure
5670
+ */
5671
+ getFundEsgAnalysis(fundId: number, query?: {
5672
+ /**
5673
+ * Limit
5674
+ * Number of historical periods to be returned (default is 1).
5675
+ */
5676
+ limit?: number;
5677
+ /**
5678
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5679
+ * @default "en-US"
5680
+ */
5681
+ language?: BridgeWiseLanguageEnum;
5682
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5683
+ }
5684
+ export class Tenants<HandleError extends boolean = boolean> {
5685
+ protected readonly apiClient: JwtClient<HandleError>;
5686
+ constructor(apiClient: JwtClient<HandleError>);
5687
+ /**
5688
+ * @tags Tenants
5689
+ * @name FetchTenant
5690
+ * @summary Fetch Tenant
5691
+ * @request GET:/tenants/{tenant_id}
5692
+ * @secure
5693
+ */
5694
+ fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
5695
+ /**
5696
+ * @tags Tenants
5697
+ * @name GetHistoricalPolicyChanges
5698
+ * @summary Get Historical Policy Changes
5699
+ * @request GET:/tenants/{tenant_id}/historical-policy-changes
5700
+ * @secure
5701
+ */
5702
+ getHistoricalPolicyChanges(tenantId: string, query?: {
5703
+ /**
5704
+ * Company Ids
5705
+ * Specify a list of BW identifiers for bulk queries.
5706
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5707
+ * @example "74822,83343211"
5708
+ */
5709
+ company_ids?: string;
5710
+ /**
5711
+ * Start Date Gte
5712
+ * Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
5713
+ * @format date
5714
+ */
5715
+ start_date__gte?: string;
5716
+ /**
5717
+ * End Date Lte
5718
+ * Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
5719
+ * @format date
5720
+ */
5721
+ end_date__lte?: string;
5722
+ /**
5723
+ * Current Value
5724
+ * Specify the current value reflecting the policy change
5725
+ */
5726
+ current_value?: number | boolean;
5727
+ /** Type of event that is being requested. */
5728
+ event_type?: BridgeWiseEventTypeEnum;
5729
+ /**
5730
+ * Size
5731
+ * Define the maximum number of results to retrieve.
5732
+ * @default 10
5733
+ * @example 10
5734
+ */
5735
+ size?: number;
5736
+ /**
5737
+ * Page
5738
+ * Define the page number for the results.
5739
+ * @default 1
5740
+ * @example 1
5741
+ */
5742
+ page?: number;
5743
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
5744
+ /**
5745
+ * @tags Tenants
5746
+ * @name CreateTenantInvestmentPoliciesConfig
5747
+ * @summary Create Tenant Investment Policies Config
5748
+ * @request POST:/tenants/{tenant_id}/investment-policies-config
5749
+ * @secure
5750
+ */
5751
+ createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
5752
+ /**
5753
+ * @tags Tenants
5754
+ * @name ListTenantInvestmentPoliciesConfigs
5755
+ * @summary List Tenant Investment Policies Configs
5756
+ * @request GET:/tenants/{tenant_id}/investment-policies-config
5446
5757
  * @secure
5447
5758
  */
5448
5759
  listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
@@ -5543,308 +5854,6 @@ export class Tenants<HandleError extends boolean = boolean> {
5543
5854
  */
5544
5855
  deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5545
5856
  }
5546
- export class TenantIdentifiers<HandleError extends boolean = boolean> {
5547
- protected readonly apiClient: JwtClient<HandleError>;
5548
- constructor(apiClient: JwtClient<HandleError>);
5549
- /**
5550
- * @description Get list of tenant identifiers
5551
- * @tags Tenant Identifiers
5552
- * @name GetTenantIdentifiers
5553
- * @summary Get Tenant Identifiers
5554
- * @request GET:/tenants/{tenant_id}/identifiers
5555
- * @secure
5556
- */
5557
- getTenantIdentifiers(tenantId: string, query?: {
5558
- /** Tenant custom identifier status. */
5559
- status?: BridgeWiseTenantIdentifierStatusEnum;
5560
- /**
5561
- * Page
5562
- * Define the page number for the results.
5563
- * @default 1
5564
- * @example 1
5565
- */
5566
- page?: number;
5567
- /**
5568
- * Page Size
5569
- * Define the maximum number of results to retrieve.
5570
- * @default 20
5571
- * @example 10
5572
- */
5573
- page_size?: number;
5574
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
5575
- /**
5576
- * @description Create a new identifier for a tenant
5577
- * @tags Tenant Identifiers
5578
- * @name CreateTenantIdentifier
5579
- * @summary Create Tenant Identifier
5580
- * @request POST:/tenants/{tenant_id}/identifiers
5581
- * @secure
5582
- */
5583
- createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5584
- /**
5585
- * @description Update an existing identifier for a tenant
5586
- * @tags Tenant Identifiers
5587
- * @name UpdateTenantIdentifier
5588
- * @summary Update Tenant Identifier
5589
- * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
5590
- * @secure
5591
- */
5592
- updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5593
- /**
5594
- * @description Delete identifier for a tenant
5595
- * @tags Tenant Identifiers
5596
- * @name DeleteTenantIdentifier
5597
- * @summary Delete Tenant Identifier
5598
- * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
5599
- * @secure
5600
- */
5601
- deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5602
- }
5603
- export class Segmentations<HandleError extends boolean = boolean> {
5604
- protected readonly apiClient: JwtClient<HandleError>;
5605
- constructor(apiClient: JwtClient<HandleError>);
5606
- /**
5607
- * @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.
5608
- * @tags Segmentations
5609
- * @name GetSegmentParameters
5610
- * @summary Get Segment Parameters
5611
- * @request GET:/funds/{fund_id}/segment-parameters
5612
- * @secure
5613
- */
5614
- getSegmentParameters(fundId: number, query?: {
5615
- /**
5616
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5617
- * @default "en-US"
5618
- */
5619
- language?: BridgeWiseLanguageEnum;
5620
- /**
5621
- * Segment
5622
- * Filter data by specific segments within the fund holdings (e.g., sector, region).
5623
- */
5624
- segment?: string;
5625
- /**
5626
- * Segment Type
5627
- * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5628
- */
5629
- segment_type?: string;
5630
- /** Desired segment parameter type. */
5631
- parameter_type?: BridgeWiseFundsSegmentParameterEnum;
5632
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
5633
- /**
5634
- * @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.
5635
- * @tags Segmentations
5636
- * @name GetSegment
5637
- * @summary Get Segment
5638
- * @request GET:/funds/{fund_id}/segments
5639
- * @secure
5640
- */
5641
- getSegment(fundId: number, query?: {
5642
- /**
5643
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5644
- * @default "en-US"
5645
- */
5646
- language?: BridgeWiseLanguageEnum;
5647
- /**
5648
- * Segment
5649
- * Filter data by specific segments within the fund holdings (e.g., sector, region).
5650
- */
5651
- segment?: string;
5652
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
5653
- }
5654
- export class Users<HandleError extends boolean = boolean> {
5655
- protected readonly apiClient: JwtClient<HandleError>;
5656
- constructor(apiClient: JwtClient<HandleError>);
5657
- /**
5658
- * @tags Users
5659
- * @name Authenticate
5660
- * @summary Authenticate
5661
- * @request POST:/users/authenticate
5662
- * @secure
5663
- */
5664
- authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
5665
- /**
5666
- * @tags Users
5667
- * @name FetchClientDetails
5668
- * @summary Fetch Client Details
5669
- * @request GET:/users/machine
5670
- * @secure
5671
- */
5672
- fetchClientDetails(headers: {
5673
- /** Authorization */
5674
- authorization: string;
5675
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
5676
- }
5677
- export class FundMarketData<HandleError extends boolean = boolean> {
5678
- protected readonly apiClient: JwtClient<HandleError>;
5679
- constructor(apiClient: JwtClient<HandleError>);
5680
- /**
5681
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
5682
- * @tags Fund Market Data
5683
- * @name GetFundsMarketData
5684
- * @summary Get Funds Market Data
5685
- * @request GET:/funds/{fund_id}/market
5686
- * @secure
5687
- */
5688
- getFundsMarketData(fundId: number, query?: {
5689
- /**
5690
- * Trading Item Id
5691
- * Specify a BW trading asset identifier for a targeted query.
5692
- */
5693
- trading_item_id?: number | null;
5694
- /**
5695
- * Date Ge
5696
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
5697
- */
5698
- date__ge?: string | null;
5699
- /**
5700
- * Date Le
5701
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
5702
- */
5703
- date__le?: string | null;
5704
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
5705
- /**
5706
- * @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.
5707
- * @tags Fund Market Data
5708
- * @name GetFundsMarketStatistics
5709
- * @summary Get Funds Market Statistics
5710
- * @request GET:/funds/{fund_id}/market-statistics
5711
- * @secure
5712
- */
5713
- getFundsMarketStatistics(fundId: number, query?: {
5714
- /**
5715
- * Trading Item Id
5716
- * Specify a BW trading asset identifier for a targeted query.
5717
- */
5718
- trading_item_id?: number | null;
5719
- /**
5720
- * Identifier In
5721
- * Specify a list of external identifiers.
5722
- */
5723
- identifier__in?: string | null;
5724
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
5725
- /**
5726
- * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
5727
- * @tags Fund Market Data
5728
- * @name GetFundTradingItems
5729
- * @summary Get Fund Trading Items
5730
- * @request GET:/funds/{fund_id}/trading-items
5731
- * @secure
5732
- */
5733
- getFundTradingItems(fundId: number, query?: {
5734
- /**
5735
- * Primary Flag
5736
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
5737
- */
5738
- primary_flag?: boolean;
5739
- /**
5740
- * Security Primary Flag
5741
- * Boolean flag. Indicate if only primary asset data is required (true/false).
5742
- */
5743
- security_primary_flag?: boolean;
5744
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
5745
- }
5746
- export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5747
- protected readonly apiClient: JwtClient<HandleError>;
5748
- constructor(apiClient: JwtClient<HandleError>);
5749
- /**
5750
- * @description Provide the user all the minimum required data for the fund ESG score.
5751
- * @tags Fund ESG Analysis
5752
- * @name GetFundEsgAnalysis
5753
- * @summary Get Fund Esg Analysis
5754
- * @request GET:/funds/{fund_id}/esg-analysis
5755
- * @secure
5756
- */
5757
- getFundEsgAnalysis(fundId: number, query?: {
5758
- /**
5759
- * Limit
5760
- * Number of historical periods to be returned (default is 1).
5761
- */
5762
- limit?: number;
5763
- /**
5764
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5765
- * @default "en-US"
5766
- */
5767
- language?: BridgeWiseLanguageEnum;
5768
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5769
- }
5770
- export class CompanyNews<HandleError extends boolean = boolean> {
5771
- protected readonly apiClient: JwtClient<HandleError>;
5772
- constructor(apiClient: JwtClient<HandleError>);
5773
- /**
5774
- * @description This endpoint provides news articles related to the specified company.
5775
- * @tags Company News
5776
- * @name GetCompanyNews
5777
- * @summary Get Company News
5778
- * @request GET:/companies/{company_id}/news
5779
- * @secure
5780
- */
5781
- getCompanyNews(companyId: number, query?: {
5782
- /**
5783
- * Languages
5784
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5785
- * @default "en-US"
5786
- * @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))*$
5787
- */
5788
- languages?: string;
5789
- /**
5790
- * Published Date Gte
5791
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
5792
- * @format date
5793
- * @default "2025-07-07"
5794
- */
5795
- published_date__gte?: string;
5796
- /**
5797
- * Published Date Lte
5798
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
5799
- * @format date
5800
- * @default "2025-07-07"
5801
- */
5802
- published_date__lte?: string;
5803
- /**
5804
- * Specify the field by which to sort the results.
5805
- * @default "publication_date"
5806
- */
5807
- sort_by?: BridgeWiseCompanyNewsSortingEnum;
5808
- /**
5809
- * Size
5810
- * Define the number of records per page for pagination purposes.
5811
- * @default 10
5812
- * @example 10
5813
- */
5814
- size?: number;
5815
- /**
5816
- * Page
5817
- * Define the page number for pagination.
5818
- * @default 1
5819
- * @example 1
5820
- */
5821
- page?: number;
5822
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
5823
- /**
5824
- * @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.
5825
- * @tags Company News
5826
- * @name GetAverageCompanyNewsSentiment
5827
- * @summary Get Average Company News Sentiment
5828
- * @request GET:/companies/{company_id}/news-sentiment
5829
- * @secure
5830
- */
5831
- getAverageCompanyNewsSentiment(companyId: number, query?: {
5832
- /**
5833
- * Published Date Gte
5834
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
5835
- * @format date
5836
- * @default "2025-07-07"
5837
- */
5838
- published_date__gte?: string;
5839
- /**
5840
- * Published Date Lte
5841
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
5842
- * @format date
5843
- * @default "2025-07-07"
5844
- */
5845
- published_date__lte?: string;
5846
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
5847
- }
5848
5857
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
5849
5858
  readonly config: JwtClientConfig<HandleError>;
5850
5859
  activities: Activities<HandleError>;