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

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 (43) hide show
  1. package/dist/aesmidas/index.d.ts +39 -39
  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 +313 -304
  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 +774 -521
  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/middleware/index.d.ts +30 -30
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +1501 -1501
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +452 -452
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +563 -563
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. 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: 7f6ea4ed-1702-454a-9ee7-0c49efcb014b
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;
@@ -3022,6 +3031,48 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
3022
3031
  Iso = "iso",
3023
3032
  Epoch = "epoch"
3024
3033
  }
3034
+ export class Bridget<HandleError extends boolean = boolean> {
3035
+ protected readonly apiClient: JwtClient<HandleError>;
3036
+ constructor(apiClient: JwtClient<HandleError>);
3037
+ /**
3038
+ * @tags Bridget
3039
+ * @name QuestionCreate
3040
+ * @request POST:/bridget/question
3041
+ * @secure
3042
+ */
3043
+ questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
3044
+ /**
3045
+ * @tags Bridget
3046
+ * @name TenantsExportRetrieve
3047
+ * @request GET:/bridget/tenants/{tenant_id}/export
3048
+ * @secure
3049
+ */
3050
+ tenantsExportRetrieve(tenantId: string, query?: {
3051
+ /** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
3052
+ client_id?: string;
3053
+ /**
3054
+ * 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.
3055
+ * @format date
3056
+ */
3057
+ date?: string;
3058
+ /**
3059
+ * 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.
3060
+ * @format date
3061
+ */
3062
+ end_date?: string;
3063
+ /** Filters by user feedback on each answer. Allowed values: like | dislike */
3064
+ feedback_type?: string;
3065
+ /** Filters to a single chat session ID. */
3066
+ session_id?: string;
3067
+ /**
3068
+ * 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.
3069
+ * @format date
3070
+ */
3071
+ start_date?: string;
3072
+ /** Filters logs to a single end-user within the tenant. */
3073
+ user_id?: string;
3074
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
3075
+ }
3025
3076
  export class Bwc<HandleError extends boolean = boolean> {
3026
3077
  protected readonly apiClient: JwtClient<HandleError>;
3027
3078
  constructor(apiClient: JwtClient<HandleError>);
@@ -3988,48 +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
4042
  export class Logos<HandleError extends boolean = boolean> {
4034
4043
  protected readonly apiClient: JwtClient<HandleError>;
4035
4044
  constructor(apiClient: JwtClient<HandleError>);
@@ -4305,6 +4314,108 @@ 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
+ }
4350
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
4351
+ protected readonly apiClient: JwtClient<HandleError>;
4352
+ constructor(apiClient: JwtClient<HandleError>);
4353
+ /**
4354
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
4355
+ * @tags Company Market Data
4356
+ * @name GetCompanyMarketData
4357
+ * @summary Get Company Market Data
4358
+ * @request GET:/companies/{company_id}/market
4359
+ * @secure
4360
+ */
4361
+ getCompanyMarketData(companyId: number, query?: {
4362
+ /**
4363
+ * Trading Item Id
4364
+ * Specify a BW trading asset identifier for a targeted query.
4365
+ */
4366
+ trading_item_id?: number | null;
4367
+ /**
4368
+ * Date Ge
4369
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4370
+ */
4371
+ date__ge?: string | null;
4372
+ /**
4373
+ * Date Le
4374
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4375
+ */
4376
+ date__le?: string | null;
4377
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
4378
+ /**
4379
+ * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
4380
+ * @tags Company Market Data
4381
+ * @name GetCompanyMarketStatistics
4382
+ * @summary Get Company Market Statistics
4383
+ * @request GET:/companies/{company_id}/market-statistics
4384
+ * @secure
4385
+ */
4386
+ getCompanyMarketStatistics(companyId: number, query?: {
4387
+ /**
4388
+ * Trading Item Id
4389
+ * Specify a BW trading asset identifier for a targeted query.
4390
+ */
4391
+ trading_item_id?: number | null;
4392
+ /**
4393
+ * Identifier In
4394
+ * Specify a list of external identifiers.
4395
+ */
4396
+ identifier__in?: string | null;
4397
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
4398
+ /**
4399
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
4400
+ * @tags Company Market Data
4401
+ * @name GetTradingItems
4402
+ * @summary Get Trading Items
4403
+ * @request GET:/companies/{company_id}/trading-items
4404
+ * @secure
4405
+ */
4406
+ getTradingItems(companyId: number, query?: {
4407
+ /**
4408
+ * Primary Flag
4409
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
4410
+ */
4411
+ primary_flag?: boolean;
4412
+ /**
4413
+ * Security Primary Flag
4414
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
4415
+ */
4416
+ security_primary_flag?: boolean;
4417
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4418
+ }
4308
4419
  export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4309
4420
  protected readonly apiClient: JwtClient<HandleError>;
4310
4421
  constructor(apiClient: JwtClient<HandleError>);
@@ -4446,107 +4557,104 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4446
4557
  date__lte?: string;
4447
4558
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
4448
4559
  }
4449
- export class Forecasts<HandleError extends boolean = boolean> {
4560
+ export class CompanyNews<HandleError extends boolean = boolean> {
4450
4561
  protected readonly apiClient: JwtClient<HandleError>;
4451
4562
  constructor(apiClient: JwtClient<HandleError>);
4452
4563
  /**
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
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
4458
4569
  * @secure
4459
4570
  */
4460
- getCompanyForecasts(companyId: number, query?: {
4571
+ getCompanyNews(companyId: number, query?: {
4461
4572
  /**
4573
+ * Languages
4462
4574
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4463
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))*$
4464
4577
  */
4465
- language?: BridgeWiseLanguageEnum;
4466
- /** Desired forecast type. */
4467
- forecast_type?: BridgeWiseForecastType;
4578
+ languages?: string;
4468
4579
  /**
4469
- * Page
4470
- * Define the page number for pagination.
4471
- * @exclusiveMin 0
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"
4472
4584
  */
4473
- page?: number;
4585
+ published_date__gte?: string;
4474
4586
  /**
4475
- * Page Size
4476
- * Define the number of records per page for pagination purposes.
4477
- * @exclusiveMin 0
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"
4478
4591
  */
4479
- page_size?: number;
4480
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4481
- }
4482
- export class CompanyMarketData<HandleError extends boolean = boolean> {
4483
- protected readonly apiClient: JwtClient<HandleError>;
4484
- constructor(apiClient: JwtClient<HandleError>);
4485
- /**
4486
- * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
4487
- * @tags Company Market Data
4488
- * @name GetCompanyMarketData
4489
- * @summary Get Company Market Data
4490
- * @request GET:/companies/{company_id}/market
4491
- * @secure
4492
- */
4493
- getCompanyMarketData(companyId: number, query?: {
4592
+ published_date__lte?: string;
4494
4593
  /**
4495
- * Trading Item Id
4496
- * Specify a BW trading asset identifier for a targeted query.
4594
+ * Specify the field by which to sort the results.
4595
+ * @default "publication_date"
4497
4596
  */
4498
- trading_item_id?: number | null;
4597
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
4499
4598
  /**
4500
- * Date Ge
4501
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4599
+ * Size
4600
+ * Define the number of records per page for pagination purposes.
4601
+ * @default 10
4602
+ * @example 10
4502
4603
  */
4503
- date__ge?: string | null;
4604
+ size?: number;
4504
4605
  /**
4505
- * Date Le
4506
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4606
+ * Page
4607
+ * Define the page number for pagination.
4608
+ * @default 1
4609
+ * @example 1
4507
4610
  */
4508
- date__le?: string | null;
4509
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
4611
+ page?: number;
4612
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
4510
4613
  /**
4511
- * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
4512
- * @tags Company Market Data
4513
- * @name GetCompanyMarketStatistics
4514
- * @summary Get Company Market Statistics
4515
- * @request GET:/companies/{company_id}/market-statistics
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
4516
4619
  * @secure
4517
4620
  */
4518
- getCompanyMarketStatistics(companyId: number, query?: {
4621
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
4519
4622
  /**
4520
- * Trading Item Id
4521
- * Specify a BW trading asset identifier for a targeted query.
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"
4522
4627
  */
4523
- trading_item_id?: number | null;
4628
+ published_date__gte?: string;
4524
4629
  /**
4525
- * Identifier In
4526
- * Specify a list of external identifiers.
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"
4527
4634
  */
4528
- identifier__in?: string | null;
4529
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
4635
+ published_date__lte?: string;
4636
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
4637
+ }
4638
+ export class Metadata<HandleError extends boolean = boolean> {
4639
+ protected readonly apiClient: JwtClient<HandleError>;
4640
+ constructor(apiClient: JwtClient<HandleError>);
4530
4641
  /**
4531
- * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
4532
- * @tags Company Market Data
4533
- * @name GetTradingItems
4534
- * @summary Get Trading Items
4535
- * @request GET:/companies/{company_id}/trading-items
4642
+ * @description This endpoint provides filters
4643
+ * @tags Metadata
4644
+ * @name GetCompanyFilters
4645
+ * @summary Get Company Filters
4646
+ * @request GET:/filters
4536
4647
  * @secure
4537
4648
  */
4538
- getTradingItems(companyId: number, query?: {
4539
- /**
4540
- * Primary Flag
4541
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
4542
- */
4543
- primary_flag?: boolean;
4649
+ getCompanyFilters(query: {
4650
+ /** Desired filter type. */
4651
+ type: BridgeWiseCompanyFilterType;
4544
4652
  /**
4545
- * Security Primary Flag
4546
- * Boolean flag. Indicate if only primary asset data is required (true/false).
4653
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4654
+ * @default "en-US"
4547
4655
  */
4548
- security_primary_flag?: boolean;
4549
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4656
+ language?: BridgeWiseLanguageEnum;
4657
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
4550
4658
  }
4551
4659
  export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4552
4660
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4735,27 +4843,6 @@ export class Themes<HandleError extends boolean = boolean> {
4735
4843
  */
4736
4844
  getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
4737
4845
  }
4738
- export class Metadata<HandleError extends boolean = boolean> {
4739
- protected readonly apiClient: JwtClient<HandleError>;
4740
- constructor(apiClient: JwtClient<HandleError>);
4741
- /**
4742
- * @description This endpoint provides filters
4743
- * @tags Metadata
4744
- * @name GetCompanyFilters
4745
- * @summary Get Company Filters
4746
- * @request GET:/filters
4747
- * @secure
4748
- */
4749
- getCompanyFilters(query: {
4750
- /** Desired filter type. */
4751
- type: BridgeWiseCompanyFilterType;
4752
- /**
4753
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4754
- * @default "en-US"
4755
- */
4756
- language?: BridgeWiseLanguageEnum;
4757
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
4758
- }
4759
4846
  export class FundMetadata<HandleError extends boolean = boolean> {
4760
4847
  protected readonly apiClient: JwtClient<HandleError>;
4761
4848
  constructor(apiClient: JwtClient<HandleError>);
@@ -5251,90 +5338,56 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
5251
5338
  show_all?: boolean;
5252
5339
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
5253
5340
  }
5254
- export class Holdings<HandleError extends boolean = boolean> {
5341
+ export class Segmentations<HandleError extends boolean = boolean> {
5255
5342
  protected readonly apiClient: JwtClient<HandleError>;
5256
5343
  constructor(apiClient: JwtClient<HandleError>);
5257
5344
  /**
5258
- * @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.
5259
- * @tags Holdings
5260
- * @name GetCompositions
5261
- * @summary Get Compositions
5262
- * @request GET:/funds/{fund_id}/compositions
5263
- * @secure
5264
- */
5265
- getCompositions(fundId: number, query?: {
5266
- /**
5267
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5268
- * @default "en-US"
5269
- */
5270
- language?: BridgeWiseLanguageEnum;
5271
- /** Filter data by specific components of the fund composition (e.g., stocks, others). */
5272
- composition_type?: BridgeWiseCompositionTypeEnum;
5273
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
5274
- /**
5275
- * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
5276
- * @tags Holdings
5277
- * @name GetHoldingStatistics
5278
- * @summary Get Holding Statistics
5279
- * @request GET:/funds/{fund_id}/holding-statistics
5345
+ * @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.
5346
+ * @tags Segmentations
5347
+ * @name GetSegmentParameters
5348
+ * @summary Get Segment Parameters
5349
+ * @request GET:/funds/{fund_id}/segment-parameters
5280
5350
  * @secure
5281
5351
  */
5282
- getHoldingStatistics(fundId: number, query?: {
5352
+ getSegmentParameters(fundId: number, query?: {
5283
5353
  /**
5284
5354
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5285
5355
  * @default "en-US"
5286
5356
  */
5287
5357
  language?: BridgeWiseLanguageEnum;
5288
5358
  /**
5289
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5290
- * @default "stocks"
5291
- */
5292
- composition_type?: BridgeWiseCompositionTypeEnum;
5293
- /**
5294
- * Page
5295
- * Define the page number for pagination.
5296
- * @exclusiveMin 0
5359
+ * Segment
5360
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5297
5361
  */
5298
- page?: number;
5362
+ segment?: string;
5299
5363
  /**
5300
- * Page Size
5301
- * Define the number of records per page for pagination purposes.
5302
- * @exclusiveMin 0
5364
+ * Segment Type
5365
+ * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5303
5366
  */
5304
- page_size?: number;
5305
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5367
+ segment_type?: string;
5368
+ /** Desired segment parameter type. */
5369
+ parameter_type?: BridgeWiseFundsSegmentParameterEnum;
5370
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
5306
5371
  /**
5307
- * @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.
5308
- * @tags Holdings
5309
- * @name GetHoldings
5310
- * @summary Get Holdings
5311
- * @request GET:/funds/{fund_id}/holdings
5372
+ * @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.
5373
+ * @tags Segmentations
5374
+ * @name GetSegment
5375
+ * @summary Get Segment
5376
+ * @request GET:/funds/{fund_id}/segments
5312
5377
  * @secure
5313
5378
  */
5314
- getHoldings(fundId: number, query?: {
5379
+ getSegment(fundId: number, query?: {
5315
5380
  /**
5316
5381
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5317
5382
  * @default "en-US"
5318
5383
  */
5319
5384
  language?: BridgeWiseLanguageEnum;
5320
5385
  /**
5321
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5322
- * @default "stocks"
5323
- */
5324
- composition_type?: BridgeWiseCompositionTypeEnum;
5325
- /**
5326
- * Page
5327
- * Define the page number for pagination.
5328
- * @exclusiveMin 0
5329
- */
5330
- page?: number;
5331
- /**
5332
- * Page Size
5333
- * Define the number of records per page for pagination purposes.
5334
- * @exclusiveMin 0
5386
+ * Segment
5387
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5335
5388
  */
5336
- page_size?: number;
5337
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5389
+ segment?: string;
5390
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
5338
5391
  }
5339
5392
  export class SectorAnalysis<HandleError extends boolean = boolean> {
5340
5393
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5600,56 +5653,29 @@ export class TenantIdentifiers<HandleError extends boolean = boolean> {
5600
5653
  */
5601
5654
  deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5602
5655
  }
5603
- export class Segmentations<HandleError extends boolean = boolean> {
5656
+ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5604
5657
  protected readonly apiClient: JwtClient<HandleError>;
5605
5658
  constructor(apiClient: JwtClient<HandleError>);
5606
5659
  /**
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
5660
+ * @description Provide the user all the minimum required data for the fund ESG score.
5661
+ * @tags Fund ESG Analysis
5662
+ * @name GetFundEsgAnalysis
5663
+ * @summary Get Fund Esg Analysis
5664
+ * @request GET:/funds/{fund_id}/esg-analysis
5612
5665
  * @secure
5613
5666
  */
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;
5667
+ getFundEsgAnalysis(fundId: number, query?: {
5625
5668
  /**
5626
- * Segment Type
5627
- * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5669
+ * Limit
5670
+ * Number of historical periods to be returned (default is 1).
5628
5671
  */
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?: {
5672
+ limit?: number;
5642
5673
  /**
5643
5674
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5644
5675
  * @default "en-US"
5645
5676
  */
5646
5677
  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>>;
5678
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5653
5679
  }
5654
5680
  export class Users<HandleError extends boolean = boolean> {
5655
5681
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5743,107 +5769,90 @@ export class FundMarketData<HandleError extends boolean = boolean> {
5743
5769
  security_primary_flag?: boolean;
5744
5770
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
5745
5771
  }
5746
- export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5772
+ export class Holdings<HandleError extends boolean = boolean> {
5747
5773
  protected readonly apiClient: JwtClient<HandleError>;
5748
5774
  constructor(apiClient: JwtClient<HandleError>);
5749
5775
  /**
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
5776
+ * @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
5777
+ * @tags Holdings
5778
+ * @name GetCompositions
5779
+ * @summary Get Compositions
5780
+ * @request GET:/funds/{fund_id}/compositions
5755
5781
  * @secure
5756
5782
  */
5757
- getFundEsgAnalysis(fundId: number, query?: {
5758
- /**
5759
- * Limit
5760
- * Number of historical periods to be returned (default is 1).
5761
- */
5762
- limit?: number;
5783
+ getCompositions(fundId: number, query?: {
5763
5784
  /**
5764
5785
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5765
5786
  * @default "en-US"
5766
5787
  */
5767
5788
  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>);
5789
+ /** Filter data by specific components of the fund composition (e.g., stocks, others). */
5790
+ composition_type?: BridgeWiseCompositionTypeEnum;
5791
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
5773
5792
  /**
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
5793
+ * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
5794
+ * @tags Holdings
5795
+ * @name GetHoldingStatistics
5796
+ * @summary Get Holding Statistics
5797
+ * @request GET:/funds/{fund_id}/holding-statistics
5779
5798
  * @secure
5780
5799
  */
5781
- getCompanyNews(companyId: number, query?: {
5800
+ getHoldingStatistics(fundId: number, query?: {
5782
5801
  /**
5783
- * Languages
5784
5802
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5785
5803
  * @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
5804
  */
5788
- languages?: string;
5805
+ language?: BridgeWiseLanguageEnum;
5789
5806
  /**
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"
5807
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5808
+ * @default "stocks"
5794
5809
  */
5795
- published_date__gte?: string;
5810
+ composition_type?: BridgeWiseCompositionTypeEnum;
5796
5811
  /**
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"
5812
+ * Page
5813
+ * Define the page number for pagination.
5814
+ * @exclusiveMin 0
5801
5815
  */
5802
- published_date__lte?: string;
5816
+ page?: number;
5803
5817
  /**
5804
- * Specify the field by which to sort the results.
5805
- * @default "publication_date"
5818
+ * Page Size
5819
+ * Define the number of records per page for pagination purposes.
5820
+ * @exclusiveMin 0
5806
5821
  */
5807
- sort_by?: BridgeWiseCompanyNewsSortingEnum;
5822
+ page_size?: number;
5823
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5824
+ /**
5825
+ * @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.
5826
+ * @tags Holdings
5827
+ * @name GetHoldings
5828
+ * @summary Get Holdings
5829
+ * @request GET:/funds/{fund_id}/holdings
5830
+ * @secure
5831
+ */
5832
+ getHoldings(fundId: number, query?: {
5808
5833
  /**
5809
- * Size
5810
- * Define the number of records per page for pagination purposes.
5811
- * @default 10
5812
- * @example 10
5834
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5835
+ * @default "en-US"
5813
5836
  */
5814
- size?: number;
5837
+ language?: BridgeWiseLanguageEnum;
5838
+ /**
5839
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5840
+ * @default "stocks"
5841
+ */
5842
+ composition_type?: BridgeWiseCompositionTypeEnum;
5815
5843
  /**
5816
5844
  * Page
5817
5845
  * Define the page number for pagination.
5818
- * @default 1
5819
- * @example 1
5846
+ * @exclusiveMin 0
5820
5847
  */
5821
5848
  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
5849
  /**
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"
5850
+ * Page Size
5851
+ * Define the number of records per page for pagination purposes.
5852
+ * @exclusiveMin 0
5844
5853
  */
5845
- published_date__lte?: string;
5846
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
5854
+ page_size?: number;
5855
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5847
5856
  }
5848
5857
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
5849
5858
  readonly config: JwtClientConfig<HandleError>;