@orbis-systems/orbis-api-clients 0.7.17 → 0.7.19

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 +68 -68
  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 +884 -884
  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 +220 -193
  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 +99 -99
  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 +3863 -3863
  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 +618 -618
  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/package.json +4 -13
  38. package/dist/zerohash/index.d.ts +0 -15498
  39. package/dist/zerohash/index.d.ts.map +0 -1
  40. package/dist/zerohash/index.esm.js +0 -2
  41. package/dist/zerohash/index.esm.js.map +0 -1
  42. package/dist/zerohash/index.js +0 -2
  43. package/dist/zerohash/index.js.map +0 -1
@@ -3064,6 +3064,123 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
3064
3064
  Iso = "iso",
3065
3065
  Epoch = "epoch"
3066
3066
  }
3067
+ export class Activities<HandleError extends boolean = boolean> {
3068
+ protected readonly apiClient: JwtClient<HandleError>;
3069
+ constructor(apiClient: JwtClient<HandleError>);
3070
+ /**
3071
+ * @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
3072
+ * @tags Activities
3073
+ * @name GetCompanyAlerts
3074
+ * @summary Get Company Alerts
3075
+ * @request GET:/companies/{company_id}/alerts
3076
+ * @secure
3077
+ */
3078
+ getCompanyAlerts(companyId: number, query?: {
3079
+ /**
3080
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3081
+ * @default "en-US"
3082
+ */
3083
+ language?: BridgeWiseLanguageEnum;
3084
+ /** Specify the group of the alert type that will be presented (fundamental or market). */
3085
+ alert_type?: BridgeWiseCompanyAlertType;
3086
+ /** Filter alerts by their sentiment. */
3087
+ sentiment?: BridgeWiseCompanyAlertSentiment;
3088
+ /**
3089
+ * Importance
3090
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
3091
+ */
3092
+ importance?: string | null;
3093
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
3094
+ /**
3095
+ * @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
3096
+ * @tags Activities
3097
+ * @name GetCompanyForecastsKeyDevelopment
3098
+ * @summary Get Company Forecasts Key Development
3099
+ * @request GET:/companies/{company_id}/key-developments
3100
+ * @secure
3101
+ */
3102
+ getCompanyForecastsKeyDevelopment(companyId: number, query?: {
3103
+ /**
3104
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3105
+ * @default "en-US"
3106
+ */
3107
+ language?: BridgeWiseLanguageEnum;
3108
+ /**
3109
+ * Importance
3110
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
3111
+ * @default "0,1"
3112
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3113
+ */
3114
+ importance?: string;
3115
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
3116
+ }
3117
+ export class Bridget<HandleError extends boolean = boolean> {
3118
+ protected readonly apiClient: JwtClient<HandleError>;
3119
+ constructor(apiClient: JwtClient<HandleError>);
3120
+ /**
3121
+ * @tags Bridget
3122
+ * @name QuestionsCreate
3123
+ * @request POST:/questions
3124
+ * @secure
3125
+ */
3126
+ questionsCreate(data: BridgeWiseQuestionsRequest, headers: {
3127
+ /** User ID */
3128
+ Userid: string;
3129
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
3130
+ /**
3131
+ * @tags Bridget
3132
+ * @name TenantsQuestionsRetrieve
3133
+ * @request GET:/tenants/{tenant_id}/questions
3134
+ * @secure
3135
+ */
3136
+ tenantsQuestionsRetrieve(tenantId: string, query?: {
3137
+ /** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
3138
+ client_id?: string;
3139
+ /**
3140
+ * Returns logs only for the specified calendar day (00:00–23:59 tenant time zone).
3141
+ *
3142
+ * Use either this field or the `start_date` + `end_date` pair.
3143
+ *
3144
+ * **Never** both in the same request.
3145
+ *
3146
+ * **Format:** YYYY-MM-DD
3147
+ * @format date
3148
+ */
3149
+ date?: string;
3150
+ /**
3151
+ * Inclusive end of a date range.
3152
+ *
3153
+ * Must be greater than or equal to `start_date`.
3154
+ *
3155
+ * Use either the `date` field, OR use the `start_date` + `end_date` pair.
3156
+ *
3157
+ * **Never** use both in the same request.
3158
+ *
3159
+ * **Format:** YYYY-MM-DD
3160
+ * @format date
3161
+ */
3162
+ end_date?: string;
3163
+ /** Filters by user feedback on each answer. **Allowed values**: `like` | `dislike` */
3164
+ feedback_type?: string;
3165
+ /** Filters to a single chat session ID. */
3166
+ session_id?: string;
3167
+ /**
3168
+ * Inclusive start of a date range.
3169
+ *
3170
+ * Use either the `date` field or this `start_date` + `end_date`pair.
3171
+ *
3172
+ * **Never** both in the same request.
3173
+ *
3174
+ * Required when end_date is provided.
3175
+ *
3176
+ * **Format:** YYYY-MM-DD
3177
+ * @format date
3178
+ */
3179
+ start_date?: string;
3180
+ /** Filters logs to a single end-user within the tenant. */
3181
+ user_id?: string;
3182
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
3183
+ }
3067
3184
  export class Bwc<HandleError extends boolean = boolean> {
3068
3185
  protected readonly apiClient: JwtClient<HandleError>;
3069
3186
  constructor(apiClient: JwtClient<HandleError>);
@@ -3391,6 +3508,75 @@ export class Bwc<HandleError extends boolean = boolean> {
3391
3508
  identifier: string;
3392
3509
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
3393
3510
  }
3511
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
3512
+ protected readonly apiClient: JwtClient<HandleError>;
3513
+ constructor(apiClient: JwtClient<HandleError>);
3514
+ /**
3515
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
3516
+ * @tags Company Market Data
3517
+ * @name GetCompanyMarketData
3518
+ * @summary Get Company Market Data
3519
+ * @request GET:/companies/{company_id}/market
3520
+ * @secure
3521
+ */
3522
+ getCompanyMarketData(companyId: number, query?: {
3523
+ /**
3524
+ * Trading Item Id
3525
+ * Specify a BW trading asset identifier for a targeted query.
3526
+ */
3527
+ trading_item_id?: number | null;
3528
+ /**
3529
+ * Date Ge
3530
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3531
+ */
3532
+ date__ge?: string | null;
3533
+ /**
3534
+ * Date Le
3535
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3536
+ */
3537
+ date__le?: string | null;
3538
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
3539
+ /**
3540
+ * @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.
3541
+ * @tags Company Market Data
3542
+ * @name GetCompanyMarketStatistics
3543
+ * @summary Get Company Market Statistics
3544
+ * @request GET:/companies/{company_id}/market-statistics
3545
+ * @secure
3546
+ */
3547
+ getCompanyMarketStatistics(companyId: number, query?: {
3548
+ /**
3549
+ * Trading Item Id
3550
+ * Specify a BW trading asset identifier for a targeted query.
3551
+ */
3552
+ trading_item_id?: number | null;
3553
+ /**
3554
+ * Identifier In
3555
+ * Specify a list of external identifiers.
3556
+ */
3557
+ identifier__in?: string | null;
3558
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
3559
+ /**
3560
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
3561
+ * @tags Company Market Data
3562
+ * @name GetTradingItems
3563
+ * @summary Get Trading Items
3564
+ * @request GET:/companies/{company_id}/trading-items
3565
+ * @secure
3566
+ */
3567
+ getTradingItems(companyId: number, query?: {
3568
+ /**
3569
+ * Primary Flag
3570
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
3571
+ */
3572
+ primary_flag?: boolean;
3573
+ /**
3574
+ * Security Primary Flag
3575
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
3576
+ */
3577
+ security_primary_flag?: boolean;
3578
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
3579
+ }
3394
3580
  export class CompanyMetadata<HandleError extends boolean = boolean> {
3395
3581
  protected readonly apiClient: JwtClient<HandleError>;
3396
3582
  constructor(apiClient: JwtClient<HandleError>);
@@ -4093,68 +4279,96 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
4093
4279
  identifier_type: string;
4094
4280
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4095
4281
  }
4096
- export class Activities<HandleError extends boolean = boolean> {
4282
+ export class CompanyNews<HandleError extends boolean = boolean> {
4097
4283
  protected readonly apiClient: JwtClient<HandleError>;
4098
4284
  constructor(apiClient: JwtClient<HandleError>);
4099
4285
  /**
4100
- * @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
4101
- * @tags Activities
4102
- * @name GetCompanyAlerts
4103
- * @summary Get Company Alerts
4104
- * @request GET:/companies/{company_id}/alerts
4286
+ * @description This endpoint provides news articles related to the specified company.
4287
+ * @tags Company News
4288
+ * @name GetCompanyNews
4289
+ * @summary Get Company News
4290
+ * @request GET:/companies/{company_id}/news
4105
4291
  * @secure
4106
4292
  */
4107
- getCompanyAlerts(companyId: number, query?: {
4293
+ getCompanyNews(companyId: number, query?: {
4108
4294
  /**
4295
+ * Languages
4109
4296
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4110
4297
  * @default "en-US"
4298
+ * @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))*$
4111
4299
  */
4112
- language?: BridgeWiseLanguageEnum;
4113
- /** Specify the group of the alert type that will be presented (fundamental or market). */
4114
- alert_type?: BridgeWiseCompanyAlertType;
4115
- /** Filter alerts by their sentiment. */
4116
- sentiment?: BridgeWiseCompanyAlertSentiment;
4300
+ languages?: string;
4117
4301
  /**
4118
- * Importance
4119
- * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
4302
+ * Published Date Gte
4303
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4304
+ * @format date
4305
+ * @default "2025-09-01"
4120
4306
  */
4121
- importance?: string | null;
4122
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
4123
- /**
4124
- * @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
4125
- * @tags Activities
4126
- * @name GetCompanyForecastsKeyDevelopment
4127
- * @summary Get Company Forecasts Key Development
4128
- * @request GET:/companies/{company_id}/key-developments
4129
- * @secure
4130
- */
4131
- getCompanyForecastsKeyDevelopment(companyId: number, query?: {
4307
+ published_date__gte?: string;
4132
4308
  /**
4133
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4134
- * @default "en-US"
4309
+ * Published Date Lte
4310
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4311
+ * @format date
4312
+ * @default "2025-09-01"
4135
4313
  */
4136
- language?: BridgeWiseLanguageEnum;
4314
+ published_date__lte?: string;
4137
4315
  /**
4138
- * Importance
4139
- * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
4140
- * @default "0,1"
4141
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4316
+ * Specify the field by which to sort the results.
4317
+ * @default "publication_date"
4142
4318
  */
4143
- importance?: string;
4144
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
4145
- }
4146
- export class ConsensusAnalysts<HandleError extends boolean = boolean> {
4147
- protected readonly apiClient: JwtClient<HandleError>;
4148
- constructor(apiClient: JwtClient<HandleError>);
4149
- /**
4150
- * @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
4151
- * @tags Consensus Analysts
4152
- * @name GetConsensusRatings
4153
- * @summary Get Consensus Ratings
4154
- * @request GET:/companies/{company_id}/consensus-ratings
4155
- * @secure
4156
- */
4157
- getConsensusRatings(companyId: number, query?: {
4319
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
4320
+ /**
4321
+ * Size
4322
+ * Define the number of records per page for pagination purposes.
4323
+ * @default 10
4324
+ * @example 10
4325
+ */
4326
+ size?: number;
4327
+ /**
4328
+ * Page
4329
+ * Define the page number for pagination.
4330
+ * @default 1
4331
+ * @example 1
4332
+ */
4333
+ page?: number;
4334
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
4335
+ /**
4336
+ * @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.
4337
+ * @tags Company News
4338
+ * @name GetAverageCompanyNewsSentiment
4339
+ * @summary Get Average Company News Sentiment
4340
+ * @request GET:/companies/{company_id}/news-sentiment
4341
+ * @secure
4342
+ */
4343
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
4344
+ /**
4345
+ * Published Date Gte
4346
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4347
+ * @format date
4348
+ * @default "2025-09-01"
4349
+ */
4350
+ published_date__gte?: string;
4351
+ /**
4352
+ * Published Date Lte
4353
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4354
+ * @format date
4355
+ * @default "2025-09-01"
4356
+ */
4357
+ published_date__lte?: string;
4358
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
4359
+ }
4360
+ export class ConsensusAnalysts<HandleError extends boolean = boolean> {
4361
+ protected readonly apiClient: JwtClient<HandleError>;
4362
+ constructor(apiClient: JwtClient<HandleError>);
4363
+ /**
4364
+ * @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
4365
+ * @tags Consensus Analysts
4366
+ * @name GetConsensusRatings
4367
+ * @summary Get Consensus Ratings
4368
+ * @request GET:/companies/{company_id}/consensus-ratings
4369
+ * @secure
4370
+ */
4371
+ getConsensusRatings(companyId: number, query?: {
4158
4372
  /**
4159
4373
  * Trading Item Id
4160
4374
  * Specify a BW trading asset identifier for a targeted query.
@@ -4323,50 +4537,38 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
4323
4537
  language?: BridgeWiseLanguageEnum;
4324
4538
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
4325
4539
  }
4326
- export class Logos<HandleError extends boolean = boolean> {
4540
+ export class Forecasts<HandleError extends boolean = boolean> {
4327
4541
  protected readonly apiClient: JwtClient<HandleError>;
4328
4542
  constructor(apiClient: JwtClient<HandleError>);
4329
4543
  /**
4330
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
4331
- * @tags Logos
4332
- * @name FetchLogos
4333
- * @summary Fetch Logos
4334
- * @request GET:/companies/logos
4544
+ * @description <b>!!!WILL BE DEPRECATED!!!</b>
4545
+ * @tags Forecasts
4546
+ * @name GetCompanyForecasts
4547
+ * @summary Get Company Forecasts
4548
+ * @request GET:/companies/{company_id}/forecasts
4335
4549
  * @secure
4336
4550
  */
4337
- fetchLogos(query?: {
4338
- /**
4339
- * Company Id In
4340
- * Specify a list of BW identifiers for bulk queries.
4341
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4342
- * @example "74822,83343211"
4343
- */
4344
- company_id__in?: string;
4551
+ getCompanyForecasts(companyId: number, query?: {
4345
4552
  /**
4346
- * Size
4347
- * Page size
4348
- * @min 1
4349
- * @max 100
4350
- * @default 50
4553
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4554
+ * @default "en-US"
4351
4555
  */
4352
- size?: number;
4556
+ language?: BridgeWiseLanguageEnum;
4557
+ /** Desired forecast type. */
4558
+ forecast_type?: BridgeWiseForecastType;
4353
4559
  /**
4354
4560
  * Page
4355
- * Page number
4356
- * @min 1
4357
- * @default 1
4561
+ * Define the page number for pagination.
4562
+ * @exclusiveMin 0
4358
4563
  */
4359
4564
  page?: number;
4360
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
4361
- /**
4362
- * @description Retrieves the logo for a specified company using the provided company_id.
4363
- * @tags Logos
4364
- * @name FetchLogo
4365
- * @summary Fetch Logo
4366
- * @request GET:/companies/{company_id}/logos
4367
- * @secure
4368
- */
4369
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
4565
+ /**
4566
+ * Page Size
4567
+ * Define the number of records per page for pagination purposes.
4568
+ * @exclusiveMin 0
4569
+ */
4570
+ page_size?: number;
4571
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4370
4572
  }
4371
4573
  export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4372
4574
  protected readonly apiClient: JwtClient<HandleError>;
@@ -4534,476 +4736,290 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
4534
4736
  section_type?: string;
4535
4737
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
4536
4738
  }
4537
- export class Forecasts<HandleError extends boolean = boolean> {
4739
+ export class FundAnalysis<HandleError extends boolean = boolean> {
4538
4740
  protected readonly apiClient: JwtClient<HandleError>;
4539
4741
  constructor(apiClient: JwtClient<HandleError>);
4540
4742
  /**
4541
- * @description <b>!!!WILL BE DEPRECATED!!!</b>
4542
- * @tags Forecasts
4543
- * @name GetCompanyForecasts
4544
- * @summary Get Company Forecasts
4545
- * @request GET:/companies/{company_id}/forecasts
4743
+ * @description Returns Bridgewise final analysis for a specified fund.
4744
+ * @tags Fund Analysis
4745
+ * @name GetFundAnalysis
4746
+ * @summary Get Fund Analysis
4747
+ * @request GET:/funds/{fund_id}/analysis
4546
4748
  * @secure
4547
4749
  */
4548
- getCompanyForecasts(companyId: number, query?: {
4750
+ getFundAnalysis(fundId: number, query?: {
4549
4751
  /**
4550
4752
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4551
4753
  * @default "en-US"
4552
4754
  */
4553
4755
  language?: BridgeWiseLanguageEnum;
4554
- /** Desired forecast type. */
4555
- forecast_type?: BridgeWiseForecastType;
4556
4756
  /**
4557
- * Page
4558
- * Define the page number for pagination.
4559
- * @exclusiveMin 0
4757
+ * Year
4758
+ * Specify the year for which the analysis is requested.
4560
4759
  */
4561
- page?: number;
4760
+ year?: number;
4562
4761
  /**
4563
- * Page Size
4564
- * Define the number of records per page for pagination purposes.
4565
- * @exclusiveMin 0
4762
+ * Quarter
4763
+ * Specify the quarter for which the analysis is requested.
4566
4764
  */
4567
- page_size?: number;
4568
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
4569
- }
4570
- export class CompanyMarketData<HandleError extends boolean = boolean> {
4571
- protected readonly apiClient: JwtClient<HandleError>;
4572
- constructor(apiClient: JwtClient<HandleError>);
4765
+ quarter?: number;
4766
+ /**
4767
+ * Show All
4768
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4769
+ */
4770
+ show_all?: boolean;
4771
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
4573
4772
  /**
4574
- * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
4575
- * @tags Company Market Data
4576
- * @name GetCompanyMarketData
4577
- * @summary Get Company Market Data
4578
- * @request GET:/companies/{company_id}/market
4773
+ * @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.
4774
+ * @tags Fund Analysis
4775
+ * @name GetFundsParagraphs
4776
+ * @summary Get Funds Paragraphs
4777
+ * @request GET:/funds/{fund_id}/paragraphs
4579
4778
  * @secure
4580
4779
  */
4581
- getCompanyMarketData(companyId: number, query?: {
4780
+ getFundsParagraphs(fundId: number, query?: {
4582
4781
  /**
4583
- * Trading Item Id
4584
- * Specify a BW trading asset identifier for a targeted query.
4782
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4783
+ * @default "en-US"
4585
4784
  */
4586
- trading_item_id?: number | null;
4785
+ language?: BridgeWiseLanguageEnum;
4587
4786
  /**
4588
- * Date Ge
4589
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4787
+ * Year
4788
+ * Specify the year for which the analysis is requested.
4590
4789
  */
4591
- date__ge?: string | null;
4790
+ year?: number | null;
4592
4791
  /**
4593
- * Date Le
4594
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4792
+ * Quarter
4793
+ * Specify the quarter for which the analysis is requested.
4595
4794
  */
4596
- date__le?: string | null;
4597
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
4795
+ quarter?: number | null;
4796
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
4598
4797
  /**
4599
- * @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.
4600
- * @tags Company Market Data
4601
- * @name GetCompanyMarketStatistics
4602
- * @summary Get Company Market Statistics
4603
- * @request GET:/companies/{company_id}/market-statistics
4798
+ * @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.
4799
+ * @tags Fund Analysis
4800
+ * @name GetFundParameters
4801
+ * @summary Get Fund Parameters
4802
+ * @request GET:/funds/{fund_id}/parameters
4604
4803
  * @secure
4605
4804
  */
4606
- getCompanyMarketStatistics(companyId: number, query?: {
4805
+ getFundParameters(fundId: number, query?: {
4607
4806
  /**
4608
- * Trading Item Id
4609
- * Specify a BW trading asset identifier for a targeted query.
4807
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4808
+ * @default "en-US"
4610
4809
  */
4611
- trading_item_id?: number | null;
4810
+ language?: BridgeWiseLanguageEnum;
4612
4811
  /**
4613
- * Identifier In
4614
- * Specify a list of external identifiers.
4812
+ * Parameter Id
4813
+ * ID of the parameter for analysis.
4615
4814
  */
4616
- identifier__in?: string | null;
4617
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
4815
+ parameter_id?: number;
4816
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
4618
4817
  /**
4619
- * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
4620
- * @tags Company Market Data
4621
- * @name GetTradingItems
4622
- * @summary Get Trading Items
4623
- * @request GET:/companies/{company_id}/trading-items
4818
+ * @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.
4819
+ * @tags Fund Analysis
4820
+ * @name GetFundSections
4821
+ * @summary Get Fund Sections
4822
+ * @request GET:/funds/{fund_id}/sections
4624
4823
  * @secure
4625
4824
  */
4626
- getTradingItems(companyId: number, query?: {
4825
+ getFundSections(fundId: number, query?: {
4627
4826
  /**
4628
- * Primary Flag
4629
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
4827
+ * Year
4828
+ * Specify the year for which the analysis is requested.
4630
4829
  */
4631
- primary_flag?: boolean;
4830
+ year?: number;
4632
4831
  /**
4633
- * Security Primary Flag
4634
- * Boolean flag. Indicate if only primary asset data is required (true/false).
4832
+ * Quarter
4833
+ * Specify the quarter for which the analysis is requested.
4635
4834
  */
4636
- security_primary_flag?: boolean;
4637
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
4835
+ quarter?: number;
4836
+ /**
4837
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4838
+ * @default "en-US"
4839
+ */
4840
+ language?: BridgeWiseLanguageEnum;
4841
+ /**
4842
+ * Show All
4843
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4844
+ */
4845
+ show_all?: boolean;
4846
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
4638
4847
  }
4639
- export class CompanyNews<HandleError extends boolean = boolean> {
4848
+ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
4640
4849
  protected readonly apiClient: JwtClient<HandleError>;
4641
4850
  constructor(apiClient: JwtClient<HandleError>);
4642
4851
  /**
4643
- * @description This endpoint provides news articles related to the specified company.
4644
- * @tags Company News
4645
- * @name GetCompanyNews
4646
- * @summary Get Company News
4647
- * @request GET:/companies/{company_id}/news
4852
+ * @description Provide the user all the minimum required data for the fund ESG score.
4853
+ * @tags Fund ESG Analysis
4854
+ * @name GetFundEsgAnalysis
4855
+ * @summary Get Fund Esg Analysis
4856
+ * @request GET:/funds/{fund_id}/esg-analysis
4648
4857
  * @secure
4649
4858
  */
4650
- getCompanyNews(companyId: number, query?: {
4859
+ getFundEsgAnalysis(fundId: number, query?: {
4860
+ /**
4861
+ * Limit
4862
+ * Number of historical periods to be returned (default is 1).
4863
+ */
4864
+ limit?: number;
4651
4865
  /**
4652
- * Languages
4653
4866
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4654
4867
  * @default "en-US"
4655
- * @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))*$
4656
4868
  */
4657
- languages?: string;
4869
+ language?: BridgeWiseLanguageEnum;
4870
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
4871
+ }
4872
+ export class FundMarketData<HandleError extends boolean = boolean> {
4873
+ protected readonly apiClient: JwtClient<HandleError>;
4874
+ constructor(apiClient: JwtClient<HandleError>);
4875
+ /**
4876
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
4877
+ * @tags Fund Market Data
4878
+ * @name GetFundsMarketData
4879
+ * @summary Get Funds Market Data
4880
+ * @request GET:/funds/{fund_id}/market
4881
+ * @secure
4882
+ */
4883
+ getFundsMarketData(fundId: number, query?: {
4658
4884
  /**
4659
- * Published Date Gte
4660
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4661
- * @format date
4662
- * @default "2025-09-01"
4885
+ * Trading Item Id
4886
+ * Specify a BW trading asset identifier for a targeted query.
4663
4887
  */
4664
- published_date__gte?: string;
4888
+ trading_item_id?: number | null;
4665
4889
  /**
4666
- * Published Date Lte
4667
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4668
- * @format date
4669
- * @default "2025-09-01"
4890
+ * Date Ge
4891
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4670
4892
  */
4671
- published_date__lte?: string;
4893
+ date__ge?: string | null;
4672
4894
  /**
4673
- * Specify the field by which to sort the results.
4674
- * @default "publication_date"
4895
+ * Date Le
4896
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4675
4897
  */
4676
- sort_by?: BridgeWiseCompanyNewsSortingEnum;
4898
+ date__le?: string | null;
4899
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
4900
+ /**
4901
+ * @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.
4902
+ * @tags Fund Market Data
4903
+ * @name GetFundsMarketStatistics
4904
+ * @summary Get Funds Market Statistics
4905
+ * @request GET:/funds/{fund_id}/market-statistics
4906
+ * @secure
4907
+ */
4908
+ getFundsMarketStatistics(fundId: number, query?: {
4677
4909
  /**
4678
- * Size
4679
- * Define the number of records per page for pagination purposes.
4680
- * @default 10
4681
- * @example 10
4910
+ * Trading Item Id
4911
+ * Specify a BW trading asset identifier for a targeted query.
4682
4912
  */
4683
- size?: number;
4913
+ trading_item_id?: number | null;
4684
4914
  /**
4685
- * Page
4686
- * Define the page number for pagination.
4687
- * @default 1
4688
- * @example 1
4915
+ * Identifier In
4916
+ * Specify a list of external identifiers.
4689
4917
  */
4690
- page?: number;
4691
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
4918
+ identifier__in?: string | null;
4919
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
4692
4920
  /**
4693
- * @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.
4694
- * @tags Company News
4695
- * @name GetAverageCompanyNewsSentiment
4696
- * @summary Get Average Company News Sentiment
4697
- * @request GET:/companies/{company_id}/news-sentiment
4921
+ * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
4922
+ * @tags Fund Market Data
4923
+ * @name GetFundTradingItems
4924
+ * @summary Get Fund Trading Items
4925
+ * @request GET:/funds/{fund_id}/trading-items
4698
4926
  * @secure
4699
4927
  */
4700
- getAverageCompanyNewsSentiment(companyId: number, query?: {
4928
+ getFundTradingItems(fundId: number, query?: {
4701
4929
  /**
4702
- * Published Date Gte
4703
- * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
4704
- * @format date
4705
- * @default "2025-09-01"
4930
+ * Primary Flag
4931
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
4706
4932
  */
4707
- published_date__gte?: string;
4933
+ primary_flag?: boolean;
4708
4934
  /**
4709
- * Published Date Lte
4710
- * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
4711
- * @format date
4712
- * @default "2025-09-01"
4935
+ * Security Primary Flag
4936
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
4713
4937
  */
4714
- published_date__lte?: string;
4715
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
4938
+ security_primary_flag?: boolean;
4939
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
4716
4940
  }
4717
- export class TechnicalAnalysis<HandleError extends boolean = boolean> {
4941
+ export class FundMetadata<HandleError extends boolean = boolean> {
4718
4942
  protected readonly apiClient: JwtClient<HandleError>;
4719
4943
  constructor(apiClient: JwtClient<HandleError>);
4720
4944
  /**
4721
- * @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.
4722
- * @tags Technical Analysis
4723
- * @name GetCompanyTechnicalAnalysis
4724
- * @summary Get Company Technical Analysis
4725
- * @request GET:/companies/{company_id}/technical-analysis
4945
+ * @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
4946
+ * @tags Fund Metadata
4947
+ * @name GetFunds
4948
+ * @summary Get Funds
4949
+ * @request GET:/funds
4726
4950
  * @secure
4727
4951
  */
4728
- getCompanyTechnicalAnalysis(companyId: number, query?: {
4729
- /**
4730
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4731
- * @default "en-US"
4732
- */
4733
- language?: BridgeWiseLanguageEnum;
4952
+ getFunds(query?: {
4734
4953
  /**
4735
- * Trading Item Id
4736
- * Specify a BW trading asset identifier for a targeted query.
4954
+ * Search
4955
+ * Funds search.
4737
4956
  */
4738
- trading_item_id?: number;
4739
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
4740
- /**
4741
- * @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.
4742
- * @tags Technical Analysis
4743
- * @name GetCompanyTechnicalParagraphs
4744
- * @summary Get Company Technical Paragraphs
4745
- * @request GET:/companies/{company_id}/technical-paragraphs
4746
- * @secure
4747
- */
4748
- getCompanyTechnicalParagraphs(companyId: number, query?: {
4957
+ search?: string;
4749
4958
  /**
4750
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4751
- * @default "en-US"
4959
+ * Peers Of
4960
+ * Get peers funds of a specific fund.
4752
4961
  */
4753
- language?: BridgeWiseLanguageEnum;
4962
+ peers_of?: number;
4754
4963
  /**
4755
- * Trading Item Id
4756
- * Specify a BW trading asset identifier for a targeted query.
4964
+ * Theme Id
4965
+ * Comma-separated list of unique numeric identifiers for investment themes. <br>Example: 123,126</br>
4966
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4757
4967
  */
4758
- trading_item_id?: number;
4759
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
4760
- /**
4761
- * @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
4762
- * @tags Technical Analysis
4763
- * @name GetCompanyTechnicalParameters
4764
- * @summary Get Company Technical Parameters
4765
- * @request GET:/companies/{company_id}/technical-parameters
4766
- * @secure
4767
- */
4768
- getCompanyTechnicalParameters(companyId: number, query?: {
4968
+ theme_id?: string;
4969
+ /** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
4970
+ sort_by?: BridgeWiseFundsSortByEnum;
4769
4971
  /**
4770
4972
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4771
4973
  * @default "en-US"
4772
4974
  */
4773
4975
  language?: BridgeWiseLanguageEnum;
4774
4976
  /**
4775
- * Trading Item Id
4776
- * Specify a BW trading asset identifier for a targeted query.
4977
+ * Sponsor Id
4978
+ * Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
4979
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4777
4980
  */
4778
- trading_item_id?: number;
4981
+ sponsor_id?: string;
4779
4982
  /**
4780
- * Parameter Id
4781
- * Get desired parameter by ID.
4983
+ * Vehicle Type
4984
+ * Desired vehicle type for the fund.
4782
4985
  */
4783
- parameter_id?: number;
4784
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
4785
- }
4786
- export class Themes<HandleError extends boolean = boolean> {
4787
- protected readonly apiClient: JwtClient<HandleError>;
4788
- constructor(apiClient: JwtClient<HandleError>);
4789
- /**
4790
- * @description Retrieve a list of themes and their details associated with the company.
4791
- * @tags Themes
4792
- * @name GetCompanyThemes
4793
- * @summary Get Company Themes
4794
- * @request GET:/companies/{company_id}/themes
4795
- * @secure
4796
- */
4797
- getCompanyThemes(companyId: number, query?: {
4986
+ vehicle_type?: string;
4798
4987
  /**
4799
- * Sort By
4800
- * Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
4801
- * @default "group,rank"
4988
+ * Management Style Id
4989
+ * Comma-separated unique identifiers of the management style for the fund. <br>Example: 9617760,9617759</br>
4990
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4802
4991
  */
4803
- sort_by?: string | null;
4992
+ management_style_id?: string;
4804
4993
  /**
4805
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4806
- * @default "en-US"
4994
+ * Market Cap Emphasis Id
4995
+ * Comma-separated unique identifiers of market capitalization emphasis. <br>Example: 4072,4073</br>
4996
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4807
4997
  */
4808
- language?: BridgeWiseThemeLanguageEnum;
4809
- /** Filter themes by group. Allowed values: 1, 2, 3. */
4810
- group?: BridgeWiseThemeGroupEnum;
4811
- /** Filter basic and advanced theme packages. */
4812
- package?: BridgeWiseThemePackageEnum;
4813
- /** The type of the theme. */
4814
- type?: BridgeWiseThemeTypeEnum;
4998
+ market_cap_emphasis_id?: string;
4815
4999
  /**
4816
- * Page
4817
- * Define the page number for pagination.
4818
- * @min 1
4819
- * @default 1
5000
+ * Sector Emphasis Id
5001
+ * Comma-separated unique identifiers of sector emphasis <br>Example: 50,60</br>.
5002
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4820
5003
  */
4821
- page?: number;
5004
+ sector_emphasis_id?: string;
4822
5005
  /**
4823
- * Page Size
4824
- * Define the number of records per page for pagination purposes.
4825
- * @min 1
4826
- * @default 10
5006
+ * Geography Emphasis Id
5007
+ * Geography emphasis on sector for the fund. <br>Example: 30,37</br>
5008
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4827
5009
  */
4828
- page_size?: number;
4829
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
4830
- /**
4831
- * @description Retrieve a list of themes with their details. Filter by theme_id or search term, and order by any theme field. If no filter is provided, all themes are returned.
4832
- * @tags Themes
4833
- * @name GetThemes
4834
- * @summary Get Themes
4835
- * @request GET:/themes
4836
- * @secure
4837
- */
4838
- getThemes(query?: {
5010
+ geography_emphasis_id?: string;
4839
5011
  /**
4840
- * Search
4841
- * Search string to filter themes by name or description.
5012
+ * Exposure Id
5013
+ * Comma-separated unique exposure identifiers of the fund
5014
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4842
5015
  */
4843
- search?: string | null;
5016
+ exposure_id?: string;
4844
5017
  /**
4845
- * Sort By
4846
- * Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
4847
- * @default "rank"
5018
+ * Leverage
5019
+ * Comma-separated unique leverage values of the fund. <br>Example: -200,-100,100,125,200,300</br>
5020
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4848
5021
  */
4849
- sort_by?: string;
4850
- /**
4851
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4852
- * @default "en-US"
4853
- */
4854
- language?: BridgeWiseThemeLanguageEnum;
4855
- /** Filter basic and advanced theme packages. */
4856
- package?: BridgeWiseThemePackageEnum;
4857
- /** The type of the theme. */
4858
- type?: BridgeWiseThemeTypeEnum;
4859
- /**
4860
- * Page
4861
- * Define the page number for pagination.
4862
- * @min 1
4863
- * @default 1
4864
- */
4865
- page?: number;
4866
- /**
4867
- * Page Size
4868
- * Define the number of records per page for pagination purposes.
4869
- * @min 1
4870
- * @default 10
4871
- */
4872
- page_size?: number;
4873
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
4874
- /**
4875
- * @description Retrieve a specific theme by its ID.
4876
- * @tags Themes
4877
- * @name GetTheme
4878
- * @summary Get Theme
4879
- * @request GET:/themes/{theme_id}
4880
- * @secure
4881
- */
4882
- getTheme(themeId: number, query?: {
4883
- /**
4884
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4885
- * @default "en-US"
4886
- */
4887
- language?: BridgeWiseThemeLanguageEnum;
4888
- /**
4889
- * Include Filter
4890
- * Include theme filters.
4891
- * @default false
4892
- */
4893
- include_filter?: boolean;
4894
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
4895
- /**
4896
- * @tags Themes
4897
- * @name GetThemeFilters
4898
- * @summary Get Theme Filters
4899
- * @request GET:/themes/{theme_id}/filters
4900
- * @secure
4901
- */
4902
- getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
4903
- }
4904
- export class Metadata<HandleError extends boolean = boolean> {
4905
- protected readonly apiClient: JwtClient<HandleError>;
4906
- constructor(apiClient: JwtClient<HandleError>);
4907
- /**
4908
- * @description This endpoint provides filters
4909
- * @tags Metadata
4910
- * @name GetCompanyFilters
4911
- * @summary Get Company Filters
4912
- * @request GET:/filters
4913
- * @secure
4914
- */
4915
- getCompanyFilters(query: {
4916
- /** Desired filter type. */
4917
- type: BridgeWiseCompanyFilterType;
4918
- /**
4919
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4920
- * @default "en-US"
4921
- */
4922
- language?: BridgeWiseLanguageEnum;
4923
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
4924
- }
4925
- export class FundMetadata<HandleError extends boolean = boolean> {
4926
- protected readonly apiClient: JwtClient<HandleError>;
4927
- constructor(apiClient: JwtClient<HandleError>);
4928
- /**
4929
- * @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
4930
- * @tags Fund Metadata
4931
- * @name GetFunds
4932
- * @summary Get Funds
4933
- * @request GET:/funds
4934
- * @secure
4935
- */
4936
- getFunds(query?: {
4937
- /**
4938
- * Search
4939
- * Funds search.
4940
- */
4941
- search?: string;
4942
- /**
4943
- * Peers Of
4944
- * Get peers funds of a specific fund.
4945
- */
4946
- peers_of?: number;
4947
- /**
4948
- * Theme Id
4949
- * Comma-separated list of unique numeric identifiers for investment themes. <br>Example: 123,126</br>
4950
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4951
- */
4952
- theme_id?: string;
4953
- /** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
4954
- sort_by?: BridgeWiseFundsSortByEnum;
4955
- /**
4956
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4957
- * @default "en-US"
4958
- */
4959
- language?: BridgeWiseLanguageEnum;
4960
- /**
4961
- * Sponsor Id
4962
- * Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
4963
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4964
- */
4965
- sponsor_id?: string;
4966
- /**
4967
- * Vehicle Type
4968
- * Desired vehicle type for the fund.
4969
- */
4970
- vehicle_type?: string;
4971
- /**
4972
- * Management Style Id
4973
- * Comma-separated unique identifiers of the management style for the fund. <br>Example: 9617760,9617759</br>
4974
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4975
- */
4976
- management_style_id?: string;
4977
- /**
4978
- * Market Cap Emphasis Id
4979
- * Comma-separated unique identifiers of market capitalization emphasis. <br>Example: 4072,4073</br>
4980
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4981
- */
4982
- market_cap_emphasis_id?: string;
4983
- /**
4984
- * Sector Emphasis Id
4985
- * Comma-separated unique identifiers of sector emphasis <br>Example: 50,60</br>.
4986
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4987
- */
4988
- sector_emphasis_id?: string;
4989
- /**
4990
- * Geography Emphasis Id
4991
- * Geography emphasis on sector for the fund. <br>Example: 30,37</br>
4992
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4993
- */
4994
- geography_emphasis_id?: string;
4995
- /**
4996
- * Exposure Id
4997
- * Comma-separated unique exposure identifiers of the fund
4998
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4999
- */
5000
- exposure_id?: string;
5001
- /**
5002
- * Leverage
5003
- * Comma-separated unique leverage values of the fund. <br>Example: -200,-100,100,125,200,300</br>
5004
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5005
- */
5006
- leverage?: string;
5022
+ leverage?: string;
5007
5023
  /**
5008
5024
  * Leverage Not In
5009
5025
  * Comma-separated unique leverage values to exclude from the fund search results. <br>Example: -200,-100,100,125,200,300</br>
@@ -5314,223 +5330,156 @@ export class FundMetadata<HandleError extends boolean = boolean> {
5314
5330
  language?: BridgeWiseLanguageEnum;
5315
5331
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
5316
5332
  }
5317
- export class FundAnalysis<HandleError extends boolean = boolean> {
5333
+ export class Holdings<HandleError extends boolean = boolean> {
5318
5334
  protected readonly apiClient: JwtClient<HandleError>;
5319
5335
  constructor(apiClient: JwtClient<HandleError>);
5320
5336
  /**
5321
- * @description Returns Bridgewise final analysis for a specified fund.
5322
- * @tags Fund Analysis
5323
- * @name GetFundAnalysis
5324
- * @summary Get Fund Analysis
5325
- * @request GET:/funds/{fund_id}/analysis
5337
+ * @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.
5338
+ * @tags Holdings
5339
+ * @name GetCompositions
5340
+ * @summary Get Compositions
5341
+ * @request GET:/funds/{fund_id}/compositions
5326
5342
  * @secure
5327
5343
  */
5328
- getFundAnalysis(fundId: number, query?: {
5344
+ getCompositions(fundId: number, query?: {
5329
5345
  /**
5330
5346
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5331
5347
  * @default "en-US"
5332
5348
  */
5333
5349
  language?: BridgeWiseLanguageEnum;
5334
- /**
5335
- * Year
5336
- * Specify the year for which the analysis is requested.
5337
- */
5338
- year?: number;
5339
- /**
5340
- * Quarter
5341
- * Specify the quarter for which the analysis is requested.
5342
- */
5343
- quarter?: number;
5344
- /**
5345
- * Show All
5346
- * Boolean flag. Indicate whether to return historical data (`true/false`).
5347
- */
5348
- show_all?: boolean;
5349
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
5350
+ /** Filter data by specific components of the fund composition (e.g., stocks, others). */
5351
+ composition_type?: BridgeWiseCompositionTypeEnum;
5352
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
5350
5353
  /**
5351
- * @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.
5352
- * @tags Fund Analysis
5353
- * @name GetFundsParagraphs
5354
- * @summary Get Funds Paragraphs
5355
- * @request GET:/funds/{fund_id}/paragraphs
5354
+ * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
5355
+ * @tags Holdings
5356
+ * @name GetHoldingStatistics
5357
+ * @summary Get Holding Statistics
5358
+ * @request GET:/funds/{fund_id}/holding-statistics
5356
5359
  * @secure
5357
5360
  */
5358
- getFundsParagraphs(fundId: number, query?: {
5361
+ getHoldingStatistics(fundId: number, query?: {
5359
5362
  /**
5360
5363
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5361
5364
  * @default "en-US"
5362
5365
  */
5363
5366
  language?: BridgeWiseLanguageEnum;
5364
5367
  /**
5365
- * Year
5366
- * Specify the year for which the analysis is requested.
5368
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5369
+ * @default "stocks"
5367
5370
  */
5368
- year?: number | null;
5371
+ composition_type?: BridgeWiseCompositionTypeEnum;
5369
5372
  /**
5370
- * Quarter
5371
- * Specify the quarter for which the analysis is requested.
5373
+ * Page
5374
+ * Define the page number for pagination.
5375
+ * @exclusiveMin 0
5372
5376
  */
5373
- quarter?: number | null;
5374
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
5377
+ page?: number;
5378
+ /**
5379
+ * Page Size
5380
+ * Define the number of records per page for pagination purposes.
5381
+ * @exclusiveMin 0
5382
+ */
5383
+ page_size?: number;
5384
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5375
5385
  /**
5376
- * @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.
5377
- * @tags Fund Analysis
5378
- * @name GetFundParameters
5379
- * @summary Get Fund Parameters
5380
- * @request GET:/funds/{fund_id}/parameters
5386
+ * @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.
5387
+ * @tags Holdings
5388
+ * @name GetHoldings
5389
+ * @summary Get Holdings
5390
+ * @request GET:/funds/{fund_id}/holdings
5381
5391
  * @secure
5382
5392
  */
5383
- getFundParameters(fundId: number, query?: {
5393
+ getHoldings(fundId: number, query?: {
5384
5394
  /**
5385
5395
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5386
5396
  * @default "en-US"
5387
5397
  */
5388
5398
  language?: BridgeWiseLanguageEnum;
5389
5399
  /**
5390
- * Parameter Id
5391
- * ID of the parameter for analysis.
5400
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
5401
+ * @default "stocks"
5392
5402
  */
5393
- parameter_id?: number;
5394
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
5395
- /**
5396
- * @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.
5397
- * @tags Fund Analysis
5398
- * @name GetFundSections
5399
- * @summary Get Fund Sections
5400
- * @request GET:/funds/{fund_id}/sections
5401
- * @secure
5402
- */
5403
- getFundSections(fundId: number, query?: {
5403
+ composition_type?: BridgeWiseCompositionTypeEnum;
5404
5404
  /**
5405
- * Year
5406
- * Specify the year for which the analysis is requested.
5405
+ * Page
5406
+ * Define the page number for pagination.
5407
+ * @exclusiveMin 0
5407
5408
  */
5408
- year?: number;
5409
+ page?: number;
5409
5410
  /**
5410
- * Quarter
5411
- * Specify the quarter for which the analysis is requested.
5412
- */
5413
- quarter?: number;
5414
- /**
5415
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5416
- * @default "en-US"
5417
- */
5418
- language?: BridgeWiseLanguageEnum;
5419
- /**
5420
- * Show All
5421
- * Boolean flag. Indicate whether to return historical data (`true/false`).
5411
+ * Page Size
5412
+ * Define the number of records per page for pagination purposes.
5413
+ * @exclusiveMin 0
5422
5414
  */
5423
- show_all?: boolean;
5424
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
5415
+ page_size?: number;
5416
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5425
5417
  }
5426
- export class Holdings<HandleError extends boolean = boolean> {
5418
+ export class Logos<HandleError extends boolean = boolean> {
5427
5419
  protected readonly apiClient: JwtClient<HandleError>;
5428
5420
  constructor(apiClient: JwtClient<HandleError>);
5429
5421
  /**
5430
- * @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.
5431
- * @tags Holdings
5432
- * @name GetCompositions
5433
- * @summary Get Compositions
5434
- * @request GET:/funds/{fund_id}/compositions
5435
- * @secure
5436
- */
5437
- getCompositions(fundId: number, query?: {
5438
- /**
5439
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5440
- * @default "en-US"
5441
- */
5442
- language?: BridgeWiseLanguageEnum;
5443
- /** Filter data by specific components of the fund composition (e.g., stocks, others). */
5444
- composition_type?: BridgeWiseCompositionTypeEnum;
5445
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
5446
- /**
5447
- * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
5448
- * @tags Holdings
5449
- * @name GetHoldingStatistics
5450
- * @summary Get Holding Statistics
5451
- * @request GET:/funds/{fund_id}/holding-statistics
5422
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
5423
+ * @tags Logos
5424
+ * @name FetchLogos
5425
+ * @summary Fetch Logos
5426
+ * @request GET:/companies/logos
5452
5427
  * @secure
5453
5428
  */
5454
- getHoldingStatistics(fundId: number, query?: {
5429
+ fetchLogos(query?: {
5455
5430
  /**
5456
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5457
- * @default "en-US"
5431
+ * Company Id In
5432
+ * Specify a list of BW identifiers for bulk queries.
5433
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5434
+ * @example "74822,83343211"
5458
5435
  */
5459
- language?: BridgeWiseLanguageEnum;
5436
+ company_id__in?: string;
5460
5437
  /**
5461
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5462
- * @default "stocks"
5438
+ * Size
5439
+ * Page size
5440
+ * @min 1
5441
+ * @max 100
5442
+ * @default 50
5463
5443
  */
5464
- composition_type?: BridgeWiseCompositionTypeEnum;
5444
+ size?: number;
5465
5445
  /**
5466
5446
  * Page
5467
- * Define the page number for pagination.
5468
- * @exclusiveMin 0
5447
+ * Page number
5448
+ * @min 1
5449
+ * @default 1
5469
5450
  */
5470
5451
  page?: number;
5471
- /**
5472
- * Page Size
5473
- * Define the number of records per page for pagination purposes.
5474
- * @exclusiveMin 0
5475
- */
5476
- page_size?: number;
5477
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
5452
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
5478
5453
  /**
5479
- * @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.
5480
- * @tags Holdings
5481
- * @name GetHoldings
5482
- * @summary Get Holdings
5483
- * @request GET:/funds/{fund_id}/holdings
5454
+ * @description Retrieves the logo for a specified company using the provided company_id.
5455
+ * @tags Logos
5456
+ * @name FetchLogo
5457
+ * @summary Fetch Logo
5458
+ * @request GET:/companies/{company_id}/logos
5484
5459
  * @secure
5485
5460
  */
5486
- getHoldings(fundId: number, query?: {
5487
- /**
5488
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5489
- * @default "en-US"
5490
- */
5491
- language?: BridgeWiseLanguageEnum;
5492
- /**
5493
- * Filter data by specific components of the fund composition (e.g., stocks, others).
5494
- * @default "stocks"
5495
- */
5496
- composition_type?: BridgeWiseCompositionTypeEnum;
5497
- /**
5498
- * Page
5499
- * Define the page number for pagination.
5500
- * @exclusiveMin 0
5501
- */
5502
- page?: number;
5503
- /**
5504
- * Page Size
5505
- * Define the number of records per page for pagination purposes.
5506
- * @exclusiveMin 0
5507
- */
5508
- page_size?: number;
5509
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
5461
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
5510
5462
  }
5511
- export class FundEsgAnalysis<HandleError extends boolean = boolean> {
5463
+ export class Metadata<HandleError extends boolean = boolean> {
5512
5464
  protected readonly apiClient: JwtClient<HandleError>;
5513
5465
  constructor(apiClient: JwtClient<HandleError>);
5514
5466
  /**
5515
- * @description Provide the user all the minimum required data for the fund ESG score.
5516
- * @tags Fund ESG Analysis
5517
- * @name GetFundEsgAnalysis
5518
- * @summary Get Fund Esg Analysis
5519
- * @request GET:/funds/{fund_id}/esg-analysis
5467
+ * @description This endpoint provides filters
5468
+ * @tags Metadata
5469
+ * @name GetCompanyFilters
5470
+ * @summary Get Company Filters
5471
+ * @request GET:/filters
5520
5472
  * @secure
5521
5473
  */
5522
- getFundEsgAnalysis(fundId: number, query?: {
5523
- /**
5524
- * Limit
5525
- * Number of historical periods to be returned (default is 1).
5526
- */
5527
- limit?: number;
5474
+ getCompanyFilters(query: {
5475
+ /** Desired filter type. */
5476
+ type: BridgeWiseCompanyFilterType;
5528
5477
  /**
5529
5478
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5530
5479
  * @default "en-US"
5531
5480
  */
5532
5481
  language?: BridgeWiseLanguageEnum;
5533
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
5482
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
5534
5483
  }
5535
5484
  export class SectorAnalysis<HandleError extends boolean = boolean> {
5536
5485
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5566,85 +5515,262 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
5566
5515
  limit?: number;
5567
5516
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
5568
5517
  }
5569
- export class Tenants<HandleError extends boolean = boolean> {
5518
+ export class Segmentations<HandleError extends boolean = boolean> {
5570
5519
  protected readonly apiClient: JwtClient<HandleError>;
5571
5520
  constructor(apiClient: JwtClient<HandleError>);
5572
5521
  /**
5573
- * @tags Tenants
5574
- * @name FetchTenant
5575
- * @summary Fetch Tenant
5576
- * @request GET:/tenants/{tenant_id}
5577
- * @secure
5578
- */
5579
- fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
5580
- /**
5581
- * @tags Tenants
5582
- * @name GetHistoricalPolicyChanges
5583
- * @summary Get Historical Policy Changes
5584
- * @request GET:/tenants/{tenant_id}/historical-policy-changes
5522
+ * @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.
5523
+ * @tags Segmentations
5524
+ * @name GetSegmentParameters
5525
+ * @summary Get Segment Parameters
5526
+ * @request GET:/funds/{fund_id}/segment-parameters
5585
5527
  * @secure
5586
5528
  */
5587
- getHistoricalPolicyChanges(tenantId: string, query?: {
5588
- /**
5589
- * Company Ids
5590
- * Specify a list of BW identifiers for bulk queries.
5591
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5592
- * @example "74822,83343211"
5593
- */
5594
- company_ids?: string;
5529
+ getSegmentParameters(fundId: number, query?: {
5595
5530
  /**
5596
- * Start Date Gte
5597
- * Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
5598
- * @format date
5531
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5532
+ * @default "en-US"
5599
5533
  */
5600
- start_date__gte?: string;
5534
+ language?: BridgeWiseLanguageEnum;
5601
5535
  /**
5602
- * End Date Lte
5603
- * Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
5604
- * @format date
5536
+ * Segment
5537
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5605
5538
  */
5606
- end_date__lte?: string;
5539
+ segment?: string;
5607
5540
  /**
5608
- * Current Value
5609
- * Specify the current value reflecting the policy change
5541
+ * Segment Type
5542
+ * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5610
5543
  */
5611
- current_value?: number | boolean;
5612
- /** Type of event that is being requested. */
5613
- event_type?: BridgeWiseEventTypeEnum;
5544
+ segment_type?: string;
5545
+ /** Desired segment parameter type. */
5546
+ parameter_type?: BridgeWiseFundsSegmentParameterEnum;
5547
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
5548
+ /**
5549
+ * @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.
5550
+ * @tags Segmentations
5551
+ * @name GetSegment
5552
+ * @summary Get Segment
5553
+ * @request GET:/funds/{fund_id}/segments
5554
+ * @secure
5555
+ */
5556
+ getSegment(fundId: number, query?: {
5614
5557
  /**
5615
- * Size
5616
- * Define the maximum number of results to retrieve.
5617
- * @default 10
5618
- * @example 10
5558
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5559
+ * @default "en-US"
5619
5560
  */
5620
- size?: number;
5561
+ language?: BridgeWiseLanguageEnum;
5621
5562
  /**
5622
- * Page
5623
- * Define the page number for the results.
5624
- * @default 1
5625
- * @example 1
5563
+ * Segment
5564
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
5626
5565
  */
5627
- page?: number;
5628
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
5566
+ segment?: string;
5567
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
5568
+ }
5569
+ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
5570
+ protected readonly apiClient: JwtClient<HandleError>;
5571
+ constructor(apiClient: JwtClient<HandleError>);
5629
5572
  /**
5630
- * @tags Tenants
5631
- * @name CreateTenantInvestmentPoliciesConfig
5632
- * @summary Create Tenant Investment Policies Config
5633
- * @request POST:/tenants/{tenant_id}/investment-policies-config
5573
+ * @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.
5574
+ * @tags Technical Analysis
5575
+ * @name GetCompanyTechnicalAnalysis
5576
+ * @summary Get Company Technical Analysis
5577
+ * @request GET:/companies/{company_id}/technical-analysis
5634
5578
  * @secure
5635
5579
  */
5636
- createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
5580
+ getCompanyTechnicalAnalysis(companyId: number, query?: {
5581
+ /**
5582
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5583
+ * @default "en-US"
5584
+ */
5585
+ language?: BridgeWiseLanguageEnum;
5586
+ /**
5587
+ * Trading Item Id
5588
+ * Specify a BW trading asset identifier for a targeted query.
5589
+ */
5590
+ trading_item_id?: number;
5591
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
5637
5592
  /**
5638
- * @tags Tenants
5639
- * @name ListTenantInvestmentPoliciesConfigs
5640
- * @summary List Tenant Investment Policies Configs
5641
- * @request GET:/tenants/{tenant_id}/investment-policies-config
5593
+ * @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.
5594
+ * @tags Technical Analysis
5595
+ * @name GetCompanyTechnicalParagraphs
5596
+ * @summary Get Company Technical Paragraphs
5597
+ * @request GET:/companies/{company_id}/technical-paragraphs
5642
5598
  * @secure
5643
5599
  */
5644
- listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
5645
- /**
5646
- * @tags Tenants
5647
- * @name CreateTenantInvestmentPoliciesConfigBulk
5600
+ getCompanyTechnicalParagraphs(companyId: number, query?: {
5601
+ /**
5602
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5603
+ * @default "en-US"
5604
+ */
5605
+ language?: BridgeWiseLanguageEnum;
5606
+ /**
5607
+ * Trading Item Id
5608
+ * Specify a BW trading asset identifier for a targeted query.
5609
+ */
5610
+ trading_item_id?: number;
5611
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
5612
+ /**
5613
+ * @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
5614
+ * @tags Technical Analysis
5615
+ * @name GetCompanyTechnicalParameters
5616
+ * @summary Get Company Technical Parameters
5617
+ * @request GET:/companies/{company_id}/technical-parameters
5618
+ * @secure
5619
+ */
5620
+ getCompanyTechnicalParameters(companyId: number, query?: {
5621
+ /**
5622
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5623
+ * @default "en-US"
5624
+ */
5625
+ language?: BridgeWiseLanguageEnum;
5626
+ /**
5627
+ * Trading Item Id
5628
+ * Specify a BW trading asset identifier for a targeted query.
5629
+ */
5630
+ trading_item_id?: number;
5631
+ /**
5632
+ * Parameter Id
5633
+ * Get desired parameter by ID.
5634
+ */
5635
+ parameter_id?: number;
5636
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
5637
+ }
5638
+ export class TenantIdentifiers<HandleError extends boolean = boolean> {
5639
+ protected readonly apiClient: JwtClient<HandleError>;
5640
+ constructor(apiClient: JwtClient<HandleError>);
5641
+ /**
5642
+ * @description Get list of tenant identifiers
5643
+ * @tags Tenant Identifiers
5644
+ * @name GetTenantIdentifiers
5645
+ * @summary Get Tenant Identifiers
5646
+ * @request GET:/tenants/{tenant_id}/identifiers
5647
+ * @secure
5648
+ */
5649
+ getTenantIdentifiers(tenantId: string, query?: {
5650
+ /** Tenant custom identifier status. */
5651
+ status?: BridgeWiseTenantIdentifierStatusEnum;
5652
+ /**
5653
+ * Page
5654
+ * Define the page number for the results.
5655
+ * @default 1
5656
+ * @example 1
5657
+ */
5658
+ page?: number;
5659
+ /**
5660
+ * Page Size
5661
+ * Define the maximum number of results to retrieve.
5662
+ * @default 20
5663
+ * @example 10
5664
+ */
5665
+ page_size?: number;
5666
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
5667
+ /**
5668
+ * @description Create a new identifier for a tenant
5669
+ * @tags Tenant Identifiers
5670
+ * @name CreateTenantIdentifier
5671
+ * @summary Create Tenant Identifier
5672
+ * @request POST:/tenants/{tenant_id}/identifiers
5673
+ * @secure
5674
+ */
5675
+ createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5676
+ /**
5677
+ * @description Update an existing identifier for a tenant
5678
+ * @tags Tenant Identifiers
5679
+ * @name UpdateTenantIdentifier
5680
+ * @summary Update Tenant Identifier
5681
+ * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
5682
+ * @secure
5683
+ */
5684
+ updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5685
+ /**
5686
+ * @description Delete identifier for a tenant
5687
+ * @tags Tenant Identifiers
5688
+ * @name DeleteTenantIdentifier
5689
+ * @summary Delete Tenant Identifier
5690
+ * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
5691
+ * @secure
5692
+ */
5693
+ deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5694
+ }
5695
+ export class Tenants<HandleError extends boolean = boolean> {
5696
+ protected readonly apiClient: JwtClient<HandleError>;
5697
+ constructor(apiClient: JwtClient<HandleError>);
5698
+ /**
5699
+ * @tags Tenants
5700
+ * @name FetchTenant
5701
+ * @summary Fetch Tenant
5702
+ * @request GET:/tenants/{tenant_id}
5703
+ * @secure
5704
+ */
5705
+ fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
5706
+ /**
5707
+ * @tags Tenants
5708
+ * @name GetHistoricalPolicyChanges
5709
+ * @summary Get Historical Policy Changes
5710
+ * @request GET:/tenants/{tenant_id}/historical-policy-changes
5711
+ * @secure
5712
+ */
5713
+ getHistoricalPolicyChanges(tenantId: string, query?: {
5714
+ /**
5715
+ * Company Ids
5716
+ * Specify a list of BW identifiers for bulk queries.
5717
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5718
+ * @example "74822,83343211"
5719
+ */
5720
+ company_ids?: string;
5721
+ /**
5722
+ * Start Date Gte
5723
+ * Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
5724
+ * @format date
5725
+ */
5726
+ start_date__gte?: string;
5727
+ /**
5728
+ * End Date Lte
5729
+ * Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
5730
+ * @format date
5731
+ */
5732
+ end_date__lte?: string;
5733
+ /**
5734
+ * Current Value
5735
+ * Specify the current value reflecting the policy change
5736
+ */
5737
+ current_value?: number | boolean;
5738
+ /** Type of event that is being requested. */
5739
+ event_type?: BridgeWiseEventTypeEnum;
5740
+ /**
5741
+ * Size
5742
+ * Define the maximum number of results to retrieve.
5743
+ * @default 10
5744
+ * @example 10
5745
+ */
5746
+ size?: number;
5747
+ /**
5748
+ * Page
5749
+ * Define the page number for the results.
5750
+ * @default 1
5751
+ * @example 1
5752
+ */
5753
+ page?: number;
5754
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
5755
+ /**
5756
+ * @tags Tenants
5757
+ * @name CreateTenantInvestmentPoliciesConfig
5758
+ * @summary Create Tenant Investment Policies Config
5759
+ * @request POST:/tenants/{tenant_id}/investment-policies-config
5760
+ * @secure
5761
+ */
5762
+ createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
5763
+ /**
5764
+ * @tags Tenants
5765
+ * @name ListTenantInvestmentPoliciesConfigs
5766
+ * @summary List Tenant Investment Policies Configs
5767
+ * @request GET:/tenants/{tenant_id}/investment-policies-config
5768
+ * @secure
5769
+ */
5770
+ listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
5771
+ /**
5772
+ * @tags Tenants
5773
+ * @name CreateTenantInvestmentPoliciesConfigBulk
5648
5774
  * @summary Create Tenant Investment Policies Config Bulk
5649
5775
  * @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
5650
5776
  * @secure
@@ -5739,272 +5865,146 @@ export class Tenants<HandleError extends boolean = boolean> {
5739
5865
  */
5740
5866
  deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5741
5867
  }
5742
- export class TenantIdentifiers<HandleError extends boolean = boolean> {
5868
+ export class Themes<HandleError extends boolean = boolean> {
5743
5869
  protected readonly apiClient: JwtClient<HandleError>;
5744
5870
  constructor(apiClient: JwtClient<HandleError>);
5745
5871
  /**
5746
- * @description Get list of tenant identifiers
5747
- * @tags Tenant Identifiers
5748
- * @name GetTenantIdentifiers
5749
- * @summary Get Tenant Identifiers
5750
- * @request GET:/tenants/{tenant_id}/identifiers
5872
+ * @description Retrieve a list of themes and their details associated with the company.
5873
+ * @tags Themes
5874
+ * @name GetCompanyThemes
5875
+ * @summary Get Company Themes
5876
+ * @request GET:/companies/{company_id}/themes
5751
5877
  * @secure
5752
5878
  */
5753
- getTenantIdentifiers(tenantId: string, query?: {
5754
- /** Tenant custom identifier status. */
5755
- status?: BridgeWiseTenantIdentifierStatusEnum;
5879
+ getCompanyThemes(companyId: number, query?: {
5880
+ /**
5881
+ * Sort By
5882
+ * Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
5883
+ * @default "group,rank"
5884
+ */
5885
+ sort_by?: string | null;
5886
+ /**
5887
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5888
+ * @default "en-US"
5889
+ */
5890
+ language?: BridgeWiseThemeLanguageEnum;
5891
+ /** Filter themes by group. Allowed values: 1, 2, 3. */
5892
+ group?: BridgeWiseThemeGroupEnum;
5893
+ /** Filter basic and advanced theme packages. */
5894
+ package?: BridgeWiseThemePackageEnum;
5895
+ /** The type of the theme. */
5896
+ type?: BridgeWiseThemeTypeEnum;
5756
5897
  /**
5757
5898
  * Page
5758
- * Define the page number for the results.
5899
+ * Define the page number for pagination.
5900
+ * @min 1
5759
5901
  * @default 1
5760
- * @example 1
5761
5902
  */
5762
5903
  page?: number;
5763
5904
  /**
5764
5905
  * Page Size
5765
- * Define the maximum number of results to retrieve.
5766
- * @default 20
5767
- * @example 10
5906
+ * Define the number of records per page for pagination purposes.
5907
+ * @min 1
5908
+ * @default 10
5768
5909
  */
5769
5910
  page_size?: number;
5770
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
5771
- /**
5772
- * @description Create a new identifier for a tenant
5773
- * @tags Tenant Identifiers
5774
- * @name CreateTenantIdentifier
5775
- * @summary Create Tenant Identifier
5776
- * @request POST:/tenants/{tenant_id}/identifiers
5777
- * @secure
5778
- */
5779
- createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5780
- /**
5781
- * @description Update an existing identifier for a tenant
5782
- * @tags Tenant Identifiers
5783
- * @name UpdateTenantIdentifier
5784
- * @summary Update Tenant Identifier
5785
- * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
5786
- * @secure
5787
- */
5788
- updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
5789
- /**
5790
- * @description Delete identifier for a tenant
5791
- * @tags Tenant Identifiers
5792
- * @name DeleteTenantIdentifier
5793
- * @summary Delete Tenant Identifier
5794
- * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
5795
- * @secure
5796
- */
5797
- deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
5798
- }
5799
- export class Users<HandleError extends boolean = boolean> {
5800
- protected readonly apiClient: JwtClient<HandleError>;
5801
- constructor(apiClient: JwtClient<HandleError>);
5802
- /**
5803
- * @tags Users
5804
- * @name Authenticate
5805
- * @summary Authenticate
5806
- * @request POST:/users/authenticate
5807
- * @secure
5808
- */
5809
- authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
5810
- /**
5811
- * @tags Users
5812
- * @name FetchClientDetails
5813
- * @summary Fetch Client Details
5814
- * @request GET:/users/machine
5815
- * @secure
5816
- */
5817
- fetchClientDetails(headers: {
5818
- /** Authorization */
5819
- authorization: string;
5820
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
5821
- }
5822
- export class Segmentations<HandleError extends boolean = boolean> {
5823
- protected readonly apiClient: JwtClient<HandleError>;
5824
- constructor(apiClient: JwtClient<HandleError>);
5911
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
5825
5912
  /**
5826
- * @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.
5827
- * @tags Segmentations
5828
- * @name GetSegmentParameters
5829
- * @summary Get Segment Parameters
5830
- * @request GET:/funds/{fund_id}/segment-parameters
5913
+ * @description Retrieve a list of themes with their details. Filter by theme_id or search term, and order by any theme field. If no filter is provided, all themes are returned.
5914
+ * @tags Themes
5915
+ * @name GetThemes
5916
+ * @summary Get Themes
5917
+ * @request GET:/themes
5831
5918
  * @secure
5832
5919
  */
5833
- getSegmentParameters(fundId: number, query?: {
5920
+ getThemes(query?: {
5921
+ /**
5922
+ * Search
5923
+ * Search string to filter themes by name or description.
5924
+ */
5925
+ search?: string | null;
5926
+ /**
5927
+ * Sort By
5928
+ * Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
5929
+ * @default "rank"
5930
+ */
5931
+ sort_by?: string;
5834
5932
  /**
5835
5933
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5836
5934
  * @default "en-US"
5837
5935
  */
5838
- language?: BridgeWiseLanguageEnum;
5936
+ language?: BridgeWiseThemeLanguageEnum;
5937
+ /** Filter basic and advanced theme packages. */
5938
+ package?: BridgeWiseThemePackageEnum;
5939
+ /** The type of the theme. */
5940
+ type?: BridgeWiseThemeTypeEnum;
5839
5941
  /**
5840
- * Segment
5841
- * Filter data by specific segments within the fund holdings (e.g., sector, region).
5942
+ * Page
5943
+ * Define the page number for pagination.
5944
+ * @min 1
5945
+ * @default 1
5842
5946
  */
5843
- segment?: string;
5947
+ page?: number;
5844
5948
  /**
5845
- * Segment Type
5846
- * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
5949
+ * Page Size
5950
+ * Define the number of records per page for pagination purposes.
5951
+ * @min 1
5952
+ * @default 10
5847
5953
  */
5848
- segment_type?: string;
5849
- /** Desired segment parameter type. */
5850
- parameter_type?: BridgeWiseFundsSegmentParameterEnum;
5851
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
5954
+ page_size?: number;
5955
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
5852
5956
  /**
5853
- * @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.
5854
- * @tags Segmentations
5855
- * @name GetSegment
5856
- * @summary Get Segment
5857
- * @request GET:/funds/{fund_id}/segments
5957
+ * @description Retrieve a specific theme by its ID.
5958
+ * @tags Themes
5959
+ * @name GetTheme
5960
+ * @summary Get Theme
5961
+ * @request GET:/themes/{theme_id}
5858
5962
  * @secure
5859
5963
  */
5860
- getSegment(fundId: number, query?: {
5964
+ getTheme(themeId: number, query?: {
5861
5965
  /**
5862
5966
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5863
5967
  * @default "en-US"
5864
5968
  */
5865
- language?: BridgeWiseLanguageEnum;
5969
+ language?: BridgeWiseThemeLanguageEnum;
5866
5970
  /**
5867
- * Segment
5868
- * Filter data by specific segments within the fund holdings (e.g., sector, region).
5971
+ * Include Filter
5972
+ * Include theme filters.
5973
+ * @default false
5869
5974
  */
5870
- segment?: string;
5871
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
5872
- }
5873
- export class Bridget<HandleError extends boolean = boolean> {
5874
- protected readonly apiClient: JwtClient<HandleError>;
5875
- constructor(apiClient: JwtClient<HandleError>);
5876
- /**
5877
- * @tags Bridget
5878
- * @name QuestionsCreate
5879
- * @request POST:/questions
5880
- * @secure
5881
- */
5882
- questionsCreate(data: BridgeWiseQuestionsRequest, headers: {
5883
- /** User ID */
5884
- Userid: string;
5885
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
5975
+ include_filter?: boolean;
5976
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
5886
5977
  /**
5887
- * @tags Bridget
5888
- * @name TenantsQuestionsRetrieve
5889
- * @request GET:/tenants/{tenant_id}/questions
5978
+ * @tags Themes
5979
+ * @name GetThemeFilters
5980
+ * @summary Get Theme Filters
5981
+ * @request GET:/themes/{theme_id}/filters
5890
5982
  * @secure
5891
5983
  */
5892
- tenantsQuestionsRetrieve(tenantId: string, query?: {
5893
- /** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
5894
- client_id?: string;
5895
- /**
5896
- * Returns logs only for the specified calendar day (00:00–23:59 tenant time zone).
5897
- *
5898
- * Use either this field or the `start_date` + `end_date` pair.
5899
- *
5900
- * **Never** both in the same request.
5901
- *
5902
- * **Format:** YYYY-MM-DD
5903
- * @format date
5904
- */
5905
- date?: string;
5906
- /**
5907
- * Inclusive end of a date range.
5908
- *
5909
- * Must be greater than or equal to `start_date`.
5910
- *
5911
- * Use either the `date` field, OR use the `start_date` + `end_date` pair.
5912
- *
5913
- * **Never** use both in the same request.
5914
- *
5915
- * **Format:** YYYY-MM-DD
5916
- * @format date
5917
- */
5918
- end_date?: string;
5919
- /** Filters by user feedback on each answer. **Allowed values**: `like` | `dislike` */
5920
- feedback_type?: string;
5921
- /** Filters to a single chat session ID. */
5922
- session_id?: string;
5923
- /**
5924
- * Inclusive start of a date range.
5925
- *
5926
- * Use either the `date` field or this `start_date` + `end_date`pair.
5927
- *
5928
- * **Never** both in the same request.
5929
- *
5930
- * Required when end_date is provided.
5931
- *
5932
- * **Format:** YYYY-MM-DD
5933
- * @format date
5934
- */
5935
- start_date?: string;
5936
- /** Filters logs to a single end-user within the tenant. */
5937
- user_id?: string;
5938
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
5984
+ getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
5939
5985
  }
5940
- export class FundMarketData<HandleError extends boolean = boolean> {
5986
+ export class Users<HandleError extends boolean = boolean> {
5941
5987
  protected readonly apiClient: JwtClient<HandleError>;
5942
5988
  constructor(apiClient: JwtClient<HandleError>);
5943
5989
  /**
5944
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
5945
- * @tags Fund Market Data
5946
- * @name GetFundsMarketData
5947
- * @summary Get Funds Market Data
5948
- * @request GET:/funds/{fund_id}/market
5949
- * @secure
5950
- */
5951
- getFundsMarketData(fundId: number, query?: {
5952
- /**
5953
- * Trading Item Id
5954
- * Specify a BW trading asset identifier for a targeted query.
5955
- */
5956
- trading_item_id?: number | null;
5957
- /**
5958
- * Date Ge
5959
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
5960
- */
5961
- date__ge?: string | null;
5962
- /**
5963
- * Date Le
5964
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
5965
- */
5966
- date__le?: string | null;
5967
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
5968
- /**
5969
- * @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.
5970
- * @tags Fund Market Data
5971
- * @name GetFundsMarketStatistics
5972
- * @summary Get Funds Market Statistics
5973
- * @request GET:/funds/{fund_id}/market-statistics
5990
+ * @tags Users
5991
+ * @name Authenticate
5992
+ * @summary Authenticate
5993
+ * @request POST:/users/authenticate
5974
5994
  * @secure
5975
5995
  */
5976
- getFundsMarketStatistics(fundId: number, query?: {
5977
- /**
5978
- * Trading Item Id
5979
- * Specify a BW trading asset identifier for a targeted query.
5980
- */
5981
- trading_item_id?: number | null;
5982
- /**
5983
- * Identifier In
5984
- * Specify a list of external identifiers.
5985
- */
5986
- identifier__in?: string | null;
5987
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
5996
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
5988
5997
  /**
5989
- * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
5990
- * @tags Fund Market Data
5991
- * @name GetFundTradingItems
5992
- * @summary Get Fund Trading Items
5993
- * @request GET:/funds/{fund_id}/trading-items
5998
+ * @tags Users
5999
+ * @name FetchClientDetails
6000
+ * @summary Fetch Client Details
6001
+ * @request GET:/users/machine
5994
6002
  * @secure
5995
6003
  */
5996
- getFundTradingItems(fundId: number, query?: {
5997
- /**
5998
- * Primary Flag
5999
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
6000
- */
6001
- primary_flag?: boolean;
6002
- /**
6003
- * Security Primary Flag
6004
- * Boolean flag. Indicate if only primary asset data is required (true/false).
6005
- */
6006
- security_primary_flag?: boolean;
6007
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
6004
+ fetchClientDetails(headers: {
6005
+ /** Authorization */
6006
+ authorization: string;
6007
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
6008
6008
  }
6009
6009
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
6010
6010
  readonly config: JwtClientConfig<HandleError>;