@orbis-systems/orbis-api-clients 0.7.21 → 0.8.1

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 +441 -304
  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 +1193 -1163
  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/index.d.ts +3 -2
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.esm.js +1 -1
  16. package/dist/index.esm.js.map +1 -1
  17. package/dist/index.js +1 -1
  18. package/dist/index.js.map +1 -1
  19. package/dist/insight/index.d.ts +520 -506
  20. package/dist/insight/index.d.ts.map +1 -1
  21. package/dist/insight/index.esm.js +1 -1
  22. package/dist/insight/index.esm.js.map +1 -1
  23. package/dist/insight/index.js +1 -1
  24. package/dist/insight/index.js.map +1 -1
  25. package/dist/middleware/index.d.ts +26 -4
  26. package/dist/middleware/index.d.ts.map +1 -1
  27. package/dist/middleware/index.esm.js +1 -1
  28. package/dist/middleware/index.esm.js.map +1 -1
  29. package/dist/middleware/index.js +1 -1
  30. package/dist/middleware/index.js.map +1 -1
  31. package/dist/orbis/index.d.ts +3 -2
  32. package/dist/orbis/index.d.ts.map +1 -1
  33. package/dist/orbis/index.esm.js +1 -1
  34. package/dist/orbis/index.esm.js.map +1 -1
  35. package/dist/orbis/index.js +1 -1
  36. package/dist/orbis/index.js.map +1 -1
  37. package/dist/uma/index.d.ts +426 -436
  38. package/dist/uma/index.d.ts.map +1 -1
  39. package/dist/uma/index.esm.js +1 -1
  40. package/dist/uma/index.esm.js.map +1 -1
  41. package/dist/uma/index.js +1 -1
  42. package/dist/uma/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -64,7 +64,7 @@ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends B
64
64
  interface JwtClientConfig<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError> {
65
65
  authSchema?: string;
66
66
  autoRenewToken?: boolean;
67
- onRenewToken?: () => Promise<AuthData>;
67
+ onRenewTokens?: () => Promise<AuthData>;
68
68
  }
69
69
  interface JwtAuthData {
70
70
  accessToken: string;
@@ -74,8 +74,9 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
74
74
  protected readonly config: JwtClientConfig<HandleError, AuthData>;
75
75
  constructor(config: JwtClientConfig<HandleError, AuthData>);
76
76
  getConfig(): JwtClientConfig<HandleError>;
77
- setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
77
+ setRenewTokensCallback(renewTokensCallback: () => Promise<AuthData>): void;
78
78
  protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
79
+ protected renewTokens(): Promise<AuthData>;
79
80
  }
80
81
  /** Alert */
