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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +242 -142
  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 +350 -350
  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 +234 -234
  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 +64 -64
  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 +922 -922
  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 +307 -307
  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 +405 -405
  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
@@ -4209,111 +4209,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
4209
4209
  type?: BridgeWiseEarningsCallRecapEnum;
4210
4210
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
4211
4211
  }
4212
- export class EsgAnalysis<HandleError extends boolean = boolean> {
4213
- protected readonly apiClient: JwtClient<HandleError>;
4214
- constructor(apiClient: JwtClient<HandleError>);
4215
- /**
4216
- * @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
4217
- * @tags ESG Analysis
4218
- * @name GetCompanyEsgAnalysis
4219
- * @summary Get Company Esg Analysis
4220
- * @request GET:/companies/{company_id}/esg-analysis
4221
- * @secure
4222
- */
4223
- getCompanyEsgAnalysis(companyId: number, query?: {
4224
- /**
4225
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4226
- * @default "en-US"
4227
- */
4228
- language?: BridgeWiseLanguageEnum;
4229
- /**
4230
- * Show All
4231
- * Boolean flag. Indicate whether to return historical data (`true/false`).
4232
- */
4233
- show_all?: boolean;
4234
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
4235
- /**
4236
- * @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
4237
- * @tags ESG Analysis
4238
- * @name GetCompanyEsgParagraphs
4239
- * @summary Get Company Esg Paragraphs
4240
- * @request GET:/companies/{company_id}/esg-paragraphs
4241
- * @secure
4242
- */
4243
- getCompanyEsgParagraphs(companyId: number, query?: {
4244
- /**
4245
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4246
- * @default "en-US"
4247
- */
4248
- language?: BridgeWiseLanguageEnum;
4249
- /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4250
- section_type?: BridgeWiseESGSectionTypeEnum;
4251
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
4252
- /**
4253
- * @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
4254
- * @tags ESG Analysis
4255
- * @name GetCompanyEsgParameters
4256
- * @summary Get Company Esg Parameters
4257
- * @request GET:/companies/{company_id}/esg-parameters
4258
- * @secure
4259
- */
4260
- getCompanyEsgParameters(companyId: number, query?: {
4261
- /**
4262
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4263
- * @default "en-US"
4264
- */
4265
- language?: BridgeWiseLanguageEnum;
4266
- /**
4267
- * Parameter Id
4268
- * Get desired parameter by ID.
4269
- */
4270
- parameter_id?: number;
4271
- /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4272
- section_type?: BridgeWiseESGSectionTypeParamEnumV2;
4273
- /**
4274
- * Show All
4275
- * Boolean flag. Indicate whether to return historical data (`true/false`).
4276
- */
4277
- show_all?: boolean;
4278
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
4279
- /**
4280
- * @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
4281
- * @tags ESG Analysis
4282
- * @name GetCompanyEsgSections
4283
- * @summary Get Company Esg Sections
4284
- * @request GET:/companies/{company_id}/esg-sections
4285
- * @secure
4286
- */
4287
- getCompanyEsgSections(companyId: number, query?: {
4288
- /**
4289
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4290
- * @default "en-US"
4291
- */
4292
- language?: BridgeWiseLanguageEnum;
4293
- /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4294
- section_type?: BridgeWiseESGSectionTypeEnum;
4295
- /**
4296
- * Show All
4297
- * Boolean flag. Indicate whether to return historical data (`true/false`).
4298
- */
4299
- show_all?: boolean;
4300
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
4301
- /**
4302
- * @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
4303
- * @tags ESG Analysis
4304
- * @name GetCompanyForecastsMsa
4305
- * @summary Get Company Forecasts Msa
4306
- * @request GET:/companies/{company_id}/sustainability-incidents
4307
- * @secure
4308
- */
4309
- getCompanyForecastsMsa(companyId: number, query?: {
4310
- /**
4311
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4312
- * @default "en-US"
4313
- */
4314
- language?: BridgeWiseLanguageEnum;
4315
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
4316
- }
4317
4212
  export class Forecasts<HandleError extends boolean = boolean> {
4318
4213
  protected readonly apiClient: JwtClient<HandleError>;
4319
4214
  constructor(apiClient: JwtClient<HandleError>);
@@ -4347,75 +4242,6 @@ export class Forecasts<HandleError extends boolean = boolean> {
4347
4242
  page_size?: number;
4348
4243
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4349
4244
  }
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
- }
4419
4245
  export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4420
4246
  protected readonly apiClient: JwtClient<HandleError>;
4421
4247
  constructor(apiClient: JwtClient<HandleError>);
@@ -4557,6 +4383,75 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4557
4383
  date__lte?: string;
4558
4384
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
4559
4385
  }
4386
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
4387
+ protected readonly apiClient: JwtClient<HandleError>;
4388
+ constructor(apiClient: JwtClient<HandleError>);
4389
+ /**
4390
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
4391
+ * @tags Company Market Data
4392
+ * @name GetCompanyMarketData
4393
+ * @summary Get Company Market Data
4394
+ * @request GET:/companies/{company_id}/market
4395
+ * @secure
4396
+ */
4397
+ getCompanyMarketData(companyId: number, query?: {
4398
+ /**
4399
+ * Trading Item Id
4400
+ * Specify a BW trading asset identifier for a targeted query.
4401
+ */
4402
+ trading_item_id?: number | null;
4403
+ /**
4404
+ * Date Ge
4405
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4406
+ */
4407
+ date__ge?: string | null;
4408
+ /**
4409
+ * Date Le
4410
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4411
+ */
4412
+ date__le?: string | null;
4413
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
4414
+ /**
4415
+ * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
4416
+ * @tags Company Market Data
4417
+ * @name GetCompanyMarketStatistics
4418
+ * @summary Get Company Market Statistics
4419
+ * @request GET:/companies/{company_id}/market-statistics
4420
+ * @secure
4421
+ */
4422
+ getCompanyMarketStatistics(companyId: number, query?: {
4423
+ /**
4424
+ * Trading Item Id
4425
+ * Specify a BW trading asset identifier for a targeted query.
4426
+ */
4427
+ trading_item_id?: number | null;
4428
+ /**
4429
+ * Identifier In
4430
+ * Specify a list of external identifiers.
4431
+ */
4432
+ identifier__in?: string | null;
4433
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
4434
+ /**
4435
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
4436
+ * @tags Company Market Data
4437
+ * @name GetTradingItems
4438
+ * @summary Get Trading Items
4439
+ * @request GET:/companies/{company_id}/trading-items
4440
+ * @secure
4441
+ */
4442
+ getTradingItems(companyId: number, query?: {
4443
+ /**
4444
+ * Primary Flag
4445
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
4446
+ */
4447
+ primary_flag?: boolean;
4448
+ /**
4449
+ * Security Primary Flag
4450
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
4451
+ */
4452
+ security_primary_flag?: boolean;
4453
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4454
+ }
4560
4455
  export class CompanyNews<HandleError extends boolean = boolean> {
4561
4456
  protected readonly apiClient: JwtClient<HandleError>;
4562
4457
  constructor(apiClient: JwtClient<HandleError>);
@@ -4635,26 +4530,110 @@ export class CompanyNews<HandleError extends boolean = boolean> {
4635
4530
  published_date__lte?: string;
4636
4531
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
4637
4532
  }
4638
- export class Metadata<HandleError extends boolean = boolean> {
4533
+ export class EsgAnalysis<HandleError extends boolean = boolean> {
4639
4534
  protected readonly apiClient: JwtClient<HandleError>;
4640
4535
  constructor(apiClient: JwtClient<HandleError>);
4641
4536
  /**
4642
- * @description This endpoint provides filters
4643
- * @tags Metadata
4644
- * @name GetCompanyFilters
4645
- * @summary Get Company Filters
4646
- * @request GET:/filters
4537
+ * @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
4538
+ * @tags ESG Analysis
4539
+ * @name GetCompanyEsgAnalysis
4540
+ * @summary Get Company Esg Analysis
4541
+ * @request GET:/companies/{company_id}/esg-analysis
4647
4542
  * @secure
4648
4543
  */
4649
- getCompanyFilters(query: {
4650
- /** Desired filter type. */
4651
- type: BridgeWiseCompanyFilterType;
4544
+ getCompanyEsgAnalysis(companyId: number, query?: {
4652
4545
  /**
4653
4546
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4654
4547
  * @default "en-US"
4655
4548
  */
4656
4549
  language?: BridgeWiseLanguageEnum;
4657
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
4550
+ /**
4551
+ * Show All
4552
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4553
+ */
4554
+ show_all?: boolean;
4555
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
4556
+ /**
4557
+ * @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
4558
+ * @tags ESG Analysis
4559
+ * @name GetCompanyEsgParagraphs
4560
+ * @summary Get Company Esg Paragraphs
4561
+ * @request GET:/companies/{company_id}/esg-paragraphs
4562
+ * @secure
4563
+ */
4564
+ getCompanyEsgParagraphs(companyId: number, query?: {
4565
+ /**
4566
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4567
+ * @default "en-US"
4568
+ */
4569
+ language?: BridgeWiseLanguageEnum;
4570
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4571
+ section_type?: BridgeWiseESGSectionTypeEnum;
4572
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
4573
+ /**
4574
+ * @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
4575
+ * @tags ESG Analysis
4576
+ * @name GetCompanyEsgParameters
4577
+ * @summary Get Company Esg Parameters
4578
+ * @request GET:/companies/{company_id}/esg-parameters
4579
+ * @secure
4580
+ */
4581
+ getCompanyEsgParameters(companyId: number, query?: {
4582
+ /**
4583
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4584
+ * @default "en-US"
4585
+ */
4586
+ language?: BridgeWiseLanguageEnum;
4587
+ /**
4588
+ * Parameter Id
4589
+ * Get desired parameter by ID.
4590
+ */
4591
+ parameter_id?: number;
4592
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4593
+ section_type?: BridgeWiseESGSectionTypeParamEnumV2;
4594
+ /**
4595
+ * Show All
4596
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4597
+ */
4598
+ show_all?: boolean;
4599
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
4600
+ /**
4601
+ * @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
4602
+ * @tags ESG Analysis
4603
+ * @name GetCompanyEsgSections
4604
+ * @summary Get Company Esg Sections
4605
+ * @request GET:/companies/{company_id}/esg-sections
4606
+ * @secure
4607
+ */
4608
+ getCompanyEsgSections(companyId: number, query?: {
4609
+ /**
4610
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4611
+ * @default "en-US"
4612
+ */
4613
+ language?: BridgeWiseLanguageEnum;
4614
+ /** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
4615
+ section_type?: BridgeWiseESGSectionTypeEnum;
4616
+ /**
4617
+ * Show All
4618
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4619
+ */
4620
+ show_all?: boolean;
4621
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
4622
+ /**
4623
+ * @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
4624
+ * @tags ESG Analysis
4625
+ * @name GetCompanyForecastsMsa
4626
+ * @summary Get Company Forecasts Msa
4627
+ * @request GET:/companies/{company_id}/sustainability-incidents
4628
+ * @secure
4629
+ */
4630
+ getCompanyForecastsMsa(companyId: number, query?: {
4631
+ /**
4632
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4633
+ * @default "en-US"
4634
+ */
4635
+ language?: BridgeWiseLanguageEnum;
4636
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
4658
4637
  }
4659
4638
  export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4660
4639
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5229,114 +5208,50 @@ export class FundMetadata<HandleError extends boolean = boolean> {
5229
5208
  language?: BridgeWiseLanguageEnum;
5230
5209
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
5231
5210
  }
5232
- export class FundAnalysis<HandleError extends boolean = boolean> {
5211
+ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5233
5212
  protected readonly apiClient: JwtClient<HandleError>;
5234
5213
  constructor(apiClient: JwtClient<HandleError>);
5235
5214
  /**
5236
- * @description Returns Bridgewise final analysis for a specified fund.
5237
- * @tags Fund Analysis
5238
- * @name GetFundAnalysis
5239
- * @summary Get Fund Analysis
5240
- * @request GET:/funds/{fund_id}/analysis
5241
- * @secure
5242
- */
5243
- getFundAnalysis(fundId: number, query?: {
5244
- /**
5245
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5246
- * @default "en-US"
5247
- */
5248
- language?: BridgeWiseLanguageEnum;
5249
- /**
5250
- * Year
5251
- * Specify the year for which the analysis is requested.
5252
- */
5253
- year?: number;
5254
- /**
5255
- * Quarter
5256
- * Specify the quarter for which the analysis is requested.
5257
- */
5258
- quarter?: number;
5259
- /**
5260
- * Show All
5261
- * Boolean flag. Indicate whether to return historical data (`true/false`).
5262
- */
5263
- show_all?: boolean;
5264
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
5265
- /**
5266
- * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
5267
- * @tags Fund Analysis
5268
- * @name GetFundsParagraphs
5269
- * @summary Get Funds Paragraphs
5270
- * @request GET:/funds/{fund_id}/paragraphs
5271
- * @secure
5272
- */
5273
- getFundsParagraphs(fundId: number, query?: {
5274
- /**
5275
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5276
- * @default "en-US"
5277
- */
5278
- language?: BridgeWiseLanguageEnum;
5279
- /**
5280
- * Year
5281
- * Specify the year for which the analysis is requested.
5282
- */
5283
- year?: number | null;
5284
- /**
5285
- * Quarter
5286
- * Specify the quarter for which the analysis is requested.
5287
- */
5288
- quarter?: number | null;
5289
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
5290
- /**
5291
- * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
5292
- * @tags Fund Analysis
5293
- * @name GetFundParameters
5294
- * @summary Get Fund Parameters
5295
- * @request GET:/funds/{fund_id}/parameters
5296
- * @secure
5297
- */
5298
- getFundParameters(fundId: number, query?: {
5299
- /**
5300
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5301
- * @default "en-US"
5302
- */
5303
- language?: BridgeWiseLanguageEnum;
5304
- /**
5305
- * Parameter Id
5306
- * ID of the parameter for analysis.
5307
- */
5308
- parameter_id?: number;
5309
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
5310
- /**
5311
- * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
5312
- * @tags Fund Analysis
5313
- * @name GetFundSections
5314
- * @summary Get Fund Sections
5315
- * @request GET:/funds/{fund_id}/sections
5215
+ * @description Provide the user all the minimum required data for the fund ESG score.
5216
+ * @tags Fund ESG Analysis
5217
+ * @name GetFundEsgAnalysis
5218
+ * @summary Get Fund Esg Analysis
5219
+ * @request GET:/funds/{fund_id}/esg-analysis
5316
5220
  * @secure
5317
5221
  */
5318
- getFundSections(fundId: number, query?: {
5319
- /**
5320
- * Year
5321
- * Specify the year for which the analysis is requested.
5322
- */
5323
- year?: number;
5222
+ getFundEsgAnalysis(fundId: number, query?: {
5324
5223
  /**
5325
- * Quarter
5326
- * Specify the quarter for which the analysis is requested.
5224
+ * Limit
5225
+ * Number of historical periods to be returned (default is 1).
5327
5226
  */
5328
- quarter?: number;
5227
+ limit?: number;
5329
5228
  /**
5330
5229
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5331
5230
  * @default "en-US"
5332
5231
  */
5333
5232
  language?: BridgeWiseLanguageEnum;
5233
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5234
+ }
5235
+ export class Metadata<HandleError extends boolean = boolean> {
5236
+ protected readonly apiClient: JwtClient<HandleError>;
5237
+ constructor(apiClient: JwtClient<HandleError>);
5238
+ /**
5239
+ * @description This endpoint provides filters
5240
+ * @tags Metadata
5241
+ * @name GetCompanyFilters
5242
+ * @summary Get Company Filters
5243
+ * @request GET:/filters
5244
+ * @secure
5245
+ */
5246
+ getCompanyFilters(query: {
5247
+ /** Desired filter type. */
5248
+ type: BridgeWiseCompanyFilterType;
5334
5249
  /**
5335
- * Show All
5336
- * Boolean flag. Indicate whether to return historical data (`true/false`).
5250
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5251
+ * @default "en-US"
5337
5252
  */
5338
- show_all?: boolean;
5339
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
5253
+ language?: BridgeWiseLanguageEnum;
5254
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
5340
5255
  }
5341
5256
  export class Segmentations<HandleError extends boolean = boolean> {
5342
5257
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5653,30 +5568,6 @@ export class TenantIdentifiers<HandleError extends boolean = boolean> {
5653
5568
  */
5654
5569
  deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5655
5570
  }
5656
- export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5657
- protected readonly apiClient: JwtClient<HandleError>;
5658
- constructor(apiClient: JwtClient<HandleError>);
5659
- /**
5660
- * @description Provide the user all the minimum required data for the fund ESG score.
5661
- * @tags Fund ESG Analysis
5662
- * @name GetFundEsgAnalysis
5663
- * @summary Get Fund Esg Analysis
5664
- * @request GET:/funds/{fund_id}/esg-analysis
5665
- * @secure
5666
- */
5667
- getFundEsgAnalysis(fundId: number, query?: {
5668
- /**
5669
- * Limit
5670
- * Number of historical periods to be returned (default is 1).
5671
- */
5672
- limit?: number;
5673
- /**
5674
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5675
- * @default "en-US"
5676
- */
5677
- language?: BridgeWiseLanguageEnum;
5678
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5679
- }
5680
5571
  export class Users<HandleError extends boolean = boolean> {
5681
5572
  protected readonly apiClient: JwtClient<HandleError>;
5682
5573
  constructor(apiClient: JwtClient<HandleError>);
@@ -5700,6 +5591,91 @@ export class Users<HandleError extends boolean = boolean> {
5700
5591
  authorization: string;
5701
5592
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
5702
5593
  }
5594
+ export class Holdings<HandleError extends boolean = boolean> {
5595
+ protected readonly apiClient: JwtClient<HandleError>;
5596
+ constructor(apiClient: JwtClient<HandleError>);
5597
+ /**
5598
+ * @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
5599
+ * @tags Holdings
5600
+ * @name GetCompositions
5601
+ * @summary Get Compositions
5602
+ * @request GET:/funds/{fund_id}/compositions
5603
+ * @secure
5604
+ */
5605
+ getCompositions(fundId: number, query?: {
5606
+ /**
5607
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5608
+ * @default "en-US"
5609
+ */
5610
+ language?: BridgeWiseLanguageEnum;
5611
+ /** Filter data by specific components of the fund composition (e.g., stocks, others). */
5612
+ composition_type?: BridgeWiseCompositionTypeEnum;
5613
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
5614
+ /**
5615
+ * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
5616
+ * @tags Holdings
5617
+ * @name GetHoldingStatistics
5618
+ * @summary Get Holding Statistics
5619
+ * @request GET:/funds/{fund_id}/holding-statistics
5620
+ * @secure
5621
+ */
5622
+ getHoldingStatistics(fundId: number, query?: {
5623
+ /**
5624
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5625
+ * @default "en-US"
5626
+ */
5627
+ language?: BridgeWiseLanguageEnum;
5628
+ /**
5629
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5630
+ * @default "stocks"
5631
+ */
5632
+ composition_type?: BridgeWiseCompositionTypeEnum;
5633
+ /**
5634
+ * Page
5635
+ * Define the page number for pagination.
5636
+ * @exclusiveMin 0
5637
+ */
5638
+ page?: number;
5639
+ /**
5640
+ * Page Size
5641
+ * Define the number of records per page for pagination purposes.
5642
+ * @exclusiveMin 0
5643
+ */
5644
+ page_size?: number;
5645
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5646
+ /**
5647
+ * @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
5648
+ * @tags Holdings
5649
+ * @name GetHoldings
5650
+ * @summary Get Holdings
5651
+ * @request GET:/funds/{fund_id}/holdings
5652
+ * @secure
5653
+ */
5654
+ getHoldings(fundId: number, query?: {
5655
+ /**
5656
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5657
+ * @default "en-US"
5658
+ */
5659
+ language?: BridgeWiseLanguageEnum;
5660
+ /**
5661
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5662
+ * @default "stocks"
5663
+ */
5664
+ composition_type?: BridgeWiseCompositionTypeEnum;
5665
+ /**
5666
+ * Page
5667
+ * Define the page number for pagination.
5668
+ * @exclusiveMin 0
5669
+ */
5670
+ page?: number;
5671
+ /**
5672
+ * Page Size
5673
+ * Define the number of records per page for pagination purposes.
5674
+ * @exclusiveMin 0
5675
+ */
5676
+ page_size?: number;
5677
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5678
+ }
5703
5679
  export class FundMarketData<HandleError extends boolean = boolean> {
5704
5680
  protected readonly apiClient: JwtClient<HandleError>;
5705
5681
  constructor(apiClient: JwtClient<HandleError>);
@@ -5769,90 +5745,114 @@ export class FundMarketData<HandleError extends boolean = boolean> {
5769
5745
  security_primary_flag?: boolean;
5770
5746
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
5771
5747
  }
5772
- export class Holdings<HandleError extends boolean = boolean> {
5748
+ export class FundAnalysis<HandleError extends boolean = boolean> {
5773
5749
  protected readonly apiClient: JwtClient<HandleError>;
5774
5750
  constructor(apiClient: JwtClient<HandleError>);
5775
5751
  /**
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
5752
+ * @description Returns Bridgewise final analysis for a specified fund.
5753
+ * @tags Fund Analysis
5754
+ * @name GetFundAnalysis
5755
+ * @summary Get Fund Analysis
5756
+ * @request GET:/funds/{fund_id}/analysis
5781
5757
  * @secure
5782
5758
  */
5783
- getCompositions(fundId: number, query?: {
5759
+ getFundAnalysis(fundId: number, query?: {
5784
5760
  /**
5785
5761
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5786
5762
  * @default "en-US"
5787
5763
  */
5788
5764
  language?: BridgeWiseLanguageEnum;
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>>;
5765
+ /**
5766
+ * Year
5767
+ * Specify the year for which the analysis is requested.
5768
+ */
5769
+ year?: number;
5770
+ /**
5771
+ * Quarter
5772
+ * Specify the quarter for which the analysis is requested.
5773
+ */
5774
+ quarter?: number;
5775
+ /**
5776
+ * Show All
5777
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
5778
+ */
5779
+ show_all?: boolean;
5780
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
5792
5781
  /**
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
5782
+ * @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
5783
+ * @tags Fund Analysis
5784
+ * @name GetFundsParagraphs
5785
+ * @summary Get Funds Paragraphs
5786
+ * @request GET:/funds/{fund_id}/paragraphs
5798
5787
  * @secure
5799
5788
  */
5800
- getHoldingStatistics(fundId: number, query?: {
5789
+ getFundsParagraphs(fundId: number, query?: {
5801
5790
  /**
5802
5791
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5803
5792
  * @default "en-US"
5804
5793
  */
5805
5794
  language?: BridgeWiseLanguageEnum;
5806
5795
  /**
5807
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5808
- * @default "stocks"
5809
- */
5810
- composition_type?: BridgeWiseCompositionTypeEnum;
5811
- /**
5812
- * Page
5813
- * Define the page number for pagination.
5814
- * @exclusiveMin 0
5796
+ * Year
5797
+ * Specify the year for which the analysis is requested.
5815
5798
  */
5816
- page?: number;
5799
+ year?: number | null;
5817
5800
  /**
5818
- * Page Size
5819
- * Define the number of records per page for pagination purposes.
5820
- * @exclusiveMin 0
5801
+ * Quarter
5802
+ * Specify the quarter for which the analysis is requested.
5821
5803
  */
5822
- page_size?: number;
5823
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5804
+ quarter?: number | null;
5805
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
5824
5806
  /**
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
5807
+ * @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
5808
+ * @tags Fund Analysis
5809
+ * @name GetFundParameters
5810
+ * @summary Get Fund Parameters
5811
+ * @request GET:/funds/{fund_id}/parameters
5830
5812
  * @secure
5831
5813
  */
5832
- getHoldings(fundId: number, query?: {
5814
+ getFundParameters(fundId: number, query?: {
5833
5815
  /**
5834
5816
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5835
5817
  * @default "en-US"
5836
5818
  */
5837
5819
  language?: BridgeWiseLanguageEnum;
5838
5820
  /**
5839
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5840
- * @default "stocks"
5821
+ * Parameter Id
5822
+ * ID of the parameter for analysis.
5841
5823
  */
5842
- composition_type?: BridgeWiseCompositionTypeEnum;
5824
+ parameter_id?: number;
5825
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
5826
+ /**
5827
+ * @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
5828
+ * @tags Fund Analysis
5829
+ * @name GetFundSections
5830
+ * @summary Get Fund Sections
5831
+ * @request GET:/funds/{fund_id}/sections
5832
+ * @secure
5833
+ */
5834
+ getFundSections(fundId: number, query?: {
5843
5835
  /**
5844
- * Page
5845
- * Define the page number for pagination.
5846
- * @exclusiveMin 0
5836
+ * Year
5837
+ * Specify the year for which the analysis is requested.
5847
5838
  */
5848
- page?: number;
5839
+ year?: number;
5849
5840
  /**
5850
- * Page Size
5851
- * Define the number of records per page for pagination purposes.
5852
- * @exclusiveMin 0
5841
+ * Quarter
5842
+ * Specify the quarter for which the analysis is requested.
5853
5843
  */
5854
- page_size?: number;
5855
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5844
+ quarter?: number;
5845
+ /**
5846
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5847
+ * @default "en-US"
5848
+ */
5849
+ language?: BridgeWiseLanguageEnum;
5850
+ /**
5851
+ * Show All
5852
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
5853
+ */
5854
+ show_all?: boolean;
5855
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
5856
5856
  }
5857
5857
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
5858
5858
  readonly config: JwtClientConfig<HandleError>;