81
82
  export interface BridgeWiseAlert {
@@ -397,7 +398,7 @@ export interface BridgeWiseQuestionsRequest {
397
398
  */
398
399
  message: string;
399
400
  /**
400
- * Single chat session ID like: a1a5f8d2-4763-4c2d-bf56-29def26bdd4d
401
+ * Single chat session ID like: 826fdfae-0b61-408d-a959-4055c20ca1bc
401
402
  * @maxLength 256
402
403
  */
403
404
  session_id: string;
@@ -419,6 +420,21 @@ export interface BridgeWiseQuestionsRequest {
419
420
  * * `ja-JP` - ja
420
421
  * * `th-TH` - th
421
422
  * * `ko-KR` - ko
423
+ * * `it-IT` - it
424
+ * * `pl-PL` - pl
425
+ * * `sv-SE` - sv
426
+ * * `vi-VN` - vi
427
+ * * `da-DK` - da
428
+ * * `fil-PH` - fil
429
+ * * `fi-FI` - fi
430
+ * * `el-GR` - el
431
+ * * `hi-IN` - hi
432
+ * * `hu-HU` - hu
433
+ * * `id-ID` - id
434
+ * * `ms-MY` - ms
435
+ * * `mn-MN` - mn
436
+ * * `ro-RO` - ro
437
+ * * `ru-RU` - ru
422
438
  */
423
439
  language?: BridgeWiseLanguageEnum;
424
440
  /** Dict containing arbitrary, client-defined key-value pairs */
@@ -4044,6 +4060,121 @@ export class Alerts<HandleError extends boolean = boolean> {
4044
4060
  language?: BridgeWiseAlertLanguagesEnum;
4045
4061
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlertReason[], HandleError>>;
4046
4062
  }
4063
+ export class Bonds<HandleError extends boolean = boolean> {
4064
+ protected readonly apiClient: JwtClient<HandleError>;
4065
+ constructor(apiClient: JwtClient<HandleError>);
4066
+ /**
4067
+ * @tags Bonds
4068
+ * @name GetBondAnalysis
4069
+ * @summary Get Bond Analysis
4070
+ * @request GET:/bonds/{bond_id}/analysis
4071
+ * @secure
4072
+ */
4073
+ getBondAnalysis(bondId: number, query?: {
4074
+ /**
4075
+ * Language
4076
+ * @default "en-US"
4077
+ */
4078
+ language?: BridgeWiseLanguageEnum | null;
4079
+ /**
4080
+ * Limit
4081
+ * @min 1
4082
+ * @max 20
4083
+ * @default 1
4084
+ */
4085
+ limit?: number;
4086
+ /**
4087
+ * Universe type: industry or country
4088
+ * @default "industry"
4089
+ */
4090
+ universe?: BridgeWiseUniverseEnum;
4091
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondAnalysisResponse[], HandleError>>;
4092
+ /**
4093
+ * @description Retrieves a bond's market data by its ID from the database. The data returned is determined by the provided query parameters. This function utilizes a service layer to process the request and return the required information efficiently. :param db: The database instance used to query company data. :type db: DB :param bond_id: The unique identifier of the company whose details are to be fetched. :type bond_id: str :param params: Query parameters for customizing the response such as language preference and field configurations. :type params: BondMarketDataQueryParams :return: The market data corresponding to the given bond ID. :rtype: JSON
4094
+ * @tags Bonds
4095
+ * @name GetBondMarketData
4096
+ * @summary Get Bond Market Data
4097
+ * @request GET:/bonds/{bond_id}/market
4098
+ * @secure
4099
+ */
4100
+ getBondMarketData(bondId: string, query?: {
4101
+ /**
4102
+ * Date Gte
4103
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4104
+ */
4105
+ date__gte?: string;
4106
+ /**
4107
+ * Date Lte
4108
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4109
+ */
4110
+ date__lte?: string;
4111
+ /**
4112
+ * Trading Item Id
4113
+ * Specify a BW trading asset identifier for a targeted query.
4114
+ */
4115
+ trading_item_id?: string | null;
4116
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4117
+ /**
4118
+ * @description Returns calculated, cumulative returns over various historical periods.
4119
+ * @tags Bonds
4120
+ * @name GetBondMarketStatistics
4121
+ * @summary Get Bond Market Statistics
4122
+ * @request GET:/bonds/{bond_id}/market-statistics
4123
+ * @secure
4124
+ */
4125
+ getBondMarketStatistics(bondId: string, query?: {
4126
+ /**
4127
+ * Trading Item Id
4128
+ * Specify a BW trading asset identifier for a targeted query.
4129
+ */
4130
+ trading_item_id?: string | null;
4131
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4132
+ /**
4133
+ * @description Get paragraphs for a bond from DynamoDB table gold_credit_analysis_text.
4134
+ * @tags Bonds
4135
+ * @name GetBondParagraphs
4136
+ * @summary Get Bond Paragraphs
4137
+ * @request GET:/bonds/{bond_id}/paragraphs
4138
+ * @secure
4139
+ */
4140
+ getBondParagraphs(bondId: number, query?: {
4141
+ /**
4142
+ * Language
4143
+ * @default "en-US"
4144
+ */
4145
+ language?: BridgeWiseLanguageEnum | null;
4146
+ /**
4147
+ * Section Type
4148
+ * Filter output section objects by this parameter
4149
+ */
4150
+ section_type?: BridgeWiseBondsSectionTypeEnum | null;
4151
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondsParagraphItem[], HandleError>>;
4152
+ /**
4153
+ * @tags Bonds
4154
+ * @name GetBondSections
4155
+ * @summary Get Bond Sections
4156
+ * @request GET:/bonds/{bond_id}/sections
4157
+ * @secure
4158
+ */
4159
+ getBondSections(bondId: number, query?: {
4160
+ /**
4161
+ * Language
4162
+ * @default "en-US"
4163
+ */
4164
+ language?: BridgeWiseLanguageEnum | null;
4165
+ /** Year */
4166
+ year?: number | null;
4167
+ /** Quarter */
4168
+ quarter?: number | null;
4169
+ /**
4170
+ * Limit
4171
+ * @min 1
4172
+ * @max 20
4173
+ * @default 1
4174
+ */
4175
+ limit?: number;
4176
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionItem[], HandleError>>;
4177
+ }
4047
4178
  export class AlternativeAssets<HandleError extends boolean = boolean> {
4048
4179
  protected readonly apiClient: JwtClient<HandleError>;
4049
4180
  constructor(apiClient: JwtClient<HandleError>);
@@ -4233,829 +4364,387 @@ export class AlternativeAssets<HandleError extends boolean = boolean> {
4233
4364
  parameter_id?: number;
4234
4365
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetTechParameterItemList, HandleError>>;
4235
4366
  }
4236
- export class Bonds<HandleError extends boolean = boolean> {
4367
+ export class CompanyMetadata<HandleError extends boolean = boolean> {
4237
4368
  protected readonly apiClient: JwtClient<HandleError>;
4238
4369
  constructor(apiClient: JwtClient<HandleError>);
4239
4370
  /**
4240
- * @tags Bonds
4241
- * @name GetBondAnalysis
4242
- * @summary Get Bond Analysis
4243
- * @request GET:/bonds/{bond_id}/analysis
4371
+ * @description Enables users to search and filter companies based on a range of financial and non-financial criteria, returning a detailed list of companies that match the specified parameters.
4372
+ * @tags Company Metadata, Themes
4373
+ * @name GetCompanies
4374
+ * @summary Get Companies
4375
+ * @request GET:/companies
4244
4376
  * @secure
4245
4377
  */
4246
- getBondAnalysis(bondId: number, query?: {
4378
+ getCompanies(query?: {
4247
4379
  /**
4248
- * Language
4380
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4249
4381
  * @default "en-US"
4250
4382
  */
4251
- language?: BridgeWiseLanguageEnum | null;
4383
+ language?: BridgeWiseLanguageEnum;
4252
4384
  /**
4253
- * Limit
4254
- * @min 1
4255
- * @max 20
4256
- * @default 1
4385
+ * Peers Of
4386
+ * Peers companies of a specific company.
4257
4387
  */
4258
- limit?: number;
4388
+ peers_of?: number;
4259
4389
  /**
4260
- * Universe type: industry or country
4261
- * @default "industry"
4390
+ * Region Id
4391
+ * Comma-separated unique region identifiers. <br>Example: 10120,10238</br>
4392
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4262
4393
  */
4263
- universe?: BridgeWiseUniverseEnum;
4264
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondAnalysisResponse[], HandleError>>;
4265
- /**
4266
- * @description Retrieves a bond's market data by its ID from the database. The data returned is determined by the provided query parameters. This function utilizes a service layer to process the request and return the required information efficiently. :param db: The database instance used to query company data. :type db: DB :param bond_id: The unique identifier of the company whose details are to be fetched. :type bond_id: str :param params: Query parameters for customizing the response such as language preference and field configurations. :type params: BondMarketDataQueryParams :return: The market data corresponding to the given bond ID. :rtype: JSON
4267
- * @tags Bonds
4268
- * @name GetBondMarketData
4269
- * @summary Get Bond Market Data
4270
- * @request GET:/bonds/{bond_id}/market
4271
- * @secure
4272
- */
4273
- getBondMarketData(bondId: string, query?: {
4394
+ region_id?: string;
4274
4395
  /**
4275
- * Date Gte
4276
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
4396
+ * Incorporation Country Id
4397
+ * Comma-separated unique incorporation country ids. <br>Example: 117,213</br>
4398
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4277
4399
  */
4278
- date__gte?: string;
4400
+ incorporation_country_id?: string;
4279
4401
  /**
4280
- * Date Lte
4281
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
4402
+ * Domicile Country Id
4403
+ * Comma-separated unique domicile country ids. <br>Example: 188,150</br>
4404
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4282
4405
  */
4283
- date__lte?: string;
4406
+ domicile_country_id?: string;
4284
4407
  /**
4285
- * Trading Item Id
4286
- * Specify a BW trading asset identifier for a targeted query.
4408
+ * Gics Sector Id
4409
+ * Comma-separated unique gics sector identifiers. <br>Example: 50,60</br>
4410
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4287
4411
  */
4288
- trading_item_id?: string | null;
4289
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4290
- /**
4291
- * @description Returns calculated, cumulative returns over various historical periods.
4292
- * @tags Bonds
4293
- * @name GetBondMarketStatistics
4294
- * @summary Get Bond Market Statistics
4295
- * @request GET:/bonds/{bond_id}/market-statistics
4296
- * @secure
4297
- */
4298
- getBondMarketStatistics(bondId: string, query?: {
4412
+ gics_sector_id?: string;
4299
4413
  /**
4300
- * Trading Item Id
4301
- * Specify a BW trading asset identifier for a targeted query.
4414
+ * Gics Industry Group Id
4415
+ * Comma-separated unique gics industry group ids. <br>Example: 1510,2510</br>
4416
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4302
4417
  */
4303
- trading_item_id?: string | null;
4304
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4305
- /**
4306
- * @description Get paragraphs for a bond from DynamoDB table gold_credit_analysis_text.
4307
- * @tags Bonds
4308
- * @name GetBondParagraphs
4309
- * @summary Get Bond Paragraphs
4310
- * @request GET:/bonds/{bond_id}/paragraphs
4311
- * @secure
4312
- */
4313
- getBondParagraphs(bondId: number, query?: {
4418
+ gics_industry_group_id?: string;
4314
4419
  /**
4315
- * Language
4316
- * @default "en-US"
4420
+ * Gics Industry Id
4421
+ * Comma-separated unique gics industry identifiers. <br>Example: 151010,151020</br>
4422
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4317
4423
  */
4318
- language?: BridgeWiseLanguageEnum | null;
4424
+ gics_industry_id?: string;
4319
4425
  /**
4320
- * Section Type
4321
- * Filter output section objects by this parameter
4426
+ * Csa Industry Id
4427
+ * Comma-separated unique csa industry identifiers. <br>Example: 37,52</br>
4428
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4322
4429
  */
4323
- section_type?: BridgeWiseBondsSectionTypeEnum | null;
4324
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondsParagraphItem[], HandleError>>;
4325
- /**
4326
- * @tags Bonds
4327
- * @name GetBondSections
4328
- * @summary Get Bond Sections
4329
- * @request GET:/bonds/{bond_id}/sections
4330
- * @secure
4331
- */
4332
- getBondSections(bondId: number, query?: {
4430
+ csa_industry_id?: string;
4333
4431
  /**
4334
- * Language
4335
- * @default "en-US"
4432
+ * Theme Id
4433
+ * Comma-separated list of unique numeric identifiers for investment themes. If multiple themes are provided API returns only companies that have ALL specified themes. <br>Example: 123,126</br>
4434
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4336
4435
  */
4337
- language?: BridgeWiseLanguageEnum | null;
4338
- /** Year */
4339
- year?: number | null;
4340
- /** Quarter */
4341
- quarter?: number | null;
4436
+ theme_id?: string;
4342
4437
  /**
4343
- * Limit
4344
- * @min 1
4345
- * @max 20
4346
- * @default 1
4438
+ * Implied Market Cap Gte
4439
+ * Companies with market cap greater than or equal to.
4347
4440
  */
4348
- limit?: number;
4349
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionItem[], HandleError>>;
4350
- }
4351
- export class Bwc<HandleError extends boolean = boolean> {
4352
- protected readonly apiClient: JwtClient<HandleError>;
4353
- constructor(apiClient: JwtClient<HandleError>);
4354
- /**
4355
- * @description Get bulk data for a company
4356
- * @tags bwc
4357
- * @name Bulkdata
4358
- * @summary Bulkdata
4359
- * @request GET:/bulkdata/{name}
4360
- * @secure
4361
- */
4362
- bulkdata(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4363
- /**
4364
- * @description Get investment policy for a company
4365
- * @tags bwc
4366
- * @name InvestmentPolicy
4367
- * @summary Investment Policy
4368
- * @request GET:/investment-policy/{name}
4369
- * @secure
4370
- */
4371
- investmentPolicy(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
4372
- /**
4373
- * @description Get analysis for a company
4374
- * @tags bwc
4375
- * @name GetAnalysis
4376
- * @summary Get Analysis
4377
- * @request GET:/v2/analysis
4378
- * @secure
4379
- */
4380
- getAnalysis(query: {
4441
+ implied_market_cap__gte?: number;
4381
4442
  /**
4382
- * Identifier
4383
- * String of comma separated unique identifiers.
4384
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4385
- * @example "C74822,C83343214"
4443
+ * Implied Market Cap Lte
4444
+ * Companies with market cap less than or equal to.
4386
4445
  */
4387
- identifier: string;
4446
+ implied_market_cap__lte?: number;
4388
4447
  /**
4389
- * Language
4390
- * Desired language.
4391
- * @default "en-US"
4448
+ * Exchange Id
4449
+ * Comma-separated unique exchange identifiers. <br>Example: 104,106</br>
4392
4450
  */
4393
- language?: BridgeWiseLanguageEnum;
4451
+ exchange_id?: string;
4394
4452
  /**
4395
- * Section Types
4396
- * String of comma separated unique section types.
4397
- * @example "section_type1,section_type2"
4453
+ * Last Close Market Cap Usd Gte
4454
+ * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 250000000,200000000000</br>
4455
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4398
4456
  */
4399
- section_types?: string;
4457
+ last_close_market_cap_usd__gte?: string;
4400
4458
  /**
4401
- * Paragraph Types
4402
- * String of comma separated unique paragraph types.
4403
- * @example "paragraph_type1,paragraph_type2"
4459
+ * Last Close Market Cap Usd Lte
4460
+ * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 10000000000,200000000000</br>
4461
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4404
4462
  */
4405
- paragraph_types?: string;
4406
- }, headers: {
4463
+ last_close_market_cap_usd__lte?: string;
4407
4464
  /**
4408
- * Api-Key
4409
- * Desired Api Key.
4465
+ * Currency Market Id
4466
+ * Comma-separated unique currency market identifiers. <br>Example: 55,149</br>
4467
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4410
4468
  */
4411
- 'Api-Key': string;
4412
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResultV2[], HandleError>>;
4413
- /**
4414
- * @description Get business description for a company
4415
- * @tags bwc
4416
- * @name GetBusinessDescription
4417
- * @summary Get Business Description
4418
- * @request GET:/v2/business-description
4419
- * @secure
4420
- */
4421
- getBusinessDescription(query: {
4469
+ currency_market_id?: string;
4470
+ /** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -last_close_market_cap_usd</br> */
4471
+ sort_by?: BridgeWiseCompaniesSortByEnum;
4422
4472
  /**
4423
- * Identifier
4424
- * String of comma separated unique identifiers.
4425
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4426
- * @example "C74822,C83343214"
4473
+ * Filling Date Gte
4474
+ * Companies with filing dates greater than specific date.
4475
+ * @format date
4427
4476
  */
4428
- identifier: string;
4477
+ filling_date__gte?: string;
4429
4478
  /**
4430
- * Language
4431
- * Desired language.
4432
- * @default "en-US"
4479
+ * Search
4480
+ * Companies search.
4433
4481
  */
4434
- language?: BridgeWiseLanguageEnum;
4482
+ search?: string;
4435
4483
  /**
4436
- * Importancelevel
4437
- * Desired importance level.
4438
- * @default ""
4484
+ * Assets Turnover Gte
4485
+ * Assets turnover greater than or equal to.
4439
4486
  */
4440
- ImportanceLevel?: string;
4487
+ assets_turnover__gte?: number;
4441
4488
  /**
4442
- * Short Name
4443
- * Desired short name.
4444
- * @default "false"
4489
+ * Assets Turnover Lte
4490
+ * Assets turnover less than or equal to.
4445
4491
  */
4446
- short_name?: BridgeWiseStringBooleanEnum;
4447
- }, headers: {
4492
+ assets_turnover__lte?: number;
4448
4493
  /**
4449
- * Api-Key
4450
- * Desired Api Key.
4494
+ * Average Revenue Per Subscriber Gte
4495
+ * Average revenue per subscriber greater than or equal to.
4451
4496
  */
4452
- 'Api-Key': string;
4497
+ average_revenue_per_subscriber__gte?: number;
4453
4498
  /**
4454
- * Date-Format
4455
- * Desired date format.
4456
- * @default "epoch"
4499
+ * Average Revenue Per Subscriber Lte
4500
+ * Average revenue per subscriber less than or equal to.
4457
4501
  */
4458
- 'Date-Format'?: BridgeWiseGetBusinessDescriptionParamsDateFormatEnum;
4459
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBusinessDescriptionResultV2, HandleError>>;
4460
- /**
4461
- * @description Get fundamental analysis for a company
4462
- * @tags bwc
4463
- * @name GetFundamentalAnalysis
4464
- * @summary Get Fundamental Analysis
4465
- * @request GET:/v2/fundamental-analysis
4466
- * @secure
4467
- */
4468
- getFundamentalAnalysis(query: {
4502
+ average_revenue_per_subscriber__lte?: number;
4469
4503
  /**
4470
- * Identifier
4471
- * String of comma separated unique identifiers.
4472
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4473
- * @example "C74822,C83343214"
4504
+ * Pe Ratio Gte
4505
+ * Current PE ratio greater than or equal to.
4474
4506
  */
4475
- identifier: string;
4507
+ pe_ratio__gte?: number;
4476
4508
  /**
4477
- * Date Format
4478
- * Desired date format.
4479
- * @default "epoch"
4509
+ * Pe Ratio Lte
4510
+ * Current PE ratio less than or equal to.
4480
4511
  */
4481
- date_format?: BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum;
4512
+ pe_ratio__lte?: number;
4482
4513
  /**
4483
- * Importancelevel
4484
- * Desired importance level.
4485
- * @default ""
4514
+ * Current Ratio Gte
4515
+ * Current ratio greater than or equal to.
4486
4516
  */
4487
- ImportanceLevel?: string;
4517
+ current_ratio__gte?: number;
4488
4518
  /**
4489
- * Period
4490
- * Desired period.
4519
+ * Current Ratio Lte
4520
+ * Current ratio less than or equal to.
4491
4521
  */
4492
- period?: string;
4522
+ current_ratio__lte?: number;
4493
4523
  /**
4494
- * Language
4495
- * Desired language.
4496
- * @default "en-US"
4524
+ * Dividend Yield Percentage Gte
4525
+ * Dividend yield percent greater than or equal to.
4497
4526
  */
4498
- language?: BridgeWiseLanguageEnum;
4527
+ dividend_yield_percentage__gte?: number;
4499
4528
  /**
4500
- * Short Name
4501
- * Desired short name.
4502
- * @default "false"
4529
+ * Dividend Yield Percentage Lte
4530
+ * Dividend yield percent less than or equal to.
4503
4531
  */
4504
- short_name?: BridgeWiseStringBooleanEnum;
4532
+ dividend_yield_percentage__lte?: number;
4505
4533
  /**
4506
- * Summary
4507
- * Desired summary.
4508
- * @default "false"
4534
+ * Ebitda Margin Percent Gte
4535
+ * EBITDA margin percent greater than or equal to.
4509
4536
  */
4510
- summary?: BridgeWiseStringBooleanEnum;
4537
+ ebitda_margin_percent__gte?: number;
4511
4538
  /**
4512
- * Balance Sheet
4513
- * Desired balance sheet.
4514
- * @default "false"
4539
+ * Ebitda Margin Percent Lte
4540
+ * EBITDA margin percent less than or equal to.
4515
4541
  */
4516
- balance_sheet?: BridgeWiseStringBooleanEnum;
4542
+ ebitda_margin_percent__lte?: number;
4517
4543
  /**
4518
- * Income Statement
4519
- * Desired income statement.
4520
- * @default "false"
4544
+ * Ebit By Interest Expense Gte
4545
+ * EBIT by interest expense greater than or equal to.
4521
4546
  */
4522
- income_statement?: BridgeWiseStringBooleanEnum;
4547
+ ebit_by_interest_expense__gte?: number;
4523
4548
  /**
4524
- * Cash Flow
4525
- * Desired cash flow.
4526
- * @default "false"
4549
+ * Ebit By Interest Expense Lte
4550
+ * EBIT by interest expense less than or equal to.
4527
4551
  */
4528
- cash_flow?: BridgeWiseStringBooleanEnum;
4529
- }, headers: {
4552
+ ebit_by_interest_expense__lte?: number;
4530
4553
  /**
4531
- * Api-Key
4532
- * Desired Api Key.
4554
+ * Free Cash Flow Per Share Gte
4555
+ * Free cash flow per share greater than or equal to.
4533
4556
  */
4534
- 'Api-Key': string;
4535
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResultV2, HandleError>>;
4536
- /**
4537
- * @description Get industry description for a company
4538
- * @tags bwc
4539
- * @name GetIndustryDescription
4540
- * @summary Get Industry Description
4541
- * @request GET:/v2/industry-description
4542
- * @secure
4543
- */
4544
- getIndustryDescription(query: {
4557
+ free_cash_flow_per_share__gte?: number;
4545
4558
  /**
4546
- * Identifier
4547
- * String of comma separated unique identifiers.
4548
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4549
- * @example "C74822,C83343214"
4559
+ * Free Cash Flow Per Share Lte
4560
+ * Free cash flow per share less than or equal to.
4550
4561
  */
4551
- identifier: string;
4562
+ free_cash_flow_per_share__lte?: number;
4552
4563
  /**
4553
- * Period
4554
- * String of comma separated unique periods.
4555
- * @example "period1,period2"
4564
+ * Gross Profit Margin Percent Gte
4565
+ * Gross profit margin percent greater than or equal to.
4556
4566
  */
4557
- period?: string;
4567
+ gross_profit_margin_percent__gte?: number;
4558
4568
  /**
4559
- * Language
4560
- * Desired language.
4561
- * @default "en-US"
4569
+ * Gross Profit Margin Percent Lte
4570
+ * Gross profit margin percent less than or equal to.
4562
4571
  */
4563
- language?: BridgeWiseLanguageEnum;
4572
+ gross_profit_margin_percent__lte?: number;
4564
4573
  /**
4565
- * Importancelevel
4566
- * Desired importance level.
4567
- * @default ""
4574
+ * Last Close Tev Divided By Ebitda Gte
4575
+ * Last close TEV/EBITDA greater than or equal to.
4568
4576
  */
4569
- ImportanceLevel?: string;
4577
+ last_close_tev_divided_by_ebitda__gte?: number;
4570
4578
  /**
4571
- * Short Name
4572
- * Desired short name.
4573
- * @default "false"
4579
+ * Last Close Tev Divided By Ebitda Lte
4580
+ * Last close TEV/EBITDA less than or equal to.
4574
4581
  */
4575
- short_name?: BridgeWiseStringBooleanEnum;
4576
- }, headers: {
4582
+ last_close_tev_divided_by_ebitda__lte?: number;
4577
4583
  /**
4578
- * Api-Key
4579
- * Desired Api Key.
4584
+ * Long Term Debt By Total Capital Gte
4585
+ * Long term debt/total capital greater than or equal to.
4580
4586
  */
4581
- 'Api-Key': string;
4587
+ long_term_debt_by_total_capital__gte?: number;
4582
4588
  /**
4583
- * Date-Format
4584
- * Desired date format.
4585
- * @default "epoch"
4589
+ * Long Term Debt By Total Capital Lte
4590
+ * Long term debt/total capital less than or equal to.
4586
4591
  */
4587
- 'Date-Format'?: BridgeWiseGetIndustryDescriptionParamsDateFormatEnum;
4588
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseIndustryDescriptionResultV2, HandleError>>;
4589
- /**
4590
- * @description Get technical analysis for a company
4591
- * @tags bwc
4592
- * @name GetTechnicalAnalysis
4593
- * @summary Get Technical Analysis
4594
- * @request GET:/v2/technical-analysis
4595
- * @secure
4596
- */
4597
- getTechnicalAnalysis(query: {
4592
+ long_term_debt_by_total_capital__lte?: number;
4598
4593
  /**
4599
- * Identifier
4600
- * String of comma separated unique identifiers.
4601
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4602
- * @example "C74822,C83343214"
4594
+ * Net Eps Basic Gte
4595
+ * Net EPS basic greater than or equal to.
4603
4596
  */
4604
- identifier: string;
4597
+ net_eps_basic__gte?: number;
4605
4598
  /**
4606
- * Decimals
4607
- * Desired output round decimals.
4608
- * @default 2
4599
+ * Net Eps Basic Lte
4600
+ * Net EPS basic less than or equal to.
4609
4601
  */
4610
- decimals?: number;
4602
+ net_eps_basic__lte?: number;
4611
4603
  /**
4612
- * Language
4613
- * Desired language.
4614
- * @default "en-US"
4604
+ * Net Eps Diluted Gte
4605
+ * Net EPS diluted greater than or equal to.
4615
4606
  */
4616
- language?: BridgeWiseLanguageEnum;
4607
+ net_eps_diluted__gte?: number;
4617
4608
  /**
4618
- * Importancelevel
4619
- * Desired importance level.
4620
- * @default ""
4609
+ * Net Eps Diluted Lte
4610
+ * Net EPS diluted less than or equal to.
4621
4611
  */
4622
- ImportanceLevel?: string;
4612
+ net_eps_diluted__lte?: number;
4623
4613
  /**
4624
- * Short Name
4625
- * Desired short name.
4626
- * @default "false"
4614
+ * Net Debt Divided By Ebitda Gte
4615
+ * Net debt/EBITDA greater than or equal to.
4627
4616
  */
4628
- short_name?: BridgeWiseStringBooleanEnum;
4617
+ net_debt_divided_by_ebitda__gte?: number;
4629
4618
  /**
4630
- * Indicators
4631
- * Desired indicators.
4632
- * @default "true"
4619
+ * Net Debt Divided By Ebitda Lte
4620
+ * Net debt/EBITDA less than or equal to.
4633
4621
  */
4634
- indicators?: BridgeWiseStringBooleanEnum;
4622
+ net_debt_divided_by_ebitda__lte?: number;
4635
4623
  /**
4636
- * Sentiments
4637
- * Desired sentiments.
4638
- * @default "true"
4624
+ * Net Income Margin Percent Gte
4625
+ * Net income margin percent greater than or equal to.
4639
4626
  */
4640
- sentiments?: BridgeWiseStringBooleanEnum;
4627
+ net_income_margin_percent__gte?: number;
4641
4628
  /**
4642
- * Summary
4643
- * Desired summary.
4644
- * @default "false"
4629
+ * Net Income Margin Percent Lte
4630
+ * Net income margin percent less than or equal to.
4645
4631
  */
4646
- summary?: BridgeWiseStringBooleanEnum;
4647
- }, headers: {
4632
+ net_income_margin_percent__lte?: number;
4648
4633
  /**
4649
- * Api-Key
4650
- * Desired Api Key.
4634
+ * Operating Cash Flow By Current Liabilities Gte
4635
+ * Operating cash flow/current liabilities greater than or equal to.
4651
4636
  */
4652
- 'Api-Key': string;
4637
+ operating_cash_flow_by_current_liabilities__gte?: number;
4653
4638
  /**
4654
- * Date-Format
4655
- * Desired date format.
4656
- * @default "epoch"
4639
+ * Operating Cash Flow By Current Liabilities Lte
4640
+ * Operating cash flow/current liabilities less than or equal to
4657
4641
  */
4658
- 'Date-Format'?: BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum;
4659
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechnicalAnalysisResultV2, HandleError>>;
4660
- /**
4661
- * @description Verify if a company exists
4662
- * @tags bwc
4663
- * @name VerifyCompanyExists
4664
- * @summary Verify Company Exists
4665
- * @request GET:/v2/verify-company-exists
4666
- * @secure
4667
- */
4668
- verifyCompanyExists(query: {
4642
+ operating_cash_flow_by_current_liabilities__lte?: number;
4669
4643
  /**
4670
- * Identifier
4671
- * String of comma separated unique identifiers.
4672
- * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
4673
- * @example "C74822,C83343214"
4644
+ * Total Revenues One Year Growth Percentage Gte
4645
+ * Total revenues 1-year growth percent greater than or equal to
4674
4646
  */
4675
- identifier: string;
4676
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
4677
- }
4678
- export class CompanyMetadata<HandleError extends boolean = boolean> {
4679
- protected readonly apiClient: JwtClient<HandleError>;
4680
- constructor(apiClient: JwtClient<HandleError>);
4681
- /**
4682
- * @description Enables users to search and filter companies based on a range of financial and non-financial criteria, returning a detailed list of companies that match the specified parameters.
4683
- * @tags Company Metadata, Themes
4684
- * @name GetCompanies
4685
- * @summary Get Companies
4686
- * @request GET:/companies
4687
- * @secure
4688
- */
4689
- getCompanies(query?: {
4647
+ total_revenues_one_year_growth_percentage__gte?: number;
4690
4648
  /**
4691
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4692
- * @default "en-US"
4649
+ * Total Revenues One Year Growth Percentage Lte
4650
+ * Total revenues 1-year growth percent less than or equal to.
4693
4651
  */
4694
- language?: BridgeWiseLanguageEnum;
4652
+ total_revenues_one_year_growth_percentage__lte?: number;
4695
4653
  /**
4696
- * Peers Of
4697
- * Peers companies of a specific company.
4654
+ * Total Debt To Capital Percent Gte
4655
+ * Total debt to capital percent greater than or equal to.
4698
4656
  */
4699
- peers_of?: number;
4657
+ total_debt_to_capital_percent__gte?: number;
4700
4658
  /**
4701
- * Region Id
4702
- * Comma-separated unique region identifiers. <br>Example: 10120,10238</br>
4703
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4659
+ * Total Debt To Capital Percent Lte
4660
+ * Total debt to capital percent less than or equal to.
4704
4661
  */
4705
- region_id?: string;
4662
+ total_debt_to_capital_percent__lte?: number;
4706
4663
  /**
4707
- * Incorporation Country Id
4708
- * Comma-separated unique incorporation country ids. <br>Example: 117,213</br>
4709
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4664
+ * Period Last Price Divided Book Value Gte
4665
+ * Period last price/book value greater than or equal to.
4710
4666
  */
4711
- incorporation_country_id?: string;
4667
+ period_last_price_divided_book_value__gte?: number;
4712
4668
  /**
4713
- * Domicile Country Id
4714
- * Comma-separated unique domicile country ids. <br>Example: 188,150</br>
4715
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4669
+ * Period Last Price Divided Book Value Lte
4670
+ * Period last price/book value less than or equal to.
4716
4671
  */
4717
- domicile_country_id?: string;
4672
+ period_last_price_divided_book_value__lte?: number;
4718
4673
  /**
4719
- * Gics Sector Id
4720
- * Comma-separated unique gics sector identifiers. <br>Example: 50,60</br>
4721
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4674
+ * Payout Ratio Gte
4675
+ * Payout ratio greater than or equal to.
4722
4676
  */
4723
- gics_sector_id?: string;
4677
+ payout_ratio__gte?: number;
4724
4678
  /**
4725
- * Gics Industry Group Id
4726
- * Comma-separated unique gics industry group ids. <br>Example: 1510,2510</br>
4727
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4679
+ * Payout Ratio Lte
4680
+ * Payout ratio less than or equal to.
4728
4681
  */
4729
- gics_industry_group_id?: string;
4682
+ payout_ratio__lte?: number;
4730
4683
  /**
4731
- * Gics Industry Id
4732
- * Comma-separated unique gics industry identifiers. <br>Example: 151010,151020</br>
4733
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4684
+ * Quick Ratio Gte
4685
+ * Quick ratio greater than or equal to.
4734
4686
  */
4735
- gics_industry_id?: string;
4687
+ quick_ratio__gte?: number;
4736
4688
  /**
4737
- * Csa Industry Id
4738
- * Comma-separated unique csa industry identifiers. <br>Example: 37,52</br>
4739
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4689
+ * Quick Ratio Lte
4690
+ * Quick ratio less than or equal to.
4740
4691
  */
4741
- csa_industry_id?: string;
4692
+ quick_ratio__lte?: number;
4742
4693
  /**
4743
- * Theme Id
4744
- * Comma-separated list of unique numeric identifiers for investment themes. If multiple themes are provided API returns only companies that have ALL specified themes. <br>Example: 123,126</br>
4745
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4694
+ * Return On Equity Percent Gte
4695
+ * Return on equity percent greater than or equal to.
4746
4696
  */
4747
- theme_id?: string;
4697
+ return_on_equity_percent__gte?: number;
4748
4698
  /**
4749
- * Implied Market Cap Gte
4750
- * Companies with market cap greater than or equal to.
4699
+ * Return On Equity Percent Lte
4700
+ * Return on equity percent less than or equal to.
4751
4701
  */
4752
- implied_market_cap__gte?: number;
4702
+ return_on_equity_percent__lte?: number;
4753
4703
  /**
4754
- * Implied Market Cap Lte
4755
- * Companies with market cap less than or equal to.
4704
+ * Return On Assets Gte
4705
+ * Return on assets greater than or equal to.
4756
4706
  */
4757
- implied_market_cap__lte?: number;
4707
+ return_on_assets__gte?: number;
4758
4708
  /**
4759
- * Exchange Id
4760
- * Comma-separated unique exchange identifiers. <br>Example: 104,106</br>
4709
+ * Return On Assets Lte
4710
+ * Return on assets less than or equal to.
4761
4711
  */
4762
- exchange_id?: string;
4712
+ return_on_assets__lte?: number;
4763
4713
  /**
4764
- * Last Close Market Cap Usd Gte
4765
- * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 250000000,200000000000</br>
4766
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4714
+ * Return On Total Capital Gte
4715
+ * Return on total capital greater than or equal to.
4767
4716
  */
4768
- last_close_market_cap_usd__gte?: string;
4717
+ return_on_total_capital__gte?: number;
4769
4718
  /**
4770
- * Last Close Market Cap Usd Lte
4771
- * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 10000000000,200000000000</br>
4772
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4719
+ * Return On Total Capital Lte
4720
+ * Return on total capital less than or equal to.
4773
4721
  */
4774
- last_close_market_cap_usd__lte?: string;
4722
+ return_on_total_capital__lte?: number;
4775
4723
  /**
4776
- * Currency Market Id
4777
- * Comma-separated unique currency market identifiers. <br>Example: 55,149</br>
4778
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4724
+ * Revenue Per Employee In Thousands Gte
4725
+ * Revenue/employee in thousands greater than or equal to.
4779
4726
  */
4780
- currency_market_id?: string;
4781
- /** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -last_close_market_cap_usd</br> */
4782
- sort_by?: BridgeWiseCompaniesSortByEnum;
4727
+ revenue_per_employee_in_thousands__gte?: number;
4783
4728
  /**
4784
- * Filling Date Gte
4785
- * Companies with filing dates greater than specific date.
4786
- * @format date
4729
+ * Revenue Per Employee In Thousands Lte
4730
+ * Revenue/employee in thousands less than or equal to.
4787
4731
  */
4788
- filling_date__gte?: string;
4732
+ revenue_per_employee_in_thousands__lte?: number;
4789
4733
  /**
4790
- * Search
4791
- * Companies search.
4734
+ * Total Debt To Equity Gte
4735
+ * Total debt to equity greater than or equal to.
4792
4736
  */
4793
- search?: string;
4737
+ total_debt_to_equity__gte?: number;
4794
4738
  /**
4795
- * Assets Turnover Gte
4796
- * Assets turnover greater than or equal to.
4739
+ * Total Debt To Equity Lte
4740
+ * Total debt to equity less than or equal to.
4797
4741
  */
4798
- assets_turnover__gte?: number;
4742
+ total_debt_to_equity__lte?: number;
4799
4743
  /**
4800
- * Assets Turnover Lte
4801
- * Assets turnover less than or equal to.
4744
+ * Total Revenues Gte
4745
+ * Total revenues greater than or equal to.
4802
4746
  */
4803
- assets_turnover__lte?: number;
4804
- /**
4805
- * Average Revenue Per Subscriber Gte
4806
- * Average revenue per subscriber greater than or equal to.
4807
- */
4808
- average_revenue_per_subscriber__gte?: number;
4809
- /**
4810
- * Average Revenue Per Subscriber Lte
4811
- * Average revenue per subscriber less than or equal to.
4812
- */
4813
- average_revenue_per_subscriber__lte?: number;
4814
- /**
4815
- * Pe Ratio Gte
4816
- * Current PE ratio greater than or equal to.
4817
- */
4818
- pe_ratio__gte?: number;
4819
- /**
4820
- * Pe Ratio Lte
4821
- * Current PE ratio less than or equal to.
4822
- */
4823
- pe_ratio__lte?: number;
4824
- /**
4825
- * Current Ratio Gte
4826
- * Current ratio greater than or equal to.
4827
- */
4828
- current_ratio__gte?: number;
4829
- /**
4830
- * Current Ratio Lte
4831
- * Current ratio less than or equal to.
4832
- */
4833
- current_ratio__lte?: number;
4834
- /**
4835
- * Dividend Yield Percentage Gte
4836
- * Dividend yield percent greater than or equal to.
4837
- */
4838
- dividend_yield_percentage__gte?: number;
4839
- /**
4840
- * Dividend Yield Percentage Lte
4841
- * Dividend yield percent less than or equal to.
4842
- */
4843
- dividend_yield_percentage__lte?: number;
4844
- /**
4845
- * Ebitda Margin Percent Gte
4846
- * EBITDA margin percent greater than or equal to.
4847
- */
4848
- ebitda_margin_percent__gte?: number;
4849
- /**
4850
- * Ebitda Margin Percent Lte
4851
- * EBITDA margin percent less than or equal to.
4852
- */
4853
- ebitda_margin_percent__lte?: number;
4854
- /**
4855
- * Ebit By Interest Expense Gte
4856
- * EBIT by interest expense greater than or equal to.
4857
- */
4858
- ebit_by_interest_expense__gte?: number;
4859
- /**
4860
- * Ebit By Interest Expense Lte
4861
- * EBIT by interest expense less than or equal to.
4862
- */
4863
- ebit_by_interest_expense__lte?: number;
4864
- /**
4865
- * Free Cash Flow Per Share Gte
4866
- * Free cash flow per share greater than or equal to.
4867
- */
4868
- free_cash_flow_per_share__gte?: number;
4869
- /**
4870
- * Free Cash Flow Per Share Lte
4871
- * Free cash flow per share less than or equal to.
4872
- */
4873
- free_cash_flow_per_share__lte?: number;
4874
- /**
4875
- * Gross Profit Margin Percent Gte
4876
- * Gross profit margin percent greater than or equal to.
4877
- */
4878
- gross_profit_margin_percent__gte?: number;
4879
- /**
4880
- * Gross Profit Margin Percent Lte
4881
- * Gross profit margin percent less than or equal to.
4882
- */
4883
- gross_profit_margin_percent__lte?: number;
4884
- /**
4885
- * Last Close Tev Divided By Ebitda Gte
4886
- * Last close TEV/EBITDA greater than or equal to.
4887
- */
4888
- last_close_tev_divided_by_ebitda__gte?: number;
4889
- /**
4890
- * Last Close Tev Divided By Ebitda Lte
4891
- * Last close TEV/EBITDA less than or equal to.
4892
- */
4893
- last_close_tev_divided_by_ebitda__lte?: number;
4894
- /**
4895
- * Long Term Debt By Total Capital Gte
4896
- * Long term debt/total capital greater than or equal to.
4897
- */
4898
- long_term_debt_by_total_capital__gte?: number;
4899
- /**
4900
- * Long Term Debt By Total Capital Lte
4901
- * Long term debt/total capital less than or equal to.
4902
- */
4903
- long_term_debt_by_total_capital__lte?: number;
4904
- /**
4905
- * Net Eps Basic Gte
4906
- * Net EPS basic greater than or equal to.
4907
- */
4908
- net_eps_basic__gte?: number;
4909
- /**
4910
- * Net Eps Basic Lte
4911
- * Net EPS basic less than or equal to.
4912
- */
4913
- net_eps_basic__lte?: number;
4914
- /**
4915
- * Net Eps Diluted Gte
4916
- * Net EPS diluted greater than or equal to.
4917
- */
4918
- net_eps_diluted__gte?: number;
4919
- /**
4920
- * Net Eps Diluted Lte
4921
- * Net EPS diluted less than or equal to.
4922
- */
4923
- net_eps_diluted__lte?: number;
4924
- /**
4925
- * Net Debt Divided By Ebitda Gte
4926
- * Net debt/EBITDA greater than or equal to.
4927
- */
4928
- net_debt_divided_by_ebitda__gte?: number;
4929
- /**
4930
- * Net Debt Divided By Ebitda Lte
4931
- * Net debt/EBITDA less than or equal to.
4932
- */
4933
- net_debt_divided_by_ebitda__lte?: number;
4934
- /**
4935
- * Net Income Margin Percent Gte
4936
- * Net income margin percent greater than or equal to.
4937
- */
4938
- net_income_margin_percent__gte?: number;
4939
- /**
4940
- * Net Income Margin Percent Lte
4941
- * Net income margin percent less than or equal to.
4942
- */
4943
- net_income_margin_percent__lte?: number;
4944
- /**
4945
- * Operating Cash Flow By Current Liabilities Gte
4946
- * Operating cash flow/current liabilities greater than or equal to.
4947
- */
4948
- operating_cash_flow_by_current_liabilities__gte?: number;
4949
- /**
4950
- * Operating Cash Flow By Current Liabilities Lte
4951
- * Operating cash flow/current liabilities less than or equal to
4952
- */
4953
- operating_cash_flow_by_current_liabilities__lte?: number;
4954
- /**
4955
- * Total Revenues One Year Growth Percentage Gte
4956
- * Total revenues 1-year growth percent greater than or equal to
4957
- */
4958
- total_revenues_one_year_growth_percentage__gte?: number;
4959
- /**
4960
- * Total Revenues One Year Growth Percentage Lte
4961
- * Total revenues 1-year growth percent less than or equal to.
4962
- */
4963
- total_revenues_one_year_growth_percentage__lte?: number;
4964
- /**
4965
- * Total Debt To Capital Percent Gte
4966
- * Total debt to capital percent greater than or equal to.
4967
- */
4968
- total_debt_to_capital_percent__gte?: number;
4969
- /**
4970
- * Total Debt To Capital Percent Lte
4971
- * Total debt to capital percent less than or equal to.
4972
- */
4973
- total_debt_to_capital_percent__lte?: number;
4974
- /**
4975
- * Period Last Price Divided Book Value Gte
4976
- * Period last price/book value greater than or equal to.
4977
- */
4978
- period_last_price_divided_book_value__gte?: number;
4979
- /**
4980
- * Period Last Price Divided Book Value Lte
4981
- * Period last price/book value less than or equal to.
4982
- */
4983
- period_last_price_divided_book_value__lte?: number;
4984
- /**
4985
- * Payout Ratio Gte
4986
- * Payout ratio greater than or equal to.
4987
- */
4988
- payout_ratio__gte?: number;
4989
- /**
4990
- * Payout Ratio Lte
4991
- * Payout ratio less than or equal to.
4992
- */
4993
- payout_ratio__lte?: number;
4994
- /**
4995
- * Quick Ratio Gte
4996
- * Quick ratio greater than or equal to.
4997
- */
4998
- quick_ratio__gte?: number;
4999
- /**
5000
- * Quick Ratio Lte
5001
- * Quick ratio less than or equal to.
5002
- */
5003
- quick_ratio__lte?: number;
5004
- /**
5005
- * Return On Equity Percent Gte
5006
- * Return on equity percent greater than or equal to.
5007
- */
5008
- return_on_equity_percent__gte?: number;
5009
- /**
5010
- * Return On Equity Percent Lte
5011
- * Return on equity percent less than or equal to.
5012
- */
5013
- return_on_equity_percent__lte?: number;
5014
- /**
5015
- * Return On Assets Gte
5016
- * Return on assets greater than or equal to.
5017
- */
5018
- return_on_assets__gte?: number;
5019
- /**
5020
- * Return On Assets Lte
5021
- * Return on assets less than or equal to.
5022
- */
5023
- return_on_assets__lte?: number;
5024
- /**
5025
- * Return On Total Capital Gte
5026
- * Return on total capital greater than or equal to.
5027
- */
5028
- return_on_total_capital__gte?: number;
5029
- /**
5030
- * Return On Total Capital Lte
5031
- * Return on total capital less than or equal to.
5032
- */
5033
- return_on_total_capital__lte?: number;
5034
- /**
5035
- * Revenue Per Employee In Thousands Gte
5036
- * Revenue/employee in thousands greater than or equal to.
5037
- */
5038
- revenue_per_employee_in_thousands__gte?: number;
5039
- /**
5040
- * Revenue Per Employee In Thousands Lte
5041
- * Revenue/employee in thousands less than or equal to.
5042
- */
5043
- revenue_per_employee_in_thousands__lte?: number;
5044
- /**
5045
- * Total Debt To Equity Gte
5046
- * Total debt to equity greater than or equal to.
5047
- */
5048
- total_debt_to_equity__gte?: number;
5049
- /**
5050
- * Total Debt To Equity Lte
5051
- * Total debt to equity less than or equal to.
5052
- */
5053
- total_debt_to_equity__lte?: number;
5054
- /**
5055
- * Total Revenues Gte
5056
- * Total revenues greater than or equal to.
5057
- */
5058
- total_revenues__gte?: number;
4747
+ total_revenues__gte?: number;
5059
4748
  /**
5060
4749
  * Total Revenues Lte
5061
4750
  * Total revenues less than or equal to.
@@ -5197,230 +4886,557 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
5197
4886
  * Comma-separated unique section governance score groups. <br>Example: 1,2,3,4,5</br>
5198
4887
  * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5199
4888
  */
5200
- section_governance_score_group?: string;
4889
+ section_governance_score_group?: string;
4890
+ /**
4891
+ * Sector Score Gte
4892
+ * Sector score greater than or equal to.
4893
+ */
4894
+ sector_score__gte?: number;
4895
+ /**
4896
+ * Sector Score Lte
4897
+ * Sector score less than or equal to.
4898
+ */
4899
+ sector_score__lte?: number;
4900
+ /**
4901
+ * Sector Score Group
4902
+ * Comma-separated unique section sector score groups. <br>Example: 1,2,3,4,5</br>
4903
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4904
+ */
4905
+ sector_score_group?: string;
4906
+ /**
4907
+ * Analysis Technical Score Group
4908
+ * Comma-separated unique analysis technical score groups. <br>Example: 1,2,3,4,5</br>
4909
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4910
+ */
4911
+ analysis_technical_score_group?: string;
4912
+ /**
4913
+ * Analysis Technical Score Gte
4914
+ * Analysis technical score greater than or equal to.
4915
+ */
4916
+ analysis_technical_score__gte?: number;
4917
+ /**
4918
+ * Analysis Technical Score Lte
4919
+ * Analysis technical score less than or equal to.
4920
+ */
4921
+ analysis_technical_score__lte?: number;
4922
+ /**
4923
+ * Consensus Score Group
4924
+ * Comma-separated unique consensus score groups. <br>Example: 1,2,3,4,5</br>
4925
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4926
+ */
4927
+ consensus_score_group?: string;
4928
+ /**
4929
+ * Consensus Analyst Count Gte
4930
+ * Consensus analyst count greater than or equal to.
4931
+ */
4932
+ consensus_analyst_count__gte?: number;
4933
+ /**
4934
+ * Consensus Analyst Count Lte
4935
+ * Consensus analyst count less than or equal to.
4936
+ */
4937
+ consensus_analyst_count__lte?: number;
4938
+ /**
4939
+ * News Sentiment Gte
4940
+ * News sentiment greater than or equal to.
4941
+ */
4942
+ news_sentiment__gte?: number;
4943
+ /**
4944
+ * News Sentiment Lte
4945
+ * News sentiment less than or equal to.
4946
+ */
4947
+ news_sentiment__lte?: number;
4948
+ /**
4949
+ * Target Price To Last Close Gte
4950
+ * Target price to last close greater than or equal to.
4951
+ */
4952
+ target_price_to_last_close__gte?: number;
4953
+ /**
4954
+ * Target Price To Last Close Lte
4955
+ * Target price to last close less than or equal to.
4956
+ */
4957
+ target_price_to_last_close__lte?: number;
4958
+ /**
4959
+ * Fund Id
4960
+ * Comma-separated fund ids
4961
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4962
+ */
4963
+ fund_id?: string;
4964
+ /**
4965
+ * Tenant Id
4966
+ * Specify the tenant ID to filter and retrieve companies recommended by that tenant.
4967
+ * @format uuid
4968
+ */
4969
+ tenant_id?: string;
4970
+ /**
4971
+ * Internal Coverage
4972
+ * Internal coverage true or false.
4973
+ */
4974
+ internal_coverage?: boolean;
4975
+ /**
4976
+ * Policy Threshold
4977
+ * Policy threshold true or false.
4978
+ */
4979
+ policy_threshold?: boolean;
4980
+ /**
4981
+ * Return Range Gte
4982
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
4983
+ */
4984
+ return_range__gte?: string;
4985
+ /**
4986
+ * Return Value Gte
4987
+ * Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
4988
+ */
4989
+ return_value__gte?: string;
4990
+ /**
4991
+ * Return Range Lte
4992
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
4993
+ */
4994
+ return_range__lte?: string;
4995
+ /**
4996
+ * Return Value Lte
4997
+ * Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
4998
+ */
4999
+ return_value__lte?: string;
5000
+ /**
5001
+ * Scoring Method
5002
+ * Ability to screen and sort companies by country-based scores. Country-based scores: analysis_fundamental_score,section_income_statement_score,section_balance_sheet_score,section_cash_flow_score,analysis_fundamental_score_group,section_income_statement_score_group,section_balance_sheet_score_group,section_cash_flow_score_group. Options: <br>Example: country</br>
5003
+ */
5004
+ scoring_method?: string;
5005
+ /**
5006
+ * Page
5007
+ * Define the page number for pagination.
5008
+ * @exclusiveMin 0
5009
+ * @default 1
5010
+ */
5011
+ page?: number;
5012
+ /**
5013
+ * Page Size
5014
+ * Define the number of records per page for pagination purposes.
5015
+ * @exclusiveMin 0
5016
+ * @default 100
5017
+ */
5018
+ page_size?: number;
5019
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompaniesResponse, HandleError>>;
5020
+ /**
5021
+ * @description Retrieves the metadata object of a specific company identified by the company_id. It provides detailed information about the company's characteristics.
5022
+ * @tags Company Metadata
5023
+ * @name GetCompany
5024
+ * @summary Get Company
5025
+ * @request GET:/companies/{company_id}
5026
+ * @secure
5027
+ */
5028
+ getCompany(companyId: number, query?: {
5029
+ /**
5030
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5031
+ * @default "en-US"
5032
+ */
5033
+ language?: BridgeWiseLanguageEnum;
5034
+ /**
5035
+ * Include
5036
+ * Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`, `technical_analysis`, `earnings_call`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
5037
+ * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
5038
+ */
5039
+ include?: string;
5040
+ /**
5041
+ * Trading Item Id
5042
+ * Specify a BW trading asset identifier for a targeted query.
5043
+ */
5044
+ trading_item_id?: number;
5045
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyResponse[], HandleError>>;
5046
+ /**
5047
+ * @description Converts external identifiers (e.g., ISIN, ticker-exchange) into Bridgewise internal identifiers. This endpoint facilitates the mapping between external and internal identifiers for seamless integration within the Bridgewise ecosystem.
5048
+ * @tags Company Metadata, Fund Metadata
5049
+ * @name GetIdentifierSearch
5050
+ * @summary Get Identifier Search
5051
+ * @request GET:/identifier-search
5052
+ * @secure
5053
+ */
5054
+ getIdentifierSearch(query: {
5055
+ /**
5056
+ * Identifier
5057
+ * Specify an external identifier such as ISIN or ticker-exchange for asset identification.
5058
+ */
5059
+ identifier: string;
5060
+ /**
5061
+ * Identifier Type
5062
+ * Define the type of the external identifier provided.
5063
+ * e.g., ISIN, ticker-exchange. The field accepts either a single value or multiple comma-separated values. <br>Example: ticker_exchange, isin, custom, tase</br>
5064
+ * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
5065
+ */
5066
+ identifier_type: string;
5067
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
5068
+ }
5069
+ export class Logos<HandleError extends boolean = boolean> {
5070
+ protected readonly apiClient: JwtClient<HandleError>;
5071
+ constructor(apiClient: JwtClient<HandleError>);
5072
+ /**
5073
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
5074
+ * @tags Logos
5075
+ * @name FetchLogos
5076
+ * @summary Fetch Logos
5077
+ * @request GET:/companies/logos
5078
+ * @secure
5079
+ */
5080
+ fetchLogos(query?: {
5081
+ /**
5082
+ * Company Id In
5083
+ * Specify a list of BW identifiers for bulk queries.
5084
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5085
+ * @example "74822,83343211"
5086
+ */
5087
+ company_id__in?: string;
5088
+ /**
5089
+ * Size
5090
+ * Page size
5091
+ * @min 1
5092
+ * @max 100
5093
+ * @default 50
5094
+ */
5095
+ size?: number;
5096
+ /**
5097
+ * Page
5098
+ * Page number
5099
+ * @min 1
5100
+ * @default 1
5101
+ */
5102
+ page?: number;
5103
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
5104
+ /**
5105
+ * @description Retrieves the logo for a specified company using the provided company_id.
5106
+ * @tags Logos
5107
+ * @name FetchLogo
5108
+ * @summary Fetch Logo
5109
+ * @request GET:/companies/{company_id}/logos
5110
+ * @secure
5111
+ */
5112
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
5113
+ }
5114
+ export class Bwc<HandleError extends boolean = boolean> {
5115
+ protected readonly apiClient: JwtClient<HandleError>;
5116
+ constructor(apiClient: JwtClient<HandleError>);
5117
+ /**
5118
+ * @description Get bulk data for a company
5119
+ * @tags bwc
5120
+ * @name Bulkdata
5121
+ * @summary Bulkdata
5122
+ * @request GET:/bulkdata/{name}
5123
+ * @secure
5124
+ */
5125
+ bulkdata(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5126
+ /**
5127
+ * @description Get investment policy for a company
5128
+ * @tags bwc
5129
+ * @name InvestmentPolicy
5130
+ * @summary Investment Policy
5131
+ * @request GET:/investment-policy/{name}
5132
+ * @secure
5133
+ */
5134
+ investmentPolicy(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
5135
+ /**
5136
+ * @description Get analysis for a company
5137
+ * @tags bwc
5138
+ * @name GetAnalysis
5139
+ * @summary Get Analysis
5140
+ * @request GET:/v2/analysis
5141
+ * @secure
5142
+ */
5143
+ getAnalysis(query: {
5144
+ /**
5145
+ * Identifier
5146
+ * String of comma separated unique identifiers.
5147
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5148
+ * @example "C74822,C83343214"
5149
+ */
5150
+ identifier: string;
5151
+ /**
5152
+ * Language
5153
+ * Desired language.
5154
+ * @default "en-US"
5155
+ */
5156
+ language?: BridgeWiseLanguageEnum;
5157
+ /**
5158
+ * Section Types
5159
+ * String of comma separated unique section types.
5160
+ * @example "section_type1,section_type2"
5161
+ */
5162
+ section_types?: string;
5163
+ /**
5164
+ * Paragraph Types
5165
+ * String of comma separated unique paragraph types.
5166
+ * @example "paragraph_type1,paragraph_type2"
5167
+ */
5168
+ paragraph_types?: string;
5169
+ }, headers: {
5170
+ /**
5171
+ * Api-Key
5172
+ * Desired Api Key.
5173
+ */
5174
+ 'Api-Key': string;
5175
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResultV2[], HandleError>>;
5176
+ /**
5177
+ * @description Get business description for a company
5178
+ * @tags bwc
5179
+ * @name GetBusinessDescription
5180
+ * @summary Get Business Description
5181
+ * @request GET:/v2/business-description
5182
+ * @secure
5183
+ */
5184
+ getBusinessDescription(query: {
5201
5185
  /**
5202
- * Sector Score Gte
5203
- * Sector score greater than or equal to.
5186
+ * Identifier
5187
+ * String of comma separated unique identifiers.
5188
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5189
+ * @example "C74822,C83343214"
5204
5190
  */
5205
- sector_score__gte?: number;
5191
+ identifier: string;
5206
5192
  /**
5207
- * Sector Score Lte
5208
- * Sector score less than or equal to.
5193
+ * Language
5194
+ * Desired language.
5195
+ * @default "en-US"
5209
5196
  */
5210
- sector_score__lte?: number;
5197
+ language?: BridgeWiseLanguageEnum;
5211
5198
  /**
5212
- * Sector Score Group
5213
- * Comma-separated unique section sector score groups. <br>Example: 1,2,3,4,5</br>
5214
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5199
+ * Importancelevel
5200
+ * Desired importance level.
5201
+ * @default ""
5215
5202
  */
5216
- sector_score_group?: string;
5203
+ ImportanceLevel?: string;
5217
5204
  /**
5218
- * Analysis Technical Score Group
5219
- * Comma-separated unique analysis technical score groups. <br>Example: 1,2,3,4,5</br>
5220
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5205
+ * Short Name
5206
+ * Desired short name.
5207
+ * @default "false"
5221
5208
  */
5222
- analysis_technical_score_group?: string;
5209
+ short_name?: BridgeWiseStringBooleanEnum;
5210
+ }, headers: {
5223
5211
  /**
5224
- * Analysis Technical Score Gte
5225
- * Analysis technical score greater than or equal to.
5212
+ * Api-Key
5213
+ * Desired Api Key.
5226
5214
  */
5227
- analysis_technical_score__gte?: number;
5215
+ 'Api-Key': string;
5228
5216
  /**
5229
- * Analysis Technical Score Lte
5230
- * Analysis technical score less than or equal to.
5217
+ * Date-Format
5218
+ * Desired date format.
5219
+ * @default "epoch"
5231
5220
  */
5232
- analysis_technical_score__lte?: number;
5221
+ 'Date-Format'?: BridgeWiseGetBusinessDescriptionParamsDateFormatEnum;
5222
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBusinessDescriptionResultV2, HandleError>>;
5223
+ /**
5224
+ * @description Get fundamental analysis for a company
5225
+ * @tags bwc
5226
+ * @name GetFundamentalAnalysis
5227
+ * @summary Get Fundamental Analysis
5228
+ * @request GET:/v2/fundamental-analysis
5229
+ * @secure
5230
+ */
5231
+ getFundamentalAnalysis(query: {
5233
5232
  /**
5234
- * Consensus Score Group
5235
- * Comma-separated unique consensus score groups. <br>Example: 1,2,3,4,5</br>
5236
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5233
+ * Identifier
5234
+ * String of comma separated unique identifiers.
5235
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5236
+ * @example "C74822,C83343214"
5237
5237
  */
5238
- consensus_score_group?: string;
5238
+ identifier: string;
5239
5239
  /**
5240
- * Consensus Analyst Count Gte
5241
- * Consensus analyst count greater than or equal to.
5240
+ * Date Format
5241
+ * Desired date format.
5242
+ * @default "epoch"
5242
5243
  */
5243
- consensus_analyst_count__gte?: number;
5244
+ date_format?: BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum;
5244
5245
  /**
5245
- * Consensus Analyst Count Lte
5246
- * Consensus analyst count less than or equal to.
5246
+ * Importancelevel
5247
+ * Desired importance level.
5248
+ * @default ""
5247
5249
  */
5248
- consensus_analyst_count__lte?: number;
5250
+ ImportanceLevel?: string;
5249
5251
  /**
5250
- * News Sentiment Gte
5251
- * News sentiment greater than or equal to.
5252
+ * Period
5253
+ * Desired period.
5252
5254
  */
5253
- news_sentiment__gte?: number;
5255
+ period?: string;
5254
5256
  /**
5255
- * News Sentiment Lte
5256
- * News sentiment less than or equal to.
5257
+ * Language
5258
+ * Desired language.
5259
+ * @default "en-US"
5257
5260
  */
5258
- news_sentiment__lte?: number;
5261
+ language?: BridgeWiseLanguageEnum;
5259
5262
  /**
5260
- * Target Price To Last Close Gte
5261
- * Target price to last close greater than or equal to.
5263
+ * Short Name
5264
+ * Desired short name.
5265
+ * @default "false"
5262
5266
  */
5263
- target_price_to_last_close__gte?: number;
5267
+ short_name?: BridgeWiseStringBooleanEnum;
5264
5268
  /**
5265
- * Target Price To Last Close Lte
5266
- * Target price to last close less than or equal to.
5269
+ * Summary
5270
+ * Desired summary.
5271
+ * @default "false"
5267
5272
  */
5268
- target_price_to_last_close__lte?: number;
5273
+ summary?: BridgeWiseStringBooleanEnum;
5269
5274
  /**
5270
- * Fund Id
5271
- * Comma-separated fund ids
5272
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5275
+ * Balance Sheet
5276
+ * Desired balance sheet.
5277
+ * @default "false"
5273
5278
  */
5274
- fund_id?: string;
5279
+ balance_sheet?: BridgeWiseStringBooleanEnum;
5275
5280
  /**
5276
- * Tenant Id
5277
- * Specify the tenant ID to filter and retrieve companies recommended by that tenant.
5278
- * @format uuid
5281
+ * Income Statement
5282
+ * Desired income statement.
5283
+ * @default "false"
5279
5284
  */
5280
- tenant_id?: string;
5285
+ income_statement?: BridgeWiseStringBooleanEnum;
5281
5286
  /**
5282
- * Internal Coverage
5283
- * Internal coverage true or false.
5287
+ * Cash Flow
5288
+ * Desired cash flow.
5289
+ * @default "false"
5284
5290
  */
5285
- internal_coverage?: boolean;
5291
+ cash_flow?: BridgeWiseStringBooleanEnum;
5292
+ }, headers: {
5286
5293
  /**
5287
- * Policy Threshold
5288
- * Policy threshold true or false.
5294
+ * Api-Key
5295
+ * Desired Api Key.
5289
5296
  */
5290
- policy_threshold?: boolean;
5297
+ 'Api-Key': string;
5298
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResultV2, HandleError>>;
5299
+ /**
5300
+ * @description Get industry description for a company
5301
+ * @tags bwc
5302
+ * @name GetIndustryDescription
5303
+ * @summary Get Industry Description
5304
+ * @request GET:/v2/industry-description
5305
+ * @secure
5306
+ */
5307
+ getIndustryDescription(query: {
5291
5308
  /**
5292
- * Return Range Gte
5293
- * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
5309
+ * Identifier
5310
+ * String of comma separated unique identifiers.
5311
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5312
+ * @example "C74822,C83343214"
5294
5313
  */
5295
- return_range__gte?: string;
5314
+ identifier: string;
5296
5315
  /**
5297
- * Return Value Gte
5298
- * Comma-separated list of float values for minimum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
5316
+ * Period
5317
+ * String of comma separated unique periods.
5318
+ * @example "period1,period2"
5299
5319
  */
5300
- return_value__gte?: string;
5320
+ period?: string;
5301
5321
  /**
5302
- * Return Range Lte
5303
- * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
5322
+ * Language
5323
+ * Desired language.
5324
+ * @default "en-US"
5304
5325
  */
5305
- return_range__lte?: string;
5326
+ language?: BridgeWiseLanguageEnum;
5306
5327
  /**
5307
- * Return Value Lte
5308
- * Comma-separated list of float values for maximum threshold values <br>Example: 0.7,0.01,0.02,0.03,0.04,0.05,0.06,0.07</br>
5328
+ * Importancelevel
5329
+ * Desired importance level.
5330
+ * @default ""
5309
5331
  */
5310
- return_value__lte?: string;
5332
+ ImportanceLevel?: string;
5311
5333
  /**
5312
- * Scoring Method
5313
- * Ability to screen and sort companies by country-based scores. Country-based scores: analysis_fundamental_score,section_income_statement_score,section_balance_sheet_score,section_cash_flow_score,analysis_fundamental_score_group,section_income_statement_score_group,section_balance_sheet_score_group,section_cash_flow_score_group. Options: <br>Example: country</br>
5334
+ * Short Name
5335
+ * Desired short name.
5336
+ * @default "false"
5314
5337
  */
5315
- scoring_method?: string;
5338
+ short_name?: BridgeWiseStringBooleanEnum;
5339
+ }, headers: {
5316
5340
  /**
5317
- * Page
5318
- * Define the page number for pagination.
5319
- * @exclusiveMin 0
5320
- * @default 1
5341
+ * Api-Key
5342
+ * Desired Api Key.
5321
5343
  */
5322
- page?: number;
5344
+ 'Api-Key': string;
5323
5345
  /**
5324
- * Page Size
5325
- * Define the number of records per page for pagination purposes.
5326
- * @exclusiveMin 0
5327
- * @default 100
5346
+ * Date-Format
5347
+ * Desired date format.
5348
+ * @default "epoch"
5328
5349
  */
5329
- page_size?: number;
5330
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompaniesResponse, HandleError>>;
5350
+ 'Date-Format'?: BridgeWiseGetIndustryDescriptionParamsDateFormatEnum;
5351
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseIndustryDescriptionResultV2, HandleError>>;
5331
5352
  /**
5332
- * @description Retrieves the metadata object of a specific company identified by the company_id. It provides detailed information about the company's characteristics.
5333
- * @tags Company Metadata
5334
- * @name GetCompany
5335
- * @summary Get Company
5336
- * @request GET:/companies/{company_id}
5353
+ * @description Get technical analysis for a company
5354
+ * @tags bwc
5355
+ * @name GetTechnicalAnalysis
5356
+ * @summary Get Technical Analysis
5357
+ * @request GET:/v2/technical-analysis
5337
5358
  * @secure
5338
5359
  */
5339
- getCompany(companyId: number, query?: {
5360
+ getTechnicalAnalysis(query: {
5340
5361
  /**
5341
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
5362
+ * Identifier
5363
+ * String of comma separated unique identifiers.
5364
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5365
+ * @example "C74822,C83343214"
5366
+ */
5367
+ identifier: string;
5368
+ /**
5369
+ * Decimals
5370
+ * Desired output round decimals.
5371
+ * @default 2
5372
+ */
5373
+ decimals?: number;
5374
+ /**
5375
+ * Language
5376
+ * Desired language.
5342
5377
  * @default "en-US"
5343
5378
  */
5344
5379
  language?: BridgeWiseLanguageEnum;
5345
5380
  /**
5346
- * Include
5347
- * Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`, `technical_analysis`, `earnings_call`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
5348
- * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
5381
+ * Importancelevel
5382
+ * Desired importance level.
5383
+ * @default ""
5349
5384
  */
5350
- include?: string;
5385
+ ImportanceLevel?: string;
5351
5386
  /**
5352
- * Trading Item Id
5353
- * Specify a BW trading asset identifier for a targeted query.
5387
+ * Short Name
5388
+ * Desired short name.
5389
+ * @default "false"
5354
5390
  */
5355
- trading_item_id?: number;
5356
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyResponse[], HandleError>>;
5357
- /**
5358
- * @description Converts external identifiers (e.g., ISIN, ticker-exchange) into Bridgewise internal identifiers. This endpoint facilitates the mapping between external and internal identifiers for seamless integration within the Bridgewise ecosystem.
5359
- * @tags Company Metadata, Fund Metadata
5360
- * @name GetIdentifierSearch
5361
- * @summary Get Identifier Search
5362
- * @request GET:/identifier-search
5363
- * @secure
5364
- */
5365
- getIdentifierSearch(query: {
5391
+ short_name?: BridgeWiseStringBooleanEnum;
5366
5392
  /**
5367
- * Identifier
5368
- * Specify an external identifier such as ISIN or ticker-exchange for asset identification.
5393
+ * Indicators
5394
+ * Desired indicators.
5395
+ * @default "true"
5369
5396
  */
5370
- identifier: string;
5397
+ indicators?: BridgeWiseStringBooleanEnum;
5371
5398
  /**
5372
- * Identifier Type
5373
- * Define the type of the external identifier provided.
5374
- * e.g., ISIN, ticker-exchange. The field accepts either a single value or multiple comma-separated values. <br>Example: ticker_exchange, isin, custom, tase</br>
5375
- * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
5399
+ * Sentiments
5400
+ * Desired sentiments.
5401
+ * @default "true"
5376
5402
  */
5377
- identifier_type: string;
5378
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
5379
- }
5380
- export class Logos<HandleError extends boolean = boolean> {
5381
- protected readonly apiClient: JwtClient<HandleError>;
5382
- constructor(apiClient: JwtClient<HandleError>);
5383
- /**
5384
- * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
5385
- * @tags Logos
5386
- * @name FetchLogos
5387
- * @summary Fetch Logos
5388
- * @request GET:/companies/logos
5389
- * @secure
5390
- */
5391
- fetchLogos(query?: {
5403
+ sentiments?: BridgeWiseStringBooleanEnum;
5392
5404
  /**
5393
- * Company Id In
5394
- * Specify a list of BW identifiers for bulk queries.
5395
- * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
5396
- * @example "74822,83343211"
5405
+ * Summary
5406
+ * Desired summary.
5407
+ * @default "false"
5397
5408
  */
5398
- company_id__in?: string;
5409
+ summary?: BridgeWiseStringBooleanEnum;
5410
+ }, headers: {
5399
5411
  /**
5400
- * Size
5401
- * Page size
5402
- * @min 1
5403
- * @max 100
5404
- * @default 50
5412
+ * Api-Key
5413
+ * Desired Api Key.
5405
5414
  */
5406
- size?: number;
5415
+ 'Api-Key': string;
5407
5416
  /**
5408
- * Page
5409
- * Page number
5410
- * @min 1
5411
- * @default 1
5417
+ * Date-Format
5418
+ * Desired date format.
5419
+ * @default "epoch"
5412
5420
  */
5413
- page?: number;
5414
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
5421
+ 'Date-Format'?: BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum;
5422
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechnicalAnalysisResultV2, HandleError>>;
5415
5423
  /**
5416
- * @description Retrieves the logo for a specified company using the provided company_id.
5417
- * @tags Logos
5418
- * @name FetchLogo
5419
- * @summary Fetch Logo
5420
- * @request GET:/companies/{company_id}/logos
5424
+ * @description Verify if a company exists
5425
+ * @tags bwc
5426
+ * @name VerifyCompanyExists
5427
+ * @summary Verify Company Exists
5428
+ * @request GET:/v2/verify-company-exists
5421
5429
  * @secure
5422
5430
  */
5423
- fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
5431
+ verifyCompanyExists(query: {
5432
+ /**
5433
+ * Identifier
5434
+ * String of comma separated unique identifiers.
5435
+ * @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
5436
+ * @example "C74822,C83343214"
5437
+ */
5438
+ identifier: string;
5439
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
5424
5440
  }
5425
5441
  export class Activities<HandleError extends boolean = boolean> {
5426
5442
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5935,6 +5951,20 @@ export class CompanyNews<HandleError extends boolean = boolean> {
5935
5951
  */
5936
5952
  page?: number;
5937
5953
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
5954
+ /**
5955
+ * @tags Company News
5956
+ * @name GetNewsParagraphForACompany
5957
+ * @summary Get news paragraph for a company
5958
+ * @request GET:/companies/{company_id}/news-paragraph
5959
+ * @secure
5960
+ */
5961
+ getNewsParagraphForACompany(companyId: string, query?: {
5962
+ /**
5963
+ * Language code for the paragraph
5964
+ * @default "en-US"
5965
+ */
5966
+ language?: BridgeWiseLanguageEnum;
5967
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetLLMNewsParagraph, HandleError>>;
5938
5968
  /**
5939
5969
  * @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.
5940
5970
  * @tags Company News
@@ -6108,65 +6138,6 @@ export class Metadata<HandleError extends boolean = boolean> {
6108
6138
  language?: BridgeWiseLanguageEnum;
6109
6139
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
6110
6140
  }
6111
- export class Holdings<HandleError extends boolean = boolean> {
6112
- protected readonly apiClient: JwtClient<HandleError>;
6113
- constructor(apiClient: JwtClient<HandleError>);
6114
- /**
6115
- * @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.
6116
- * @tags Holdings
6117
- * @name GetCompositions
6118
- * @summary Get Compositions
6119
- * @request GET:/funds/{fund_id}/compositions
6120
- * @secure
6121
- */
6122
- getCompositions(fundId: number, query?: {
6123
- /**
6124
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6125
- * @default "en-US"
6126
- */
6127
- language?: BridgeWiseLanguageEnum;
6128
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
6129
- /**
6130
- * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
6131
- * @tags Holdings
6132
- * @name GetHoldingStatistics
6133
- * @summary Get Holding Statistics
6134
- * @request GET:/funds/{fund_id}/holding-statistics
6135
- * @secure
6136
- */
6137
- getHoldingStatistics(fundId: number, query?: {
6138
- /**
6139
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6140
- * @default "en-US"
6141
- */
6142
- language?: BridgeWiseLanguageEnum;
6143
- /**
6144
- * Composition Type
6145
- * Composition type for fund holding statistics
6146
- */
6147
- composition_type?: string;
6148
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
6149
- /**
6150
- * @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.
6151
- * @tags Holdings
6152
- * @name GetHoldings
6153
- * @summary Get Holdings
6154
- * @request GET:/funds/{fund_id}/holdings
6155
- * @secure
6156
- */
6157
- getHoldings(fundId: number, query?: {
6158
- /**
6159
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6160
- * @default "en-US"
6161
- */
6162
- language?: BridgeWiseLanguageEnum;
6163
- /**
6164
- * Composition Type
6165
- * Composition type for fund holdings
6166
- */
6167
- composition_type?: string;
6168
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
6169
- }
6170
6141
  export class FundMetadata<HandleError extends boolean = boolean> {
6171
6142
  protected readonly apiClient: JwtClient<HandleError>;
6172
6143
  constructor(apiClient: JwtClient<HandleError>);
@@ -6541,29 +6512,138 @@ export class FundMetadata<HandleError extends boolean = boolean> {
6541
6512
  * @exclusiveMin 0
6542
6513
  * @default 100
6543
6514
  */
6544
- page_size?: number;
6545
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
6515
+ page_size?: number;
6516
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
6517
+ /**
6518
+ * @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
6519
+ * @tags Fund Metadata
6520
+ * @name GetFund
6521
+ * @summary Get Fund
6522
+ * @request GET:/funds/{fund_id}
6523
+ * @secure
6524
+ */
6525
+ getFund(fundId: number, query?: {
6526
+ /**
6527
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6528
+ * @default "en-US"
6529
+ */
6530
+ language?: BridgeWiseLanguageEnum;
6531
+ /**
6532
+ * Include
6533
+ * Comma-separated list of additional resources to include in the response. Supported values: `holdings`, `holding_statistics`, `compositions`, `analysis`, `sections`, `esg_analysis`, `parameters`, `segments`, `segment_parameters`, `paragraphs`, `market`, `market_statistics`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `holdings__composition_type=stock` retrieves only stock holdings. Details about available filters can be found under the corresponding resource documentation.
6534
+ * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
6535
+ */
6536
+ include?: string;
6537
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
6538
+ }
6539
+ export class FundAnalysis<HandleError extends boolean = boolean> {
6540
+ protected readonly apiClient: JwtClient<HandleError>;
6541
+ constructor(apiClient: JwtClient<HandleError>);
6542
+ /**
6543
+ * @description Returns Bridgewise final analysis for a specified fund.
6544
+ * @tags Fund Analysis
6545
+ * @name GetFundAnalysis
6546
+ * @summary Get Fund Analysis
6547
+ * @request GET:/funds/{fund_id}/analysis
6548
+ * @secure
6549
+ */
6550
+ getFundAnalysis(fundId: number, query?: {
6551
+ /**
6552
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6553
+ * @default "en-US"
6554
+ */
6555
+ language?: BridgeWiseLanguageEnum;
6556
+ /**
6557
+ * Year
6558
+ * Specify the year for which the analysis is requested.
6559
+ */
6560
+ year?: number;
6561
+ /**
6562
+ * Quarter
6563
+ * Specify the quarter for which the analysis is requested.
6564
+ */
6565
+ quarter?: number;
6566
+ /**
6567
+ * Show All
6568
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
6569
+ */
6570
+ show_all?: boolean;
6571
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
6572
+ /**
6573
+ * @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.
6574
+ * @tags Fund Analysis
6575
+ * @name GetFundsParagraphs
6576
+ * @summary Get Funds Paragraphs
6577
+ * @request GET:/funds/{fund_id}/paragraphs
6578
+ * @secure
6579
+ */
6580
+ getFundsParagraphs(fundId: number, query?: {
6581
+ /**
6582
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6583
+ * @default "en-US"
6584
+ */
6585
+ language?: BridgeWiseLanguageEnum;
6586
+ /**
6587
+ * Year
6588
+ * Specify the year for which the analysis is requested.
6589
+ */
6590
+ year?: number | null;
6591
+ /**
6592
+ * Quarter
6593
+ * Specify the quarter for which the analysis is requested.
6594
+ */
6595
+ quarter?: number | null;
6596
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
6597
+ /**
6598
+ * @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.
6599
+ * @tags Fund Analysis
6600
+ * @name GetFundParameters
6601
+ * @summary Get Fund Parameters
6602
+ * @request GET:/funds/{fund_id}/parameters
6603
+ * @secure
6604
+ */
6605
+ getFundParameters(fundId: number, query?: {
6606
+ /**
6607
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6608
+ * @default "en-US"
6609
+ */
6610
+ language?: BridgeWiseLanguageEnum;
6611
+ /**
6612
+ * Parameter Id
6613
+ * ID of the parameter for analysis.
6614
+ */
6615
+ parameter_id?: number;
6616
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
6546
6617
  /**
6547
- * @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
6548
- * @tags Fund Metadata
6549
- * @name GetFund
6550
- * @summary Get Fund
6551
- * @request GET:/funds/{fund_id}
6618
+ * @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.
6619
+ * @tags Fund Analysis
6620
+ * @name GetFundSections
6621
+ * @summary Get Fund Sections
6622
+ * @request GET:/funds/{fund_id}/sections
6552
6623
  * @secure
6553
6624
  */
6554
- getFund(fundId: number, query?: {
6625
+ getFundSections(fundId: number, query?: {
6626
+ /**
6627
+ * Year
6628
+ * Specify the year for which the analysis is requested.
6629
+ */
6630
+ year?: number;
6631
+ /**
6632
+ * Quarter
6633
+ * Specify the quarter for which the analysis is requested.
6634
+ */
6635
+ quarter?: number;
6555
6636
  /**
6556
6637
  * Define the language code (e.g., `'en-US'` for English) for the textual data output.
6557
6638
  * @default "en-US"
6558
6639
  */
6559
6640
  language?: BridgeWiseLanguageEnum;
6560
6641
  /**
6561
- * Include
6562
- * Comma-separated list of additional resources to include in the response. Supported values: `holdings`, `holding_statistics`, `compositions`, `analysis`, `sections`, `esg_analysis`, `parameters`, `segments`, `segment_parameters`, `paragraphs`, `market`, `market_statistics`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `holdings__composition_type=stock` retrieves only stock holdings. Details about available filters can be found under the corresponding resource documentation.
6563
- * @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
6642
+ * Show All
6643
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
6564
6644
  */
6565
- include?: string;
6566
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
6645
+ show_all?: boolean;
6646
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
6567
6647
  }
6568
6648
  export class Segmentations<HandleError extends boolean = boolean> {
6569
6649
  protected readonly apiClient: JwtClient<HandleError>;
@@ -12374,6 +12454,75 @@ export class Companies<HandleError extends boolean = boolean> {
12374
12454
  */
12375
12455
  sanFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
12376
12456
  }
12457
+ export class FundMarketData<HandleError extends boolean = boolean> {
12458
+ protected readonly apiClient: JwtClient<HandleError>;
12459
+ constructor(apiClient: JwtClient<HandleError>);
12460
+ /**
12461
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
12462
+ * @tags Fund Market Data
12463
+ * @name GetFundsMarketData
12464
+ * @summary Get Funds Market Data
12465
+ * @request GET:/funds/{fund_id}/market
12466
+ * @secure
12467
+ */
12468
+ getFundsMarketData(fundId: number, query?: {
12469
+ /**
12470
+ * Trading Item Id
12471
+ * Specify a BW trading asset identifier for a targeted query.
12472
+ */
12473
+ trading_item_id?: number | null;
12474
+ /**
12475
+ * Date Ge
12476
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
12477
+ */
12478
+ date__ge?: string | null;
12479
+ /**
12480
+ * Date Le
12481
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
12482
+ */
12483
+ date__le?: string | null;
12484
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
12485
+ /**
12486
+ * @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.
12487
+ * @tags Fund Market Data
12488
+ * @name GetFundsMarketStatistics
12489
+ * @summary Get Funds Market Statistics
12490
+ * @request GET:/funds/{fund_id}/market-statistics
12491
+ * @secure
12492
+ */
12493
+ getFundsMarketStatistics(fundId: number, query?: {
12494
+ /**
12495
+ * Trading Item Id
12496
+ * Specify a BW trading asset identifier for a targeted query.
12497
+ */
12498
+ trading_item_id?: number | null;
12499
+ /**
12500
+ * Identifier In
12501
+ * Comma-separated list of identifiers
12502
+ */
12503
+ identifier__in?: string | null;
12504
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
12505
+ /**
12506
+ * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
12507
+ * @tags Fund Market Data
12508
+ * @name GetFundTradingItems
12509
+ * @summary Get Fund Trading Items
12510
+ * @request GET:/funds/{fund_id}/trading-items
12511
+ * @secure
12512
+ */
12513
+ getFundTradingItems(fundId: number, query?: {
12514
+ /**
12515
+ * Primary Flag
12516
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
12517
+ */
12518
+ primary_flag?: boolean;
12519
+ /**
12520
+ * Security Primary Flag
12521
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
12522
+ */
12523
+ security_primary_flag?: boolean;
12524
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
12525
+ }
12377
12526
  export class SectorAnalysis<HandleError extends boolean = boolean> {
12378
12527
  protected readonly apiClient: JwtClient<HandleError>;
12379
12528
  constructor(apiClient: JwtClient<HandleError>);
@@ -12408,63 +12557,6 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
12408
12557
  limit?: number;
12409
12558
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
12410
12559
  }
12411
- export class TenantIdentifiers<HandleError extends boolean = boolean> {
12412
- protected readonly apiClient: JwtClient<HandleError>;
12413
- constructor(apiClient: JwtClient<HandleError>);
12414
- /**
12415
- * @description Get list of tenant identifiers
12416
- * @tags Tenant Identifiers
12417
- * @name GetTenantIdentifiers
12418
- * @summary Get Tenant Identifiers
12419
- * @request GET:/tenants/{tenant_id}/identifiers
12420
- * @secure
12421
- */
12422
- getTenantIdentifiers(tenantId: string, query?: {
12423
- /** Tenant custom identifier status. */
12424
- status?: BridgeWiseTenantIdentifierStatusEnum;
12425
- /**
12426
- * Page
12427
- * Define the page number for the results.
12428
- * @default 1
12429
- * @example 1
12430
- */
12431
- page?: number;
12432
- /**
12433
- * Page Size
12434
- * Define the maximum number of results to retrieve.
12435
- * @default 20
12436
- * @example 10
12437
- */
12438
- page_size?: number;
12439
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
12440
- /**
12441
- * @description Create a new identifier for a tenant
12442
- * @tags Tenant Identifiers
12443
- * @name CreateTenantIdentifier
12444
- * @summary Create Tenant Identifier
12445
- * @request POST:/tenants/{tenant_id}/identifiers
12446
- * @secure
12447
- */
12448
- createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
12449
- /**
12450
- * @description Update an existing identifier for a tenant
12451
- * @tags Tenant Identifiers
12452
- * @name UpdateTenantIdentifier
12453
- * @summary Update Tenant Identifier
12454
- * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
12455
- * @secure
12456
- */
12457
- updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
12458
- /**
12459
- * @description Delete identifier for a tenant
12460
- * @tags Tenant Identifiers
12461
- * @name DeleteTenantIdentifier
12462
- * @summary Delete Tenant Identifier
12463
- * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
12464
- * @secure
12465
- */
12466
- deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
12467
- }
12468
12560
  export class Tenants<HandleError extends boolean = boolean> {
12469
12561
  protected readonly apiClient: JwtClient<HandleError>;
12470
12562
  constructor(apiClient: JwtClient<HandleError>);
@@ -12612,232 +12704,88 @@ export class Tenants<HandleError extends boolean = boolean> {
12612
12704
  * @request POST:/tenants/{tenant_id}/recommendations-config/bulk
12613
12705
  * @secure
12614
12706
  */
12615
- createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
12616
- /**
12617
- * @tags Tenants
12618
- * @name GetTenantRecommendationsConfig
12619
- * @summary Get Tenant Recommendations Config
12620
- * @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
12621
- * @secure
12622
- */
12623
- getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
12624
- /**
12625
- * @tags Tenants
12626
- * @name PatchTenantRecommendationsConfig
12627
- * @summary Patch Tenant Recommendations Config
12628
- * @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
12629
- * @secure
12630
- */
12631
- patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
12632
- /**
12633
- * @tags Tenants
12634
- * @name DeleteTenantRecommendationsConfig
12635
- * @summary Delete Tenant Recommendations Config
12636
- * @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
12637
- * @secure
12638
- */
12639
- deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
12640
- }
12641
- export class Users<HandleError extends boolean = boolean> {
12642
- protected readonly apiClient: JwtClient<HandleError>;
12643
- constructor(apiClient: JwtClient<HandleError>);
12644
- /**
12645
- * @tags Users
12646
- * @name Authenticate
12647
- * @summary Authenticate
12648
- * @request POST:/users/authenticate
12649
- * @secure
12650
- */
12651
- authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
12652
- /**
12653
- * @tags Users
12654
- * @name FetchClientDetails
12655
- * @summary Fetch Client Details
12656
- * @request GET:/users/machine
12657
- * @secure
12658
- */
12659
- fetchClientDetails(headers: {
12660
- /** Authorization */
12661
- authorization: string;
12662
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
12663
- }
12664
- export class FundAnalysis<HandleError extends boolean = boolean> {
12665
- protected readonly apiClient: JwtClient<HandleError>;
12666
- constructor(apiClient: JwtClient<HandleError>);
12667
- /**
12668
- * @description Returns Bridgewise final analysis for a specified fund.
12669
- * @tags Fund Analysis
12670
- * @name GetFundAnalysis
12671
- * @summary Get Fund Analysis
12672
- * @request GET:/funds/{fund_id}/analysis
12673
- * @secure
12674
- */
12675
- getFundAnalysis(fundId: number, query?: {
12676
- /**
12677
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12678
- * @default "en-US"
12679
- */
12680
- language?: BridgeWiseLanguageEnum;
12681
- /**
12682
- * Year
12683
- * Specify the year for which the analysis is requested.
12684
- */
12685
- year?: number;
12686
- /**
12687
- * Quarter
12688
- * Specify the quarter for which the analysis is requested.
12689
- */
12690
- quarter?: number;
12691
- /**
12692
- * Show All
12693
- * Boolean flag. Indicate whether to return historical data (`true/false`).
12694
- */
12695
- show_all?: boolean;
12696
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
12697
- /**
12698
- * @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.
12699
- * @tags Fund Analysis
12700
- * @name GetFundsParagraphs
12701
- * @summary Get Funds Paragraphs
12702
- * @request GET:/funds/{fund_id}/paragraphs
12703
- * @secure
12704
- */
12705
- getFundsParagraphs(fundId: number, query?: {
12706
- /**
12707
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12708
- * @default "en-US"
12709
- */
12710
- language?: BridgeWiseLanguageEnum;
12711
- /**
12712
- * Year
12713
- * Specify the year for which the analysis is requested.
12714
- */
12715
- year?: number | null;
12716
- /**
12717
- * Quarter
12718
- * Specify the quarter for which the analysis is requested.
12719
- */
12720
- quarter?: number | null;
12721
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
12707
+ createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
12722
12708
  /**
12723
- * @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.
12724
- * @tags Fund Analysis
12725
- * @name GetFundParameters
12726
- * @summary Get Fund Parameters
12727
- * @request GET:/funds/{fund_id}/parameters
12709
+ * @tags Tenants
12710
+ * @name GetTenantRecommendationsConfig
12711
+ * @summary Get Tenant Recommendations Config
12712
+ * @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
12728
12713
  * @secure
12729
12714
  */
12730
- getFundParameters(fundId: number, query?: {
12731
- /**
12732
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12733
- * @default "en-US"
12734
- */
12735
- language?: BridgeWiseLanguageEnum;
12736
- /**
12737
- * Parameter Id
12738
- * ID of the parameter for analysis.
12739
- */
12740
- parameter_id?: number;
12741
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
12715
+ getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
12742
12716
  /**
12743
- * @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.
12744
- * @tags Fund Analysis
12745
- * @name GetFundSections
12746
- * @summary Get Fund Sections
12747
- * @request GET:/funds/{fund_id}/sections
12717
+ * @tags Tenants
12718
+ * @name PatchTenantRecommendationsConfig
12719
+ * @summary Patch Tenant Recommendations Config
12720
+ * @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
12748
12721
  * @secure
12749
12722
  */
12750
- getFundSections(fundId: number, query?: {
12751
- /**
12752
- * Year
12753
- * Specify the year for which the analysis is requested.
12754
- */
12755
- year?: number;
12756
- /**
12757
- * Quarter
12758
- * Specify the quarter for which the analysis is requested.
12759
- */
12760
- quarter?: number;
12761
- /**
12762
- * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12763
- * @default "en-US"
12764
- */
12765
- language?: BridgeWiseLanguageEnum;
12766
- /**
12767
- * Show All
12768
- * Boolean flag. Indicate whether to return historical data (`true/false`).
12769
- */
12770
- show_all?: boolean;
12771
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
12723
+ patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
12724
+ /**
12725
+ * @tags Tenants
12726
+ * @name DeleteTenantRecommendationsConfig
12727
+ * @summary Delete Tenant Recommendations Config
12728
+ * @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
12729
+ * @secure
12730
+ */
12731
+ deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
12772
12732
  }
12773
- export class FundMarketData<HandleError extends boolean = boolean> {
12733
+ export class TenantIdentifiers<HandleError extends boolean = boolean> {
12774
12734
  protected readonly apiClient: JwtClient<HandleError>;
12775
12735
  constructor(apiClient: JwtClient<HandleError>);
12776
12736
  /**
12777
- * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
12778
- * @tags Fund Market Data
12779
- * @name GetFundsMarketData
12780
- * @summary Get Funds Market Data
12781
- * @request GET:/funds/{fund_id}/market
12737
+ * @description Get list of tenant identifiers
12738
+ * @tags Tenant Identifiers
12739
+ * @name GetTenantIdentifiers
12740
+ * @summary Get Tenant Identifiers
12741
+ * @request GET:/tenants/{tenant_id}/identifiers
12782
12742
  * @secure
12783
12743
  */
12784
- getFundsMarketData(fundId: number, query?: {
12785
- /**
12786
- * Trading Item Id
12787
- * Specify a BW trading asset identifier for a targeted query.
12788
- */
12789
- trading_item_id?: number | null;
12744
+ getTenantIdentifiers(tenantId: string, query?: {
12745
+ /** Tenant custom identifier status. */
12746
+ status?: BridgeWiseTenantIdentifierStatusEnum;
12790
12747
  /**
12791
- * Date Ge
12792
- * Specify the minimum date for data retrieval in YYYY-MM-DD format.
12748
+ * Page
12749
+ * Define the page number for the results.
12750
+ * @default 1
12751
+ * @example 1
12793
12752
  */
12794
- date__ge?: string | null;
12753
+ page?: number;
12795
12754
  /**
12796
- * Date Le
12797
- * Specify the maximum date for data retrieval in YYYY-MM-DD format.
12755
+ * Page Size
12756
+ * Define the maximum number of results to retrieve.
12757
+ * @default 20
12758
+ * @example 10
12798
12759
  */
12799
- date__le?: string | null;
12800
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
12760
+ page_size?: number;
12761
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
12801
12762
  /**
12802
- * @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.
12803
- * @tags Fund Market Data
12804
- * @name GetFundsMarketStatistics
12805
- * @summary Get Funds Market Statistics
12806
- * @request GET:/funds/{fund_id}/market-statistics
12763
+ * @description Create a new identifier for a tenant
12764
+ * @tags Tenant Identifiers
12765
+ * @name CreateTenantIdentifier
12766
+ * @summary Create Tenant Identifier
12767
+ * @request POST:/tenants/{tenant_id}/identifiers
12807
12768
  * @secure
12808
12769
  */
12809
- getFundsMarketStatistics(fundId: number, query?: {
12810
- /**
12811
- * Trading Item Id
12812
- * Specify a BW trading asset identifier for a targeted query.
12813
- */
12814
- trading_item_id?: number | null;
12815
- /**
12816
- * Identifier In
12817
- * Comma-separated list of identifiers
12818
- */
12819
- identifier__in?: string | null;
12820
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
12770
+ createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
12821
12771
  /**
12822
- * @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
12823
- * @tags Fund Market Data
12824
- * @name GetFundTradingItems
12825
- * @summary Get Fund Trading Items
12826
- * @request GET:/funds/{fund_id}/trading-items
12772
+ * @description Update an existing identifier for a tenant
12773
+ * @tags Tenant Identifiers
12774
+ * @name UpdateTenantIdentifier
12775
+ * @summary Update Tenant Identifier
12776
+ * @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
12827
12777
  * @secure
12828
12778
  */
12829
- getFundTradingItems(fundId: number, query?: {
12830
- /**
12831
- * Primary Flag
12832
- * Boolean flag. Indicate if only primary trading item data is required (true/false).
12833
- */
12834
- primary_flag?: boolean;
12835
- /**
12836
- * Security Primary Flag
12837
- * Boolean flag. Indicate if only primary asset data is required (true/false).
12838
- */
12839
- security_primary_flag?: boolean;
12840
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
12779
+ updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
12780
+ /**
12781
+ * @description Delete identifier for a tenant
12782
+ * @tags Tenant Identifiers
12783
+ * @name DeleteTenantIdentifier
12784
+ * @summary Delete Tenant Identifier
12785
+ * @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
12786
+ * @secure
12787
+ */
12788
+ deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
12841
12789
  }
12842
12790
  export class Themes<HandleError extends boolean = boolean> {
12843
12791
  protected readonly apiClient: JwtClient<HandleError>;
@@ -12954,6 +12902,88 @@ export class FundEsgAnalysis<HandleError extends boolean = boolean> {
12954
12902
  language?: BridgeWiseLanguageEnum;
12955
12903
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
12956
12904
  }
12905
+ export class Users<HandleError extends boolean = boolean> {
12906
+ protected readonly apiClient: JwtClient<HandleError>;
12907
+ constructor(apiClient: JwtClient<HandleError>);
12908
+ /**
12909
+ * @tags Users
12910
+ * @name Authenticate
12911
+ * @summary Authenticate
12912
+ * @request POST:/users/authenticate
12913
+ * @secure
12914
+ */
12915
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
12916
+ /**
12917
+ * @tags Users
12918
+ * @name FetchClientDetails
12919
+ * @summary Fetch Client Details
12920
+ * @request GET:/users/machine
12921
+ * @secure
12922
+ */
12923
+ fetchClientDetails(headers: {
12924
+ /** Authorization */
12925
+ authorization: string;
12926
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
12927
+ }
12928
+ export class Holdings<HandleError extends boolean = boolean> {
12929
+ protected readonly apiClient: JwtClient<HandleError>;
12930
+ constructor(apiClient: JwtClient<HandleError>);
12931
+ /**
12932
+ * @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.
12933
+ * @tags Holdings
12934
+ * @name GetCompositions
12935
+ * @summary Get Compositions
12936
+ * @request GET:/funds/{fund_id}/compositions
12937
+ * @secure
12938
+ */
12939
+ getCompositions(fundId: number, query?: {
12940
+ /**
12941
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12942
+ * @default "en-US"
12943
+ */
12944
+ language?: BridgeWiseLanguageEnum;
12945
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
12946
+ /**
12947
+ * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
12948
+ * @tags Holdings
12949
+ * @name GetHoldingStatistics
12950
+ * @summary Get Holding Statistics
12951
+ * @request GET:/funds/{fund_id}/holding-statistics
12952
+ * @secure
12953
+ */
12954
+ getHoldingStatistics(fundId: number, query?: {
12955
+ /**
12956
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12957
+ * @default "en-US"
12958
+ */
12959
+ language?: BridgeWiseLanguageEnum;
12960
+ /**
12961
+ * Composition Type
12962
+ * Composition type for fund holding statistics
12963
+ */
12964
+ composition_type?: string;
12965
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
12966
+ /**
12967
+ * @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.
12968
+ * @tags Holdings
12969
+ * @name GetHoldings
12970
+ * @summary Get Holdings
12971
+ * @request GET:/funds/{fund_id}/holdings
12972
+ * @secure
12973
+ */
12974
+ getHoldings(fundId: number, query?: {
12975
+ /**
12976
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
12977
+ * @default "en-US"
12978
+ */
12979
+ language?: BridgeWiseLanguageEnum;
12980
+ /**
12981
+ * Composition Type
12982
+ * Composition type for fund holdings
12983
+ */
12984
+ composition_type?: string;
12985
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
12986
+ }
12957
12987
  export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
12958
12988
  readonly config: JwtClientConfig<HandleError>;
12959
12989
  activities: Activities<HandleError>;