@orbis-systems/orbis-api-clients 0.6.1 → 0.6.3

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.
@@ -0,0 +1,4166 @@
1
+ import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
2
+ interface BaseClientConfig<HandleError extends boolean = boolean> {
3
+ debug?: boolean;
4
+ baseUrl: string;
5
+ handleError?: HandleError;
6
+ storage?: Storage;
7
+ defaultHeaders?: Record<string, string>;
8
+ defaultSecure?: boolean;
9
+ authDataStorageKey?: string;
10
+ withCredentials?: boolean;
11
+ onAxiosError?: (error: AxiosError) => void;
12
+ onError?: (error: unknown) => void;
13
+ }
14
+ enum ContentType {
15
+ Json = "application/json",
16
+ FormData = "multipart/form-data",
17
+ UrlEncoded = "application/x-www-form-urlencoded",
18
+ Text = "text/plain"
19
+ }
20
+ type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
21
+ secure?: boolean;
22
+ contentType?: ContentType;
23
+ handleError?: boolean;
24
+ };
25
+ type ResponseStatus = {
26
+ status: HttpStatusCode | -1;
27
+ statusText: string;
28
+ };
29
+ type SuccessClientResponse<Data = unknown> = ResponseStatus & {
30
+ success: true;
31
+ data: Data;
32
+ };
33
+ type ErrorClientResponse = ResponseStatus & {
34
+ success: false;
35
+ data?: any;
36
+ error: unknown;
37
+ };
38
+ type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
39
+ declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
40
+ protected readonly config: BaseClientConfig<HandleError>;
41
+ protected readonly axiosInstance: AxiosInstance;
42
+ protected readonly storage: Storage;
43
+ constructor(config: BaseClientConfig<HandleError>);
44
+ protected stringifyFormItem(formItem: unknown): string;
45
+ protected createFormData(input: Record<string, unknown>): FormData;
46
+ request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
47
+ get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
48
+ delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
49
+ head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
50
+ options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
51
+ post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
52
+ put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
53
+ patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
54
+ getAxios(): AxiosInstance;
55
+ setAuthData(data: AuthData | null): void;
56
+ getAuthData(): AuthData | null;
57
+ getConfig(): BaseClientConfig<HandleError>;
58
+ protected abstract prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
59
+ }
60
+ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
61
+ protected readonly apiClient: ApiClient;
62
+ constructor(apiClient: ApiClient);
63
+ getApiClient(): ApiClient;
64
+ }
65
+ interface JwtClientConfig<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError> {
66
+ authSchema?: string;
67
+ autoRenewToken?: boolean;
68
+ onRenewToken?: () => Promise<AuthData>;
69
+ }
70
+ interface JwtAuthData {
71
+ accessToken: string;
72
+ refreshToken?: string;
73
+ }
74
+ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, AuthData> {
75
+ protected readonly config: JwtClientConfig<HandleError, AuthData>;
76
+ constructor(config: JwtClientConfig<HandleError, AuthData>);
77
+ getConfig(): JwtClientConfig<HandleError>;
78
+ setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
79
+ protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
80
+ }
81
+ /** BadRequest */
82
+ export interface BridgeWiseBadRequest {
83
+ /** Detail */
84
+ detail: BridgeWiseDetailItem[];
85
+ }
86
+ /** CompanyAlert */
87
+ export interface BridgeWiseCompanyAlert {
88
+ /** Company Id */
89
+ company_id: number;
90
+ /** Company Name */
91
+ company_name: string;
92
+ /** Enum representing company alert type. */
93
+ type: BridgeWiseCompanyAlertType;
94
+ /** Headline */
95
+ headline: string;
96
+ /** Situation */
97
+ situation: string;
98
+ /** Importance */
99
+ importance: number;
100
+ /** Enum representing company alert sentiment. */
101
+ sentiment: BridgeWiseCompanyAlertSentiment;
102
+ /** Date */
103
+ date: string;
104
+ }
105
+ /**
106
+ * CompanyAlertSentiment
107
+ * Enum representing company alert sentiment.
108
+ */
109
+ export enum BridgeWiseCompanyAlertSentiment {
110
+ Positive = "positive",
111
+ Negative = "negative"
112
+ }
113
+ /**
114
+ * CompanyAlertType
115
+ * Enum representing company alert type.
116
+ */
117
+ export enum BridgeWiseCompanyAlertType {
118
+ Fundamental = "fundamental",
119
+ Market = "market"
120
+ }
121
+ /** DetailItem */
122
+ export interface BridgeWiseDetailItem {
123
+ /**
124
+ * Loc
125
+ * @default ["",0]
126
+ */
127
+ loc?: (string | number)[];
128
+ /** Msg */
129
+ msg: string;
130
+ /**
131
+ * Type
132
+ * @default ""
133
+ */
134
+ type?: string;
135
+ /**
136
+ * Input
137
+ * @default ""
138
+ */
139
+ input?: string;
140
+ /**
141
+ * Url
142
+ * @default ""
143
+ */
144
+ url?: string;
145
+ }
146
+ /**
147
+ * ESGForcastV2
148
+ * Model for ESG warning data.
149
+ */
150
+ export interface BridgeWiseESGForcastV2 {
151
+ /**
152
+ * Language
153
+ * @default "en-US"
154
+ */
155
+ language?: string;
156
+ /**
157
+ * Updated At
158
+ * @format date
159
+ */
160
+ updated_at: string;
161
+ /**
162
+ * Analysis Type
163
+ * @default "esg"
164
+ */
165
+ analysis_type?: string;
166
+ /** Year */
167
+ year: number;
168
+ /** Parameter Name */
169
+ parameter_name: string | number;
170
+ /** Parameter Id */
171
+ parameter_id: number;
172
+ /** Section Type */
173
+ section_type: string;
174
+ /**
175
+ * Forecast Type
176
+ * @default "msa"
177
+ */
178
+ forecast_type?: string;
179
+ /** Priority */
180
+ priority: number;
181
+ /** Event Type Id */
182
+ event_type_id: string;
183
+ /** Title */
184
+ title: string;
185
+ /** Text */
186
+ text: string | null;
187
+ }
188
+ /**
189
+ * EmptyModelList
190
+ * @default []
191
+ */
192
+ export type BridgeWiseEmptyModelList = any[];
193
+ /** Forecast */
194
+ export interface BridgeWiseForecast {
195
+ /** Company Id */
196
+ company_id: number;
197
+ /**
198
+ * Language
199
+ * @default "en-US"
200
+ */
201
+ language?: string;
202
+ /** Updated At */
203
+ updated_at: string;
204
+ /**
205
+ * Forecast Type
206
+ * @default "key_developments"
207
+ */
208
+ forecast_type?: string;
209
+ /** Type */
210
+ type?: string | null;
211
+ /** Headline */
212
+ headline?: string | null;
213
+ /** Body */
214
+ body?: string | null;
215
+ /** Date */
216
+ date: string;
217
+ /** Sentiment */
218
+ sentiment: string;
219
+ /** Importance */
220
+ importance: number;
221
+ /** Situation */
222
+ situation: string;
223
+ /** Category Name */
224
+ category_name: string | null;
225
+ /** Role Type */
226
+ role_type: string | null;
227
+ /** Announced Date */
228
+ announced_date: string | null;
229
+ /** Entered Date */
230
+ entered_date: string | null;
231
+ /** Last Modified Date */
232
+ last_modified_date: string | null;
233
+ }
234
+ /** ForecastList */
235
+ export interface BridgeWiseForecastList {
236
+ /** Root */
237
+ root: BridgeWiseForecast[];
238
+ }
239
+ /** ForecastType */
240
+ export enum BridgeWiseForecastType {
241
+ Esg = "esg",
242
+ KeyDevelopments = "key_developments",
243
+ News = "news"
244
+ }
245
+ /** HTTPValidationError */
246
+ export interface BridgeWiseHTTPValidationError {
247
+ /** Detail */
248
+ detail?: BridgeWiseValidationError[];
249
+ }
250
+ /** LanguageEnum */
251
+ export enum BridgeWiseLanguageEnum {
252
+ ArSA = "ar-SA",
253
+ DeDE = "de-DE",
254
+ EnUS = "en-US",
255
+ EsES = "es-ES",
256
+ FrFR = "fr-FR",
257
+ HeIL = "he-IL",
258
+ NlNL = "nl-NL",
259
+ PtBR = "pt-BR",
260
+ TrTR = "tr-TR",
261
+ ZhCN = "zh-CN",
262
+ JaJP = "ja-JP",
263
+ KoKR = "ko-KR",
264
+ ThTH = "th-TH",
265
+ ZhHK = "zh-HK"
266
+ }
267
+ /** MSAForecastV2 */
268
+ export interface BridgeWiseMSAForecastV2 {
269
+ /**
270
+ * Language
271
+ * @default "en-US"
272
+ */
273
+ language?: string;
274
+ /** Updated At */
275
+ updated_at: string;
276
+ /** Company Id */
277
+ company_id: number;
278
+ /** Year */
279
+ year: number;
280
+ /** Associated Section Id */
281
+ associated_section_id: number;
282
+ /** Associated Section Name */
283
+ associated_section_name: string;
284
+ /** Importance Level */
285
+ importance_level: number;
286
+ /** Associated Parameter Id */
287
+ associated_parameter_id: number;
288
+ /** Associated Parameter Name */
289
+ associated_parameter_name: string | number;
290
+ /** Headline */
291
+ headline: string;
292
+ /** Body */
293
+ body: string | null;
294
+ }
295
+ /** NotFound */
296
+ export interface BridgeWiseNotFound {
297
+ /**
298
+ * Message
299
+ * @default "Not Found"
300
+ */
301
+ message?: string;
302
+ }
303
+ /** ValidationError */
304
+ export interface BridgeWiseValidationError {
305
+ /** Location */
306
+ loc: (string | number)[];
307
+ /** Message */
308
+ msg: string;
309
+ /** Error Type */
310
+ type: string;
311
+ }
312
+ /** MarketDataList */
313
+ export type BridgeWiseMarketDataList = BridgeWisepreparationSdkModelsMarketData[];
314
+ /** MarketList */
315
+ export type BridgeWiseMarketList = BridgeWisepreparationSdkFundModelsMarketData[];
316
+ /** MarketStatisticDataList */
317
+ export type BridgeWiseMarketStatisticDataList = BridgeWisepreparationSdkFundModelsMarketStatisticsData[];
318
+ /** MarketStatisticsDataList */
319
+ export type BridgeWiseMarketStatisticsDataList = BridgeWisepreparationSdkModelsMarketStatisticsData[];
320
+ /** MarketData */
321
+ export interface BridgeWisepreparationSdkFundModelsMarketData {
322
+ /** Trading Item Id */
323
+ trading_item_id: number;
324
+ /** Updated At */
325
+ updated_at: string;
326
+ /**
327
+ * Date
328
+ * @format date-time
329
+ */
330
+ date: string;
331
+ /** Open Price */
332
+ open_price: number | null;
333
+ /** Close Price */
334
+ close_price: number;
335
+ /** High Price */
336
+ high_price: number | null;
337
+ /** Low Price */
338
+ low_price: number | null;
339
+ /** Volume */
340
+ volume: number | null;
341
+ /** Shares Outstanding */
342
+ shares_outstanding: number | null;
343
+ /** Price Currency Iso3 */
344
+ price_currency_iso3: string;
345
+ /** Exchange Rate To Usd */
346
+ exchange_rate_to_usd: number;
347
+ /** Daily Return */
348
+ daily_return: number | null;
349
+ /** Market Cap */
350
+ market_cap: number | null;
351
+ }
352
+ /** MarketStatisticsData */
353
+ export interface BridgeWisepreparationSdkFundModelsMarketStatisticsData {
354
+ /** Company Id */
355
+ company_id: number;
356
+ /** Trading Item Id */
357
+ trading_item_id: number;
358
+ /** 1D */
359
+ '1D': number | null;
360
+ /** 5D */
361
+ '5D': number | null;
362
+ /** 1M */
363
+ '1M': number | null;
364
+ /** 6M */
365
+ '6M': number | null;
366
+ /** 1Y */
367
+ '1Y': number | null;
368
+ /** 2Y */
369
+ '2Y': number | null;
370
+ /** 5Y */
371
+ '5Y': number | null;
372
+ /** Ytd */
373
+ YTD: number | null;
374
+ }
375
+ /** MarketData */
376
+ export interface BridgeWisepreparationSdkModelsMarketData {
377
+ /** Trading Item Id */
378
+ trading_item_id: number | null;
379
+ /** Updated At */
380
+ updated_at: string | null;
381
+ /** Date */
382
+ date: string | null;
383
+ /** Open Price */
384
+ open_price: number | null;
385
+ /** Close Price */
386
+ close_price: number | null;
387
+ /** High Price */
388
+ high_price: number | null;
389
+ /** Low Price */
390
+ low_price: number | null;
391
+ /** Volume */
392
+ volume: number | null;
393
+ /** Market Cap */
394
+ market_cap: number | null;
395
+ /** Implied Market Cap */
396
+ implied_market_cap: number | null;
397
+ /** Market Cap Currency Iso3 */
398
+ market_cap_currency_iso3: string | null;
399
+ /** Price Currency Iso3 */
400
+ price_currency_iso3: string | null;
401
+ /** Exchange Rate To Usd */
402
+ exchange_rate_to_usd: number | null;
403
+ /** Daily Return */
404
+ daily_return?: number | null;
405
+ /** Market Cap Exchange Rate To Usd */
406
+ market_cap_exchange_rate_to_usd?: number | null;
407
+ /** Market Cap Usd */
408
+ market_cap_usd?: number | null;
409
+ /** Filing Date */
410
+ filing_date?: string | null;
411
+ /** Change Since Filing */
412
+ change_since_filing?: number | null;
413
+ }
414
+ /** MarketStatisticsData */
415
+ export interface BridgeWisepreparationSdkModelsMarketStatisticsData {
416
+ /** Company Id */
417
+ company_id: number | null;
418
+ /** Trading Item Id */
419
+ trading_item_id: number | null;
420
+ /** 1D */
421
+ '1D': number | null;
422
+ /** 5D */
423
+ '5D': number | null;
424
+ /** 1M */
425
+ '1M': number | null;
426
+ /** 6M */
427
+ '6M': number | null;
428
+ /** 1Y */
429
+ '1Y': number | null;
430
+ /** 2Y */
431
+ '2Y': number | null;
432
+ /** 5Y */
433
+ '5Y': number | null;
434
+ /** Ytd */
435
+ YTD: number | null;
436
+ }
437
+ /** CompaniesResponse */
438
+ export interface BridgeWiseCompaniesResponse {
439
+ /** Data */
440
+ data: BridgeWiseCompanyData[];
441
+ /** Total Count */
442
+ total_count: number;
443
+ }
444
+ /** CompanyData */
445
+ export interface BridgeWiseCompanyData {
446
+ /** Language */
447
+ language?: string;
448
+ /** Updated At */
449
+ updated_at?: string | null;
450
+ /** Company Id */
451
+ company_id?: number;
452
+ /** Company Name */
453
+ company_name?: string | null;
454
+ /** Company Name Short */
455
+ company_name_short?: string | null;
456
+ /** Website */
457
+ website?: string | null;
458
+ /** Primary Ticker Symbol */
459
+ primary_ticker_symbol?: string | null;
460
+ /** Primary Exchange Symbol */
461
+ primary_exchange_symbol?: string | null;
462
+ /** Region Id */
463
+ region_id?: number | null;
464
+ /** Region Name */
465
+ region_name?: string | null;
466
+ /** Incorporation Country Id */
467
+ incorporation_country_id?: number | null;
468
+ /** Incorporation Country Name */
469
+ incorporation_country_name?: string | null;
470
+ /** Domicile Country Id */
471
+ domicile_country_id?: number | null;
472
+ /** Domicile Country Name */
473
+ domicile_country_name?: string | null;
474
+ /** Gics Sector Id */
475
+ gics_sector_id?: number | null;
476
+ /** Gics Sector Name */
477
+ gics_sector_name?: string | null;
478
+ /** Gics Industry Group Id */
479
+ gics_industry_group_id?: number | null;
480
+ /** Gics Industry Group Name */
481
+ gics_industry_group_name?: string | null;
482
+ /** Gics Industry Id */
483
+ gics_industry_id?: number | null;
484
+ /** Gics Industry Name */
485
+ gics_industry_name?: string | null;
486
+ /** Csa Industry Id */
487
+ csa_industry_id?: number | null;
488
+ /** Csa Industry Name */
489
+ csa_industry_name?: string | null;
490
+ /** Primary Currency Market Id */
491
+ primary_currency_market_id?: number | null;
492
+ /** Primary Currency Market */
493
+ primary_currency_market?: string | null;
494
+ /** Primary Currency Financials Iso3 */
495
+ primary_currency_financials_iso3?: string | null;
496
+ /** Primary Security Id */
497
+ primary_security_id?: number | null;
498
+ /** Primary Security Name */
499
+ primary_security_name?: string | null;
500
+ /** Ipo Date */
501
+ ipo_date?: string | null;
502
+ /** Is Red Flagged */
503
+ is_red_flagged?: boolean | null;
504
+ }
505
+ /** CompanyFilterResponse */
506
+ export interface BridgeWiseCompanyFilterResponse {
507
+ /** Type */
508
+ type: string;
509
+ /** Value */
510
+ value: string;
511
+ /** Id */
512
+ id: number;
513
+ /** Language */
514
+ language: string;
515
+ }
516
+ /** CompanyFilterType */
517
+ export enum BridgeWiseCompanyFilterType {
518
+ Countries = "countries",
519
+ GicsIndustry = "gics_industry",
520
+ GicsSector = "gics_sector",
521
+ Regions = "regions",
522
+ GicsGroup = "gics_group",
523
+ Currency = "currency",
524
+ Exchange = "exchange",
525
+ CsaIndustry = "csa_industry",
526
+ Benchmark = "benchmark",
527
+ Sponsor = "sponsor",
528
+ Sector = "sector",
529
+ ManagementStyle = "management_style",
530
+ Recommendation = "recommendation",
531
+ MarketCapEmphasis = "market_cap_emphasis",
532
+ Exposure = "exposure",
533
+ GeographyEmphasis = "geography_emphasis",
534
+ MarketBenchmark = "market_benchmark",
535
+ PrimaryBenchmark = "primary_benchmark"
536
+ }
537
+ /** CompanyResponse */
538
+ export interface BridgeWiseCompanyResponse {
539
+ /** Language */
540
+ language?: string;
541
+ /** Updated At */
542
+ updated_at?: string | null;
543
+ /** Company Id */
544
+ company_id?: number;
545
+ /** Company Name */
546
+ company_name?: string | null;
547
+ /** Company Name Short */
548
+ company_name_short?: string | null;
549
+ /** Website */
550
+ website?: string | null;
551
+ /** Primary Ticker Symbol */
552
+ primary_ticker_symbol?: string | null;
553
+ /** Primary Exchange Symbol */
554
+ primary_exchange_symbol?: string | null;
555
+ /** Region Id */
556
+ region_id?: number | null;
557
+ /** Region Name */
558
+ region_name?: string | null;
559
+ /** Incorporation Country Id */
560
+ incorporation_country_id?: number | null;
561
+ /** Incorporation Country Name */
562
+ incorporation_country_name?: string | null;
563
+ /** Domicile Country Id */
564
+ domicile_country_id?: number | null;
565
+ /** Domicile Country Name */
566
+ domicile_country_name?: string | null;
567
+ /** Gics Sector Id */
568
+ gics_sector_id?: number | null;
569
+ /** Gics Sector Name */
570
+ gics_sector_name?: string | null;
571
+ /** Gics Industry Group Id */
572
+ gics_industry_group_id?: number | null;
573
+ /** Gics Industry Group Name */
574
+ gics_industry_group_name?: string | null;
575
+ /** Gics Industry Id */
576
+ gics_industry_id?: number | null;
577
+ /** Gics Industry Name */
578
+ gics_industry_name?: string | null;
579
+ /** Csa Industry Id */
580
+ csa_industry_id?: number | null;
581
+ /** Csa Industry Name */
582
+ csa_industry_name?: string | null;
583
+ /** Primary Currency Market Id */
584
+ primary_currency_market_id?: number | null;
585
+ /** Primary Currency Market */
586
+ primary_currency_market?: string | null;
587
+ /** Primary Currency Financials Iso3 */
588
+ primary_currency_financials_iso3?: string | null;
589
+ /** Primary Security Id */
590
+ primary_security_id?: number | null;
591
+ /** Primary Security Name */
592
+ primary_security_name?: string | null;
593
+ /** Ipo Date */
594
+ ipo_date?: string | null;
595
+ /** Is Red Flagged */
596
+ is_red_flagged?: boolean | null;
597
+ /**
598
+ * Include
599
+ * @default []
600
+ */
601
+ include?: object[];
602
+ }
603
+ /** CompositionTypeEnum */
604
+ export enum BridgeWiseCompositionTypeEnum {
605
+ Stocks = "stocks",
606
+ Others = "others"
607
+ }
608
+ /** FundHoldingsList */
609
+ export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
610
+ /** FundsCompositionItem */
611
+ export interface BridgeWiseFundsCompositionItem {
612
+ /** Updated At */
613
+ updated_at: string;
614
+ /** Composition Type */
615
+ composition_type: string;
616
+ /** Weight */
617
+ weight: number;
618
+ /** Is Direct Holding */
619
+ is_direct_holding: boolean;
620
+ /** Disclaimer */
621
+ disclaimer: string | null;
622
+ }
623
+ /** FundsCompositionList */
624
+ export type BridgeWiseFundsCompositionList = BridgeWiseFundsCompositionItem[];
625
+ /** FundsResponse */
626
+ export interface BridgeWiseFundsResponse {
627
+ /** Data */
628
+ data: BridgeWiseMetadata[];
629
+ /** Total Count */
630
+ total_count: number;
631
+ }
632
+ /** HoldingItem */
633
+ export interface BridgeWiseHoldingItem {
634
+ /**
635
+ * Language
636
+ * @default "en-US"
637
+ */
638
+ language?: string;
639
+ /** Company Id */
640
+ company_id: number;
641
+ /** Company Name */
642
+ company_name: string;
643
+ /** Composition Type */
644
+ composition_type: string;
645
+ /** Composition Type Name */
646
+ composition_type_name: string;
647
+ /** Weight */
648
+ weight: number | null;
649
+ /** Sector */
650
+ sector: string;
651
+ /** Industry */
652
+ industry: string;
653
+ /** Region */
654
+ region: string;
655
+ /** Country */
656
+ country: string;
657
+ /** Market Cap Usd */
658
+ market_cap_usd: number | null;
659
+ /** Return 1Y */
660
+ return_1y: number | null;
661
+ /** Financial Currency Iso 3 */
662
+ financial_currency_iso_3: string | null;
663
+ /** Pb Ratio */
664
+ pb_ratio: number | null;
665
+ /** Pe Ratio */
666
+ pe_ratio: number | null;
667
+ /** Ps Ratio */
668
+ ps_ratio: number | null;
669
+ /** Net Debt Divided By Ebitda */
670
+ net_debt_divided_by_ebitda: number | null;
671
+ /** Return On Equity Percent */
672
+ return_on_equity_percent: number | null;
673
+ /** Revenue Growth */
674
+ revenue_growth: number | null;
675
+ /** Dividend Yield */
676
+ dividend_yield: number | null;
677
+ /** Primary Ticker Symbol */
678
+ primary_ticker_symbol: string | null;
679
+ /** Primary Exchange Symbol */
680
+ primary_exchange_symbol: string | null;
681
+ /** Fund Analysis Score Group */
682
+ fund_analysis_score_group: number | null;
683
+ /** Fund Analysis Score Group Text */
684
+ fund_analysis_score_group_text: number | string | null;
685
+ /** Analysis Score */
686
+ analysis_score: number | null;
687
+ }
688
+ /** HoldingsStatisticsItem */
689
+ export interface BridgeWiseHoldingsStatisticsItem {
690
+ /**
691
+ * Language
692
+ * @default "en-US"
693
+ */
694
+ language?: string;
695
+ /** Fund Id */
696
+ fund_id: number;
697
+ /** Quantity */
698
+ quantity: number;
699
+ /** Quantity In Percent */
700
+ quantity_in_percent: number;
701
+ /** Fund Analysis Score Group */
702
+ fund_analysis_score_group: number | null;
703
+ /** Fund Analysis Score Group Text */
704
+ fund_analysis_score_group_text: string | null;
705
+ }
706
+ /** IdentifierTypeEnum */
707
+ export enum BridgeWiseIdentifierTypeEnum {
708
+ TickerExchange = "ticker_exchange",
709
+ Isin = "isin"
710
+ }
711
+ /** ImageExtensionEnum */
712
+ export enum BridgeWiseImageExtensionEnum {
713
+ Png = "png",
714
+ Svg = "svg",
715
+ Jpg = "jpg"
716
+ }
717
+ /**
718
+ * Logo
719
+ * Model for logo.
720
+ */
721
+ export interface BridgeWiseLogo {
722
+ /** Company Id */
723
+ company_id: number;
724
+ /** Sponsor Id */
725
+ sponsor_id?: number | null;
726
+ /** Links */
727
+ links: BridgeWiseLogolink[];
728
+ }
729
+ /** LogoSizeEnum */
730
+ export enum BridgeWiseLogoSizeEnum {
731
+ Original = "original",
732
+ Square = "square"
733
+ }
734
+ /** LogoTypeEnum */
735
+ export enum BridgeWiseLogoTypeEnum {
736
+ Square = "square",
737
+ Horizontal = "horizontal"
738
+ }
739
+ /**
740
+ * Logolink
741
+ * Model for logo link.
742
+ */
743
+ export interface BridgeWiseLogolink {
744
+ size: BridgeWiseLogoSizeEnum;
745
+ /** Url */
746
+ url: string;
747
+ type: BridgeWiseLogoTypeEnum;
748
+ extension: BridgeWiseImageExtensionEnum;
749
+ /**
750
+ * Is Sponsor
751
+ * @default false
752
+ */
753
+ is_sponsor?: boolean;
754
+ }
755
+ /** Metadata */
756
+ export interface BridgeWiseMetadata {
757
+ /** Language */
758
+ language: string;
759
+ /**
760
+ * Updated At
761
+ * @format date-time
762
+ */
763
+ updated_at: string;
764
+ /** Fund Id */
765
+ fund_id: number;
766
+ /** Fund Name */
767
+ fund_name: string;
768
+ /**
769
+ * Fund Name Short
770
+ * @default ""
771
+ */
772
+ fund_name_short?: string | null;
773
+ /** Fund Type Id */
774
+ fund_type_id: number | null;
775
+ /** Fund Type Name */
776
+ fund_type_name: string | null;
777
+ /** Domicile Country Name */
778
+ domicile_country_name: string | null;
779
+ /** Primary Trading Item */
780
+ primary_trading_item: number;
781
+ /** Primary Ticker Symbol */
782
+ primary_ticker_symbol: string;
783
+ /** Primary Exchange Symbol */
784
+ primary_exchange_symbol: string;
785
+ /** Primary Exchange Name */
786
+ primary_exchange_name: string;
787
+ /** Primary Market Currency Iso3 */
788
+ primary_market_currency_iso3: string;
789
+ /** Geographic Country Mandate */
790
+ geographic_country_mandate: string | null;
791
+ /** Geographic Region Mandate */
792
+ geographic_region_mandate: string | null;
793
+ /** Market Capitalization Emphasis */
794
+ market_capitalization_emphasis: string | null;
795
+ /** Sector Emphasis */
796
+ sector_emphasis: string | null;
797
+ /** Inception Date */
798
+ inception_date: string | null;
799
+ /** Weight Method */
800
+ weight_method: string | null;
801
+ /** Exposure */
802
+ exposure: string | null;
803
+ /** Leverage */
804
+ leverage: number | null;
805
+ /** Sponsor Name */
806
+ sponsor_name: string | null;
807
+ /**
808
+ * Sponsor Name Short
809
+ * @default ""
810
+ */
811
+ sponsor_name_short?: string | null;
812
+ /** Benchmark Id */
813
+ benchmark_id: number | null;
814
+ /** Benchmark Name */
815
+ benchmark_name: string | null;
816
+ /**
817
+ * Benchmark Name Short
818
+ * @default ""
819
+ */
820
+ benchmark_name_short?: string | null;
821
+ /** Management Style */
822
+ management_style: string | null;
823
+ /**
824
+ * Number Of Holdings
825
+ * @default 0
826
+ */
827
+ number_of_holdings?: number | null;
828
+ /** Has Score */
829
+ has_score: boolean | null;
830
+ /** Pct Of Equity Holdings */
831
+ pct_of_equity_holdings: number | null;
832
+ /**
833
+ * Portfolio Strategy
834
+ * @default -1
835
+ */
836
+ portfolio_strategy?: string | null;
837
+ }
838
+ /** MetadataList */
839
+ export type BridgeWiseMetadataList = BridgeWiseMetadata[];
840
+ /** Page[Logo] */
841
+ export interface BridgeWisePageLogo {
842
+ /** Items */
843
+ items: BridgeWiseLogo[];
844
+ /** Total */
845
+ total: number | null;
846
+ /** Page */
847
+ page: number | null;
848
+ /** Size */
849
+ size: number | null;
850
+ /** Pages */
851
+ pages?: number | null;
852
+ }
853
+ /** StringBooleanEnum */
854
+ export enum BridgeWiseStringBooleanEnum {
855
+ True = "true",
856
+ False = "false"
857
+ }
858
+ /** TradingItems */
859
+ export interface BridgeWiseTradingItems {
860
+ /** Company Id */
861
+ company_id: number | null;
862
+ /** Security Id */
863
+ security_id: number | null;
864
+ /** Security Primary Flag */
865
+ security_primary_flag: boolean | null;
866
+ /** Trading Item Id */
867
+ trading_item_id: number | null;
868
+ /** Primary Flag */
869
+ primary_flag: boolean | null;
870
+ /** Ticker Symbol */
871
+ ticker_symbol: string | null;
872
+ /** Exchange Symbol */
873
+ exchange_symbol: string | null;
874
+ /** Exchange Name */
875
+ exchange_name: string | null;
876
+ /** Exchange Id */
877
+ exchange_id: number | null;
878
+ /** Exchange Importance Level */
879
+ exchange_importance_level: number | null;
880
+ /** Currency Iso3 */
881
+ currency_iso3: string | null;
882
+ }
883
+ /** TradingItemsList */
884
+ export type BridgeWiseTradingItemsList = BridgeWiseTradingItems[];
885
+ /** CompanyNews */
886
+ export interface BridgeWiseCompanyNews {
887
+ /** Company Id */
888
+ company_id: number;
889
+ /** Title */
890
+ title: string;
891
+ /** Body */
892
+ body: string;
893
+ /**
894
+ * Article Link
895
+ * @format uri
896
+ * @minLength 1
897
+ * @maxLength 2083
898
+ */
899
+ article_link: string;
900
+ /**
901
+ * Publication Date
902
+ * @format date-time
903
+ */
904
+ publication_date: string;
905
+ /** Relevancy Score */
906
+ relevancy_score: number;
907
+ /** Sentiment */
908
+ sentiment: number | null;
909
+ /** Sentiment Text */
910
+ sentiment_text?: string | null;
911
+ /** Source */
912
+ source: string;
913
+ /** Social Shares */
914
+ social_shares?: number | null;
915
+ }
916
+ /** CompanyNewsAverageSentiment */
917
+ export interface BridgeWiseCompanyNewsAverageSentiment {
918
+ /** Company Id */
919
+ company_id: number;
920
+ /** Average Sentiment Score */
921
+ average_sentiment_score: number;
922
+ average_sentiment: BridgeWiseNewsSentimentEnum;
923
+ /** News Count */
924
+ news_count: number;
925
+ }
926
+ /** CompanyNewsSortingEnum */
927
+ export enum BridgeWiseCompanyNewsSortingEnum {
928
+ PublicationDate = "publication_date",
929
+ RelevancyScore = "relevancy_score",
930
+ SocialShares = "social_shares"
931
+ }
932
+ /** ESGSectionTypeEnum */
933
+ export enum BridgeWiseESGSectionTypeEnum {
934
+ Social = "social",
935
+ Environmental = "environmental",
936
+ Governance = "governance",
937
+ Summary = "summary",
938
+ Controversies = "controversies",
939
+ Transparency = "transparency",
940
+ Weaknesses = "weaknesses"
941
+ }
942
+ /** EarningsCallRecapEnum */
943
+ export enum BridgeWiseEarningsCallRecapEnum {
944
+ Highlights = "highlights",
945
+ Lowlights = "lowlights"
946
+ }
947
+ /** EarningsCallResponse */
948
+ export interface BridgeWiseEarningsCallResponse {
949
+ /** Ticker Symbol */
950
+ ticker_symbol: string;
951
+ /** Company Id */
952
+ company_id: number;
953
+ /** Year */
954
+ year: number;
955
+ /** Quarter */
956
+ quarter: number;
957
+ /** Guidance */
958
+ guidance: string;
959
+ /** Summary */
960
+ summary: string;
961
+ }
962
+ /** FundParagraph */
963
+ export interface BridgeWiseFundParagraph {
964
+ /**
965
+ * Analysis Type
966
+ * @default "fundamental"
967
+ */
968
+ analysis_type?: string;
969
+ /** Section Type */
970
+ section_type: string;
971
+ /** Paragraph Type */
972
+ paragraph_type: string;
973
+ /** Paragraph */
974
+ paragraph?: string | null;
975
+ /** Language */
976
+ language: string;
977
+ /**
978
+ * Updated At
979
+ * @format date-time
980
+ */
981
+ updated_at: string;
982
+ /** Year */
983
+ year?: number | null;
984
+ /** Quarter */
985
+ quarter?: number | null;
986
+ }
987
+ /** FundamentalParagraphSectionTypeEnum */
988
+ export enum BridgeWiseFundamentalParagraphSectionTypeEnum {
989
+ BalanceSheet = "balance_sheet",
990
+ IncomeStatement = "income_statement",
991
+ CashFlow = "cash_flow",
992
+ CompanyDescription = "company_description",
993
+ CompanyFundamentals = "company_fundamentals",
994
+ SummaryRecommendation = "summary_recommendation"
995
+ }
996
+ /** NewsSentimentEnum */
997
+ export enum BridgeWiseNewsSentimentEnum {
998
+ VeryNegative = "Very Negative",
999
+ Negative = "Negative",
1000
+ Neutral = "Neutral",
1001
+ Positive = "Positive",
1002
+ VeryPositive = "Very Positive",
1003
+ Invalid = "Invalid"
1004
+ }
1005
+ /** PaginatedResponse[CompanyNews] */
1006
+ export interface BridgeWisePaginatedResponseCompanyNews {
1007
+ /**
1008
+ * Items
1009
+ * @default []
1010
+ */
1011
+ items?: BridgeWiseCompanyNews[];
1012
+ /**
1013
+ * Total
1014
+ * @default 0
1015
+ */
1016
+ total?: number;
1017
+ /**
1018
+ * Page
1019
+ * @default 1
1020
+ */
1021
+ page?: number;
1022
+ /**
1023
+ * Size
1024
+ * @default 0
1025
+ */
1026
+ size?: number;
1027
+ /**
1028
+ * Pages
1029
+ * @default 0
1030
+ */
1031
+ pages?: number;
1032
+ }
1033
+ /**
1034
+ * Paragraph
1035
+ * Model for combined paragraphs data.
1036
+ */
1037
+ export interface BridgeWiseParagraph {
1038
+ /** Analysis Type */
1039
+ analysis_type: string;
1040
+ /** Section Type */
1041
+ section_type: string;
1042
+ /** Paragraph Type */
1043
+ paragraph_type: string;
1044
+ /** Paragraph */
1045
+ paragraph: string;
1046
+ /** Language */
1047
+ language: string;
1048
+ /**
1049
+ * Updated At
1050
+ * @format date-time
1051
+ */
1052
+ updated_at: string;
1053
+ /** Year */
1054
+ year?: number | null;
1055
+ }
1056
+ /** RecapsResponse */
1057
+ export interface BridgeWiseRecapsResponse {
1058
+ /** Type */
1059
+ type: string;
1060
+ /** Header */
1061
+ header: string;
1062
+ /** Text */
1063
+ text: string;
1064
+ }
1065
+ /** ScoringMethodEnum */
1066
+ export enum BridgeWiseScoringMethodEnum {
1067
+ Global = "global",
1068
+ Industry = "industry",
1069
+ Country = "country",
1070
+ Sector = "sector"
1071
+ }
1072
+ /** CompanyParameter */
1073
+ export interface BridgeWiseCompanyParameter {
1074
+ /**
1075
+ * Language
1076
+ * @default "en-US"
1077
+ */
1078
+ language?: string;
1079
+ /**
1080
+ * Updated At
1081
+ * @format date-time
1082
+ */
1083
+ updated_at: string;
1084
+ /** Calendar Year */
1085
+ calendar_year: number;
1086
+ /** Calendar Quarter */
1087
+ calendar_quarter: number;
1088
+ /**
1089
+ * Analysis Type
1090
+ * @default "fundamental"
1091
+ */
1092
+ analysis_type?: string;
1093
+ /**
1094
+ * Analysis Type Name
1095
+ * @default "fundamental"
1096
+ */
1097
+ analysis_type_name?: string;
1098
+ /** Section Type */
1099
+ section_type: string | null;
1100
+ /** Section Type Name */
1101
+ section_type_name: string | null;
1102
+ /** Filing Date */
1103
+ filing_date: string | null;
1104
+ /** Period Type */
1105
+ period_type: string | null;
1106
+ /** Parameter Id */
1107
+ parameter_id: number;
1108
+ /** Parameter Name */
1109
+ parameter_name: number | string;
1110
+ /** Parameter Description */
1111
+ parameter_description: number | string;
1112
+ /** Parameter Value */
1113
+ parameter_value: number | null;
1114
+ /**
1115
+ * Parameter Value Change
1116
+ * @default 0
1117
+ */
1118
+ parameter_value_change?: number | null;
1119
+ /** Parameter Type */
1120
+ parameter_type: string | null;
1121
+ /** Parameter Currency Iso3 */
1122
+ parameter_currency_iso3: string | null;
1123
+ /**
1124
+ * Parameter Exchange Rate To Usd
1125
+ * @default 1
1126
+ */
1127
+ parameter_exchange_rate_to_usd?: number | null;
1128
+ }
1129
+ /** CompanyParametersItemList */
1130
+ export type BridgeWiseCompanyParametersItemList = BridgeWiseCompanyParameter[];
1131
+ /** ESGParameterListV2 */
1132
+ export type BridgeWiseESGParameterListV2 = BridgeWiseESGParameterV2[];
1133
+ /**
1134
+ * ESGParameterV2
1135
+ * Model for ESG criteria data
1136
+ */
1137
+ export interface BridgeWiseESGParameterV2 {
1138
+ /**
1139
+ * Language
1140
+ * @default "en-US"
1141
+ */
1142
+ language?: string;
1143
+ /**
1144
+ * Updated At
1145
+ * @format date
1146
+ */
1147
+ updated_at: string;
1148
+ /**
1149
+ * Analysis Type
1150
+ * @default "esg"
1151
+ */
1152
+ analysis_type?: string;
1153
+ /** Section Type */
1154
+ section_type: string;
1155
+ /** Parameter Name */
1156
+ parameter_name: number | string;
1157
+ parameter_score_group_text: BridgeWiseESGScoreGroup | null;
1158
+ /** Parameter Score Group */
1159
+ parameter_score_group: number | null;
1160
+ /** Parameter Description */
1161
+ parameter_description: number | string;
1162
+ /** Parameter Rank In Industry */
1163
+ parameter_rank_in_industry: number | null;
1164
+ /**
1165
+ * Parameter Rank In Industry Change
1166
+ * @default 0
1167
+ */
1168
+ parameter_rank_in_industry_change?: number | null;
1169
+ /** Parameter Percentile */
1170
+ parameter_percentile: number | null;
1171
+ /** Parameter Weight */
1172
+ parameter_weight: number;
1173
+ /** Parameter Id */
1174
+ parameter_id: number;
1175
+ /** Year */
1176
+ year: number;
1177
+ /** Section Id */
1178
+ section_id: number;
1179
+ /**
1180
+ * Parameter Score Industry Avg
1181
+ * @default 0
1182
+ */
1183
+ parameter_score_industry_avg?: number | null;
1184
+ /**
1185
+ * Parameter Score Industry Median
1186
+ * @default 0
1187
+ */
1188
+ parameter_score_industry_median?: number | null;
1189
+ }
1190
+ /**
1191
+ * ESGScoreGroup
1192
+ * Enum representing ESG score groups.
1193
+ */
1194
+ export enum BridgeWiseESGScoreGroup {
1195
+ Value5 = 5,
1196
+ Value4 = 4,
1197
+ Value3 = 3,
1198
+ Value2 = 2,
1199
+ Value1 = 1
1200
+ }
1201
+ /** FundParameter */
1202
+ export interface BridgeWiseFundParameter {
1203
+ /**
1204
+ * Language
1205
+ * @default "en-US"
1206
+ */
1207
+ language?: string;
1208
+ /** Updated At */
1209
+ updated_at: string;
1210
+ /** Year */
1211
+ year: number;
1212
+ /** Quarter */
1213
+ quarter: number;
1214
+ /** Section Type */
1215
+ section_type: number | string | null;
1216
+ /** Section Type Name */
1217
+ section_type_name: number | string | null;
1218
+ /** Analysis Type */
1219
+ analysis_type: string;
1220
+ /** Analysis Type Name */
1221
+ analysis_type_name: string;
1222
+ /** Parameter Id */
1223
+ parameter_id: number;
1224
+ /** Parameter Name */
1225
+ parameter_name: number | string;
1226
+ /** Parameter Type */
1227
+ parameter_type: number | string | null;
1228
+ /** Parameter Value */
1229
+ parameter_value: number | null;
1230
+ /** Parameter Value Change */
1231
+ parameter_value_change: number | null;
1232
+ /** Parameter Currency Iso3 */
1233
+ parameter_currency_iso3: string | null;
1234
+ /** Parameter Value Exchange Rate To Usd */
1235
+ parameter_value_exchange_rate_to_usd: number | null;
1236
+ /** Parameter Description */
1237
+ parameter_description?: number | string | null;
1238
+ /** Has Score */
1239
+ has_score: boolean;
1240
+ /**
1241
+ * Is Penalized
1242
+ * @default false
1243
+ */
1244
+ is_penalized?: boolean;
1245
+ /** Parameter Score Group */
1246
+ parameter_score_group: number | null;
1247
+ /** Parameter Score Group Text */
1248
+ parameter_score_group_text: number | string | null;
1249
+ }
1250
+ /** FundParametersItemList */
1251
+ export type BridgeWiseFundParametersItemList = BridgeWiseFundParameter[];
1252
+ /** FundSegmentsList */
1253
+ export type BridgeWiseFundSegmentsList = BridgeWiseSegmentItem[];
1254
+ /** FundsSegmentParameterEnum */
1255
+ export enum BridgeWiseFundsSegmentParameterEnum {
1256
+ PeRatio = "pe_ratio",
1257
+ PbRatio = "pb_ratio",
1258
+ PsRatio = "ps_ratio",
1259
+ NetDebtToEbitda = "net_debt_to_ebitda",
1260
+ MarketCap = "market_cap",
1261
+ Return1Y = "return_1y",
1262
+ Roe = "roe",
1263
+ RevenueGrowth = "revenue_growth",
1264
+ SegmentStrength = "segment_strength"
1265
+ }
1266
+ /** FundsSegmentParametersItem */
1267
+ export interface BridgeWiseFundsSegmentParametersItem {
1268
+ /**
1269
+ * Language
1270
+ * @default "en-US"
1271
+ */
1272
+ language?: string;
1273
+ /** Fund Id */
1274
+ fund_id: number;
1275
+ /** Segment */
1276
+ segment: string;
1277
+ /** Segment Type */
1278
+ segment_type: string;
1279
+ /** Parameter Type */
1280
+ parameter_type: string | null;
1281
+ /** Parameter Type Name */
1282
+ parameter_type_name: string | null;
1283
+ /** Value */
1284
+ value: number | null;
1285
+ /** Value Change */
1286
+ value_change: number | null;
1287
+ /** Value Change Description */
1288
+ value_change_description: string | number | null;
1289
+ /** Unit Type */
1290
+ unit_type: number | string | null;
1291
+ /** Currency Iso 3 */
1292
+ currency_iso_3?: string | null;
1293
+ }
1294
+ /** PeriodTypeEnum */
1295
+ export enum BridgeWisePeriodTypeEnum {
1296
+ Quarterly = "quarterly",
1297
+ Annually = "annually",
1298
+ Last12Month = "last_12_month"
1299
+ }
1300
+ /** SectionTypeEnum */
1301
+ export enum BridgeWiseSectionTypeEnum {
1302
+ BalanceSheet = "balance_sheet",
1303
+ IncomeStatement = "income_statement",
1304
+ CashFlow = "cash_flow",
1305
+ Social = "social",
1306
+ Environmental = "environmental",
1307
+ Governance = "governance",
1308
+ Summary = "summary",
1309
+ Probability = "probability"
1310
+ }
1311
+ /** SegmentItem */
1312
+ export interface BridgeWiseSegmentItem {
1313
+ /** Language */
1314
+ language: string;
1315
+ /** Year */
1316
+ year: number;
1317
+ /** Quarter */
1318
+ quarter: number;
1319
+ /** Asset Type */
1320
+ asset_type: string;
1321
+ /** Segment */
1322
+ segment: string | null;
1323
+ /** Segment Type */
1324
+ segment_type: string | null;
1325
+ /** Segment Type Name */
1326
+ segment_type_name: string | null;
1327
+ /** Segment Weight */
1328
+ segment_weight: number | null;
1329
+ }
1330
+ /** AnalysisResponse */
1331
+ export type BridgeWiseAnalysisResponse = BridgeWiseAnalysisResponseItem[];
1332
+ /** AnalysisResponseItem */
1333
+ export interface BridgeWiseAnalysisResponseItem {
1334
+ /** Updated At */
1335
+ updated_at: string;
1336
+ /** Analysis Type */
1337
+ analysis_type: string;
1338
+ /** Analysis Score */
1339
+ analysis_score?: number | null;
1340
+ /** Analysis Rank In Industry */
1341
+ analysis_rank_in_industry?: number | null;
1342
+ /** Analysis Score Group Text */
1343
+ analysis_score_group_text: number | string;
1344
+ /** Analysis Score Group */
1345
+ analysis_score_group: number;
1346
+ /** Analysis Percentile */
1347
+ analysis_percentile?: number | null;
1348
+ /** Analysis Score Industry Median */
1349
+ analysis_score_industry_median?: number | null;
1350
+ /** Analysis Score Industry Avg */
1351
+ analysis_score_industry_avg?: number | null;
1352
+ /** Analysis Rank Of Industry */
1353
+ analysis_rank_of_industry?: number | null;
1354
+ /** Analysis Percentile Of Industry */
1355
+ analysis_percentile_of_industry?: number | null;
1356
+ /** Total Companies In Industry */
1357
+ total_companies_in_industry?: number | null;
1358
+ /** Year */
1359
+ year: number;
1360
+ /** Quarter */
1361
+ quarter?: number | null;
1362
+ }
1363
+ /** AnalysisTypeEnum */
1364
+ export enum BridgeWiseAnalysisTypeEnum {
1365
+ Fundamental = "fundamental",
1366
+ Esg = "esg",
1367
+ PriceTarget = "price_target",
1368
+ Technical = "technical"
1369
+ }
1370
+ /** FundamentalAnalysisResponse */
1371
+ export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
1372
+ /** FundamentalAnalysisResponseItem */
1373
+ export interface BridgeWiseFundamentalAnalysisResponseItem {
1374
+ /** Language */
1375
+ language: string;
1376
+ /** Year */
1377
+ year: number;
1378
+ /** Quarter */
1379
+ quarter: number;
1380
+ /** Updated At */
1381
+ updated_at: string;
1382
+ /** Analysis Type */
1383
+ analysis_type: string | null;
1384
+ /** Analysis Type Name */
1385
+ analysis_type_name: string | null;
1386
+ /** Analysis Score */
1387
+ analysis_score: number | null;
1388
+ /** Analysis Score Group */
1389
+ analysis_score_group: number | null;
1390
+ /** Analysis Score Group Text */
1391
+ analysis_score_group_text: number | string | null;
1392
+ /** Analysis Score Universe Median */
1393
+ analysis_score_universe_median: number;
1394
+ /** Analysis Score Universe Avg */
1395
+ analysis_score_universe_avg: number;
1396
+ /** Analysis Rank */
1397
+ analysis_rank: number;
1398
+ /** Analysis Rank Change */
1399
+ analysis_rank_change: number;
1400
+ /** Analysis Rank Percentile */
1401
+ analysis_rank_percentile: number;
1402
+ /** Universe */
1403
+ universe: string;
1404
+ /** Total Entities In Universe */
1405
+ total_entities_in_universe: number;
1406
+ /** Filing Date */
1407
+ filing_date: string;
1408
+ /** Change Since Filling */
1409
+ change_since_filling: number | null;
1410
+ }
1411
+ /** FundamentalSectionTypeEnum */
1412
+ export enum BridgeWiseFundamentalSectionTypeEnum {
1413
+ BalanceSheet = "balance_sheet",
1414
+ IncomeStatement = "income_statement",
1415
+ CashFlow = "cash_flow"
1416
+ }
1417
+ /** FundamentalSectionsResponse */
1418
+ export type BridgeWiseFundamentalSectionsResponse = BridgeWiseFundamentalSectionsResponseItem[];
1419
+ /** FundamentalSectionsResponseItem */
1420
+ export interface BridgeWiseFundamentalSectionsResponseItem {
1421
+ /** Language */
1422
+ language: string;
1423
+ /** Updated At */
1424
+ updated_at: string;
1425
+ /** Year */
1426
+ year: number;
1427
+ /** Quarter */
1428
+ quarter: number;
1429
+ /** Analysis Type */
1430
+ analysis_type: string | null;
1431
+ /** Analysis Type Name */
1432
+ analysis_type_name: string | null;
1433
+ /** Section Type */
1434
+ section_type: string;
1435
+ /** Section Type Name */
1436
+ section_type_name: string | null;
1437
+ /** Section Score */
1438
+ section_score: number | null;
1439
+ /** Section Score Group */
1440
+ section_score_group: number | null;
1441
+ /** Section Score Group Text */
1442
+ section_score_group_text: number | string | null;
1443
+ /** Section Score Universe Median */
1444
+ section_score_universe_median: number;
1445
+ /** Section Score Universe Avg */
1446
+ section_score_universe_avg: number;
1447
+ /** Section Rank */
1448
+ section_rank: number;
1449
+ /** Section Rank Change */
1450
+ section_rank_change: number;
1451
+ /** Section Rank Percentile */
1452
+ section_rank_percentile: number;
1453
+ /** Universe */
1454
+ universe: string;
1455
+ /** Filing Date */
1456
+ filing_date: string;
1457
+ }
1458
+ /** FundsAnalysisItem */
1459
+ export interface BridgeWiseFundsAnalysisItem {
1460
+ /**
1461
+ * Language
1462
+ * @default "en-US"
1463
+ */
1464
+ language?: string;
1465
+ /** Updated At */
1466
+ updated_at: string;
1467
+ /** Year */
1468
+ year: number;
1469
+ /** Quarter */
1470
+ quarter: number;
1471
+ /** Analysis Type */
1472
+ analysis_type: string;
1473
+ /** Analysis Type Name */
1474
+ analysis_type_name: string;
1475
+ /** Analysis Score */
1476
+ analysis_score: number | null;
1477
+ /** Analysis Score Group */
1478
+ analysis_score_group: number;
1479
+ /** Analysis Score Group Text */
1480
+ analysis_score_group_text: number | string | null;
1481
+ /** Is Relative */
1482
+ is_relative: boolean;
1483
+ /** Analysis Score Universe Median */
1484
+ analysis_score_universe_median: number | null;
1485
+ /** Analysis Score Universe Avg */
1486
+ analysis_score_universe_avg: number | null;
1487
+ /** Analysis Rank */
1488
+ analysis_rank: number | null;
1489
+ /** Analysis Rank Change */
1490
+ analysis_rank_change: number | null;
1491
+ /** Analysis Rank Percentile */
1492
+ analysis_rank_percentile: number | null;
1493
+ /** Total Companies In Universe */
1494
+ total_companies_in_universe: number;
1495
+ }
1496
+ /** FundsSectionsItem */
1497
+ export interface BridgeWiseFundsSectionsItem {
1498
+ /**
1499
+ * Language
1500
+ * @default "en-US"
1501
+ */
1502
+ language?: string;
1503
+ /** Updated At */
1504
+ updated_at: string;
1505
+ /** Year */
1506
+ year: number;
1507
+ /** Quarter */
1508
+ quarter: number;
1509
+ /** Analysis Type */
1510
+ analysis_type: string;
1511
+ /** Analysis Type Name */
1512
+ analysis_type_name: string;
1513
+ /** Section Type */
1514
+ section_type: string;
1515
+ /** Section Type Name */
1516
+ section_type_name: string;
1517
+ /** Section Score */
1518
+ section_score: number | null;
1519
+ /** Section Score Group */
1520
+ section_score_group: number;
1521
+ /** Section Score Group Text */
1522
+ section_score_group_text: number | string | null;
1523
+ /** Is Relative */
1524
+ is_relative: boolean;
1525
+ /** Section Score Universe Median */
1526
+ section_score_universe_median: number | null;
1527
+ /** Section Score Universe Avg */
1528
+ section_score_universe_avg: number | null;
1529
+ /** Section Rank Change */
1530
+ section_rank_change: number | null;
1531
+ /** Section Rank Percentile */
1532
+ section_rank_percentile: number | null;
1533
+ /** Section Rank In Universe */
1534
+ section_rank_in_universe: number | null;
1535
+ }
1536
+ /** GlobalIndustryScoringEnum */
1537
+ export enum BridgeWiseGlobalIndustryScoringEnum {
1538
+ Global = "global",
1539
+ Industry = "industry"
1540
+ }
1541
+ /** ScoreMethodology */
1542
+ export enum BridgeWiseScoreMethodology {
1543
+ Global = "global",
1544
+ Industry = "industry",
1545
+ Country = "country",
1546
+ Sector = "sector"
1547
+ }
1548
+ /** SectionsResponse */
1549
+ export type BridgeWiseSectionsResponse = BridgeWiseSectionsResponseItem[];
1550
+ /** SectionsResponseItem */
1551
+ export interface BridgeWiseSectionsResponseItem {
1552
+ /** Language */
1553
+ language: string;
1554
+ /** Updated At */
1555
+ updated_at: string;
1556
+ /** Analysis Type */
1557
+ analysis_type: string;
1558
+ /** Analysis Type Name */
1559
+ analysis_type_name?: string | null;
1560
+ /** Section Type */
1561
+ section_type: string;
1562
+ /** Section Type Name */
1563
+ section_type_name?: string | null;
1564
+ /** Section Score */
1565
+ section_score: number;
1566
+ /** Section Score Industry Avg */
1567
+ section_score_industry_avg?: number | null;
1568
+ /** Section Score Industry Median */
1569
+ section_score_industry_median?: number | null;
1570
+ /** Section Score Group Text */
1571
+ section_score_group_text: string;
1572
+ /** Section Score Group */
1573
+ section_score_group: number;
1574
+ /** Section Rank In Industry */
1575
+ section_rank_in_industry?: number | null;
1576
+ /** Section Weight */
1577
+ section_weight?: number | null;
1578
+ /** Year */
1579
+ year: number;
1580
+ /** Quarter */
1581
+ quarter?: number | null;
1582
+ /** Section Percentile */
1583
+ section_percentile?: number | null;
1584
+ }
1585
+ /** TargetPriceList */
1586
+ export type BridgeWiseTargetPriceList = BridgeWiseTargetPriceResponse[];
1587
+ /** TargetPriceResponse */
1588
+ export interface BridgeWiseTargetPriceResponse {
1589
+ /**
1590
+ * Filing Date
1591
+ * @format date
1592
+ */
1593
+ filing_date: string;
1594
+ /** Group Filing Date */
1595
+ group_filing_date?: string | null;
1596
+ /**
1597
+ * Updated At
1598
+ * @format date-time
1599
+ */
1600
+ updated_at: string;
1601
+ /** Trading Item Id */
1602
+ trading_item_id: number;
1603
+ /** Company Id */
1604
+ company_id: number;
1605
+ /** Target Price */
1606
+ target_price: number;
1607
+ /** Target Price To Last Close Change */
1608
+ target_price_to_last_close_change: number;
1609
+ /** Currency Iso3 */
1610
+ currency_iso3: string;
1611
+ }
1612
+ /** CreateTenantApp */
1613
+ export interface BridgeWiseCreateTenantApp {
1614
+ /** Client Name */
1615
+ client_name: string;
1616
+ /**
1617
+ * Access Token Expiration
1618
+ * @default 60
1619
+ */
1620
+ access_token_expiration?: number;
1621
+ /**
1622
+ * Refresh Token Expiration
1623
+ * @default 30
1624
+ */
1625
+ refresh_token_expiration?: number;
1626
+ /** Scopes */
1627
+ scopes: string[];
1628
+ }
1629
+ /** EventTypeEnum */
1630
+ export enum BridgeWiseEventTypeEnum {
1631
+ PolicyThreshold = "policy_threshold",
1632
+ InternalCoverage = "internal_coverage",
1633
+ BwRecommendation = "bw_recommendation"
1634
+ }
1635
+ /** HistoricalPolicyChangesModel */
1636
+ export interface BridgeWiseHistoricalPolicyChangesModel {
1637
+ /** Tenant Id */
1638
+ tenant_id: string;
1639
+ /** Company Id */
1640
+ company_id: number;
1641
+ /**
1642
+ * Changed Date
1643
+ * @format date-time
1644
+ */
1645
+ changed_date: string;
1646
+ /** Current Value */
1647
+ current_value: boolean | number | null;
1648
+ /** Prev Value */
1649
+ prev_value: boolean | number | null;
1650
+ event_type: BridgeWiseEventTypeEnum;
1651
+ }
1652
+ /**
1653
+ * IdCheckConfig
1654
+ * Model for index config.
1655
+ */
1656
+ export interface BridgeWiseIdCheckConfig {
1657
+ /** Name */
1658
+ name: BridgeWiseIdCheckConfigNameEnum;
1659
+ /** Operator */
1660
+ operator: BridgeWiseIdCheckConfigOperatorEnum;
1661
+ /** Value */
1662
+ value: number[];
1663
+ }
1664
+ /**
1665
+ * InvestmentPolicyConfig
1666
+ * Model for investment policy config.
1667
+ */
1668
+ export interface BridgeWiseInvestmentPolicyConfig {
1669
+ /** Configuration */
1670
+ configuration: (BridgeWiseStockingFloatConfig | BridgeWiseMarketDataConfig | BridgeWiseIdCheckConfig)[];
1671
+ /** Group */
1672
+ group: number;
1673
+ }
1674
+ /**
1675
+ * MarketDataConfig
1676
+ * Model for market data related configs.
1677
+ */
1678
+ export interface BridgeWiseMarketDataConfig {
1679
+ /** Name */
1680
+ name: BridgeWiseMarketDataConfigNameEnum;
1681
+ /** Operator */
1682
+ operator: BridgeWiseMarketDataConfigOperatorEnum;
1683
+ /** Currency Id */
1684
+ currency_id: number;
1685
+ /** Value */
1686
+ value: number;
1687
+ }
1688
+ /** PaginatedResponse[HistoricalPolicyChangesModel] */
1689
+ export interface BridgeWisePaginatedResponseHistoricalPolicyChangesModel {
1690
+ /**
1691
+ * Items
1692
+ * @default []
1693
+ */
1694
+ items?: BridgeWiseHistoricalPolicyChangesModel[];
1695
+ /**
1696
+ * Total
1697
+ * @default 0
1698
+ */
1699
+ total?: number;
1700
+ /**
1701
+ * Page
1702
+ * @default 1
1703
+ */
1704
+ page?: number;
1705
+ /**
1706
+ * Size
1707
+ * @default 0
1708
+ */
1709
+ size?: number;
1710
+ /**
1711
+ * Pages
1712
+ * @default 0
1713
+ */
1714
+ pages?: number;
1715
+ }
1716
+ /**
1717
+ * Recommendation
1718
+ * Model for create recommendation.
1719
+ */
1720
+ export interface BridgeWiseRecommendation {
1721
+ /**
1722
+ * Tenant Id
1723
+ * @format uuid4
1724
+ */
1725
+ tenant_id: string;
1726
+ /** Company Id */
1727
+ company_id: number;
1728
+ /** Score Group */
1729
+ score_group?: number | null;
1730
+ /** Risk Assessment */
1731
+ risk_assessment?: number | null;
1732
+ /** Special Risk */
1733
+ special_risk?: boolean | null;
1734
+ /** Calculated Risk Assessment */
1735
+ calculated_risk_assessment?: number | null;
1736
+ /** Calculated Special Risk */
1737
+ calculated_special_risk?: boolean | null;
1738
+ /** Policy Threshold */
1739
+ policy_threshold?: boolean | null;
1740
+ /** Internal Coverage */
1741
+ internal_coverage?: boolean | null;
1742
+ /**
1743
+ * Status
1744
+ * @default []
1745
+ */
1746
+ status?: string[] | null;
1747
+ }
1748
+ /**
1749
+ * RecommendationConfig
1750
+ * Model for recommendation config.
1751
+ */
1752
+ export interface BridgeWiseRecommendationConfig {
1753
+ /** Company Id */
1754
+ company_id: number;
1755
+ /** Tenant Id */
1756
+ tenant_id?: string | null;
1757
+ /** Score Group */
1758
+ score_group?: number | null;
1759
+ /** Risk Assessment */
1760
+ risk_assessment?: number | null;
1761
+ /** Special Risk */
1762
+ special_risk?: boolean | null;
1763
+ /** Internal Coverage */
1764
+ internal_coverage?: boolean | null;
1765
+ /**
1766
+ * Status
1767
+ * @default []
1768
+ */
1769
+ status?: string[] | null;
1770
+ }
1771
+ /**
1772
+ * RecommendationConfigPatch
1773
+ * Model for patch recommendation config.
1774
+ */
1775
+ export interface BridgeWiseRecommendationConfigPatch {
1776
+ /** Score Group */
1777
+ score_group?: number | null;
1778
+ /** Risk Assessment */
1779
+ risk_assessment?: number | null;
1780
+ /** Special Risk */
1781
+ special_risk?: boolean | null;
1782
+ /** Internal Coverage */
1783
+ internal_coverage?: boolean | null;
1784
+ /** Status */
1785
+ status?: string[] | null;
1786
+ }
1787
+ /**
1788
+ * StockingFloatConfig
1789
+ * Model for stocking float config.
1790
+ */
1791
+ export interface BridgeWiseStockingFloatConfig {
1792
+ /** Name */
1793
+ name: 'stock_float';
1794
+ /** Operator */
1795
+ operator: BridgeWiseStockingFloatConfigOperatorEnum;
1796
+ /** Value */
1797
+ value: number;
1798
+ }
1799
+ /**
1800
+ * TenantApp
1801
+ * Model for list tenant apps.
1802
+ */
1803
+ export interface BridgeWiseTenantApp {
1804
+ /** Application Id */
1805
+ application_id: string;
1806
+ /**
1807
+ * Tenant Id
1808
+ * @format uuid4
1809
+ */
1810
+ tenant_id: string;
1811
+ }
1812
+ /**
1813
+ * TenantResponse
1814
+ * Model for tenant response.
1815
+ */
1816
+ export interface BridgeWiseTenantResponse {
1817
+ /** Id */
1818
+ id: string | number;
1819
+ /** Name */
1820
+ name: string;
1821
+ /** Slug */
1822
+ slug: string;
1823
+ /**
1824
+ * Created At
1825
+ * @format date-time
1826
+ */
1827
+ created_at: string;
1828
+ /**
1829
+ * Updated At
1830
+ * @format date-time
1831
+ */
1832
+ updated_at: string;
1833
+ }
1834
+ /** InvalidCredentials */
1835
+ export interface BridgeWiseInvalidCredentials {
1836
+ /**
1837
+ * Message
1838
+ * @default "Invalid credentials"
1839
+ */
1840
+ message?: string;
1841
+ }
1842
+ /** MachineAuthRequest */
1843
+ export interface BridgeWiseMachineAuthRequest {
1844
+ /**
1845
+ * Application Client Id
1846
+ * Cognito application client id
1847
+ */
1848
+ application_client_id: string;
1849
+ /**
1850
+ * Secret
1851
+ * Cognito application client secret
1852
+ */
1853
+ secret: string;
1854
+ }
1855
+ /** MachineAuthResponse */
1856
+ export interface BridgeWiseMachineAuthResponse {
1857
+ /**
1858
+ * Access Token
1859
+ * Cognito access token
1860
+ */
1861
+ access_token: string;
1862
+ }
1863
+ /** MachineDetailsResponse */
1864
+ export interface BridgeWiseMachineDetailsResponse {
1865
+ /**
1866
+ * Client Id
1867
+ * Client's id
1868
+ */
1869
+ client_id: string;
1870
+ /**
1871
+ * Client Name
1872
+ * Client's name
1873
+ */
1874
+ client_name: string;
1875
+ /**
1876
+ * Tenant Id
1877
+ * ID of tenant that client is assigned to
1878
+ * @format uuid4
1879
+ */
1880
+ tenant_id: string;
1881
+ }
1882
+ /** UserAuthRequest */
1883
+ export interface BridgeWiseUserAuthRequest {
1884
+ /**
1885
+ * Email
1886
+ * Cognito user email
1887
+ * @format email
1888
+ */
1889
+ email: string;
1890
+ /**
1891
+ * Password
1892
+ * Cognito user password
1893
+ */
1894
+ password: string;
1895
+ }
1896
+ /** UserAuthResponse */
1897
+ export interface BridgeWiseUserAuthResponse {
1898
+ /**
1899
+ * Access Token
1900
+ * Cognito access token
1901
+ */
1902
+ access_token: string;
1903
+ /**
1904
+ * Id Token
1905
+ * Cognito id token
1906
+ */
1907
+ id_token: string;
1908
+ /**
1909
+ * Refresh Token
1910
+ * Cognito refresh token
1911
+ */
1912
+ refresh_token: string;
1913
+ }
1914
+ /** Name */
1915
+ export enum BridgeWiseIdCheckConfigNameEnum {
1916
+ Index = "index",
1917
+ Exchange = "exchange",
1918
+ DomicileCountry = "domicile_country",
1919
+ ExchangeCountry = "exchange_country"
1920
+ }
1921
+ /** Operator */
1922
+ export enum BridgeWiseIdCheckConfigOperatorEnum {
1923
+ Isin = "isin",
1924
+ Notin = "notin"
1925
+ }
1926
+ /** Name */
1927
+ export enum BridgeWiseMarketDataConfigNameEnum {
1928
+ MarketCap = "market_cap",
1929
+ Volume = "volume"
1930
+ }
1931
+ /** Operator */
1932
+ export enum BridgeWiseMarketDataConfigOperatorEnum {
1933
+ Ge = "ge",
1934
+ Le = "le",
1935
+ Gt = "gt",
1936
+ Lt = "lt"
1937
+ }
1938
+ /** Operator */
1939
+ export enum BridgeWiseStockingFloatConfigOperatorEnum {
1940
+ Ge = "ge",
1941
+ Le = "le",
1942
+ Gt = "gt",
1943
+ Lt = "lt"
1944
+ }
1945
+ export class CompanyMetadata<HandleError extends boolean = boolean> {
1946
+ protected readonly apiClient: JwtClient<HandleError>;
1947
+ constructor(apiClient: JwtClient<HandleError>);
1948
+ /**
1949
+ * @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.
1950
+ * @tags Company Metadata
1951
+ * @name GetCompanies
1952
+ * @summary Get Companies
1953
+ * @request GET:/companies
1954
+ * @secure
1955
+ */
1956
+ getCompanies(query?: {
1957
+ /**
1958
+ * Language
1959
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
1960
+ * @default "en-US"
1961
+ */
1962
+ language?: BridgeWiseLanguageEnum;
1963
+ /**
1964
+ * Peers Of
1965
+ * Peers companies of a specific company.
1966
+ */
1967
+ peers_of?: number;
1968
+ /**
1969
+ * Region Id
1970
+ * Comma-separated unique region identifiers. <br>Example: 10120,10238</br>
1971
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1972
+ */
1973
+ region_id?: string;
1974
+ /**
1975
+ * Incorporation Country Id
1976
+ * Comma-separated unique incorporation country ids. <br>Example: 117,213</br>
1977
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1978
+ */
1979
+ incorporation_country_id?: string;
1980
+ /**
1981
+ * Domicile Country Id
1982
+ * Comma-separated unique domicile country ids. <br>Example: 188,150</br>
1983
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1984
+ */
1985
+ domicile_country_id?: string;
1986
+ /**
1987
+ * Gics Sector Id
1988
+ * Comma-separated unique gics sector identifiers. <br>Example: 50,60</br>
1989
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1990
+ */
1991
+ gics_sector_id?: string;
1992
+ /**
1993
+ * Gics Industry Group Id
1994
+ * Comma-separated unique gics industry group ids. <br>Example: 1510,2510</br>
1995
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
1996
+ */
1997
+ gics_industry_group_id?: string;
1998
+ /**
1999
+ * Gics Industry Id
2000
+ * Comma-separated unique gics industry identifiers. <br>Example: 151010,151020</br>
2001
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2002
+ */
2003
+ gics_industry_id?: string;
2004
+ /**
2005
+ * Csa Industry Id
2006
+ * Comma-separated unique csa industry identifiers. <br>Example: 37,52</br>
2007
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2008
+ */
2009
+ csa_industry_id?: string;
2010
+ /**
2011
+ * Theme Id
2012
+ * Comma-separated list of unique numeric identifiers for investment themes. <br>Example: 123,126</br>
2013
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2014
+ */
2015
+ theme_id?: string;
2016
+ /**
2017
+ * Implied Market Cap Gte
2018
+ * Companies with market cap greater than or equal to.
2019
+ */
2020
+ implied_market_cap__gte?: number;
2021
+ /**
2022
+ * Implied Market Cap Lte
2023
+ * Companies with market cap less than or equal to.
2024
+ */
2025
+ implied_market_cap__lte?: number;
2026
+ /**
2027
+ * Exchange Id
2028
+ * Comma-separated unique exchange identifiers. <br>Example: 104,106</br>
2029
+ */
2030
+ exchange_id?: string;
2031
+ /**
2032
+ * Last Close Market Cap Usd Gte
2033
+ * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 250000000,200000000000</br>
2034
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2035
+ */
2036
+ last_close_market_cap_usd__gte?: string;
2037
+ /**
2038
+ * Last Close Market Cap Usd Lte
2039
+ * Represents the market capitalization of the asset in USD at the most recent market close. <br>Example: 10000000000,200000000000</br>
2040
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2041
+ */
2042
+ last_close_market_cap_usd__lte?: string;
2043
+ /**
2044
+ * Currency Market Id
2045
+ * Comma-separated unique currency market identifiers. <br>Example: 55,149</br>
2046
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2047
+ */
2048
+ currency_market_id?: string;
2049
+ /**
2050
+ * Sort By
2051
+ * Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -last_close_market_cap_usd</br>
2052
+ */
2053
+ sort_by?: string;
2054
+ /**
2055
+ * Filling Date Gte
2056
+ * Companies with filing dates greater than specific date.
2057
+ * @format date
2058
+ */
2059
+ filling_date__gte?: string;
2060
+ /**
2061
+ * Search
2062
+ * Companies search.
2063
+ */
2064
+ search?: string;
2065
+ /**
2066
+ * Assets Turnover Gte
2067
+ * Assets turnover greater than or equal to.
2068
+ */
2069
+ assets_turnover__gte?: number;
2070
+ /**
2071
+ * Assets Turnover Lte
2072
+ * Assets turnover less than or equal to.
2073
+ */
2074
+ assets_turnover__lte?: number;
2075
+ /**
2076
+ * Average Revenue Per Subscriber Gte
2077
+ * Average revenue per subscriber greater than or equal to.
2078
+ */
2079
+ average_revenue_per_subscriber__gte?: number;
2080
+ /**
2081
+ * Average Revenue Per Subscriber Lte
2082
+ * Average revenue per subscriber less than or equal to.
2083
+ */
2084
+ average_revenue_per_subscriber__lte?: number;
2085
+ /**
2086
+ * Pe Ratio Gte
2087
+ * Current PE ratio greater than or equal to.
2088
+ */
2089
+ pe_ratio__gte?: number;
2090
+ /**
2091
+ * Pe Ratio Lte
2092
+ * Current PE ratio less than or equal to.
2093
+ */
2094
+ pe_ratio__lte?: number;
2095
+ /**
2096
+ * Current Ratio Gte
2097
+ * Current ratio greater than or equal to.
2098
+ */
2099
+ current_ratio__gte?: number;
2100
+ /**
2101
+ * Current Ratio Lte
2102
+ * Current ratio less than or equal to.
2103
+ */
2104
+ current_ratio__lte?: number;
2105
+ /**
2106
+ * Dividend Yield Percentage Gte
2107
+ * Dividend yield percent greater than or equal to.
2108
+ */
2109
+ dividend_yield_percentage__gte?: number;
2110
+ /**
2111
+ * Dividend Yield Percentage Lte
2112
+ * Dividend yield percent less than or equal to.
2113
+ */
2114
+ dividend_yield_percentage__lte?: number;
2115
+ /**
2116
+ * Ebitda Margin Percent Gte
2117
+ * EBITDA margin percent greater than or equal to.
2118
+ */
2119
+ ebitda_margin_percent__gte?: number;
2120
+ /**
2121
+ * Ebitda Margin Percent Lte
2122
+ * EBITDA margin percent less than or equal to.
2123
+ */
2124
+ ebitda_margin_percent__lte?: number;
2125
+ /**
2126
+ * Ebit By Interest Expense Gte
2127
+ * EBIT by interest expense greater than or equal to.
2128
+ */
2129
+ ebit_by_interest_expense__gte?: number;
2130
+ /**
2131
+ * Ebit By Interest Expense Lte
2132
+ * EBIT by interest expense less than or equal to.
2133
+ */
2134
+ ebit_by_interest_expense__lte?: number;
2135
+ /**
2136
+ * Free Cash Flow Per Share Gte
2137
+ * Free cash flow per share greater than or equal to.
2138
+ */
2139
+ free_cash_flow_per_share__gte?: number;
2140
+ /**
2141
+ * Free Cash Flow Per Share Lte
2142
+ * Free cash flow per share less than or equal to.
2143
+ */
2144
+ free_cash_flow_per_share__lte?: number;
2145
+ /**
2146
+ * Gross Profit Margin Percent Gte
2147
+ * Gross profit margin percent greater than or equal to.
2148
+ */
2149
+ gross_profit_margin_percent__gte?: number;
2150
+ /**
2151
+ * Gross Profit Margin Percent Lte
2152
+ * Gross profit margin percent less than or equal to.
2153
+ */
2154
+ gross_profit_margin_percent__lte?: number;
2155
+ /**
2156
+ * Last Close Tev Divided By Ebitda Gte
2157
+ * Last close TEV/EBITDA greater than or equal to.
2158
+ */
2159
+ last_close_tev_divided_by_ebitda__gte?: number;
2160
+ /**
2161
+ * Last Close Tev Divided By Ebitda Lte
2162
+ * Last close TEV/EBITDA less than or equal to.
2163
+ */
2164
+ last_close_tev_divided_by_ebitda__lte?: number;
2165
+ /**
2166
+ * Long Term Debt By Total Capital Gte
2167
+ * Long term debt/total capital greater than or equal to.
2168
+ */
2169
+ long_term_debt_by_total_capital__gte?: number;
2170
+ /**
2171
+ * Long Term Debt By Total Capital Lte
2172
+ * Long term debt/total capital less than or equal to.
2173
+ */
2174
+ long_term_debt_by_total_capital__lte?: number;
2175
+ /**
2176
+ * Net Eps Basic Gte
2177
+ * Net EPS basic greater than or equal to.
2178
+ */
2179
+ net_eps_basic__gte?: number;
2180
+ /**
2181
+ * Net Eps Basic Lte
2182
+ * Net EPS basic less than or equal to.
2183
+ */
2184
+ net_eps_basic__lte?: number;
2185
+ /**
2186
+ * Net Eps Diluted Gte
2187
+ * Net EPS diluted greater than or equal to.
2188
+ */
2189
+ net_eps_diluted__gte?: number;
2190
+ /**
2191
+ * Net Eps Diluted Lte
2192
+ * Net EPS diluted less than or equal to.
2193
+ */
2194
+ net_eps_diluted__lte?: number;
2195
+ /**
2196
+ * Net Debt Divided By Ebitda Gte
2197
+ * Net debt/EBITDA greater than or equal to.
2198
+ */
2199
+ net_debt_divided_by_ebitda__gte?: number;
2200
+ /**
2201
+ * Net Debt Divided By Ebitda Lte
2202
+ * Net debt/EBITDA less than or equal to.
2203
+ */
2204
+ net_debt_divided_by_ebitda__lte?: number;
2205
+ /**
2206
+ * Net Debt To Equity Gte
2207
+ * Net debt to equity greater than or equal to.
2208
+ */
2209
+ net_debt_to_equity__gte?: number;
2210
+ /**
2211
+ * Net Debt To Equity Lte
2212
+ * Net debt to equity less than or equal to.
2213
+ */
2214
+ net_debt_to_equity__lte?: number;
2215
+ /**
2216
+ * Net Income Margin Percent Gte
2217
+ * Net income margin percent greater than or equal to.
2218
+ */
2219
+ net_income_margin_percent__gte?: number;
2220
+ /**
2221
+ * Net Income Margin Percent Lte
2222
+ * Net income margin percent less than or equal to.
2223
+ */
2224
+ net_income_margin_percent__lte?: number;
2225
+ /**
2226
+ * Operating Cash Flow By Current Liabilities Gte
2227
+ * Operating cash flow/current liabilities greater than or equal to.
2228
+ */
2229
+ operating_cash_flow_by_current_liabilities__gte?: number;
2230
+ /**
2231
+ * Operating Cash Flow By Current Liabilities Lte
2232
+ * Operating cash flow/current liabilities less than or equal to
2233
+ */
2234
+ operating_cash_flow_by_current_liabilities__lte?: number;
2235
+ /**
2236
+ * Total Revenues One Year Growth Percentage Gte
2237
+ * Total revenues 1-year growth percent greater than or equal to
2238
+ */
2239
+ total_revenues_one_year_growth_percentage__gte?: number;
2240
+ /**
2241
+ * Total Revenues One Year Growth Percentage Lte
2242
+ * Total revenues 1-year growth percent less than or equal to.
2243
+ */
2244
+ total_revenues_one_year_growth_percentage__lte?: number;
2245
+ /**
2246
+ * Total Debt To Capital Percent Gte
2247
+ * Total debt to capital percent greater than or equal to.
2248
+ */
2249
+ total_debt_to_capital_percent__gte?: number;
2250
+ /**
2251
+ * Total Debt To Capital Percent Lte
2252
+ * Total debt to capital percent less than or equal to.
2253
+ */
2254
+ total_debt_to_capital_percent__lte?: number;
2255
+ /**
2256
+ * Period Last Price Divided Book Value Gte
2257
+ * Period last price/book value greater than or equal to.
2258
+ */
2259
+ period_last_price_divided_book_value__gte?: number;
2260
+ /**
2261
+ * Period Last Price Divided Book Value Lte
2262
+ * Period last price/book value less than or equal to.
2263
+ */
2264
+ period_last_price_divided_book_value__lte?: number;
2265
+ /**
2266
+ * Payout Ratio Gte
2267
+ * Payout ratio greater than or equal to.
2268
+ */
2269
+ payout_ratio__gte?: number;
2270
+ /**
2271
+ * Payout Ratio Lte
2272
+ * Payout ratio less than or equal to.
2273
+ */
2274
+ payout_ratio__lte?: number;
2275
+ /**
2276
+ * Quick Ratio Gte
2277
+ * Quick ratio greater than or equal to.
2278
+ */
2279
+ quick_ratio__gte?: number;
2280
+ /**
2281
+ * Quick Ratio Lte
2282
+ * Quick ratio less than or equal to.
2283
+ */
2284
+ quick_ratio__lte?: number;
2285
+ /**
2286
+ * Return On Equity Percent Gte
2287
+ * Return on equity percent greater than or equal to.
2288
+ */
2289
+ return_on_equity_percent__gte?: number;
2290
+ /**
2291
+ * Return On Equity Percent Lte
2292
+ * Return on equity percent less than or equal to.
2293
+ */
2294
+ return_on_equity_percent__lte?: number;
2295
+ /**
2296
+ * Return On Assets Gte
2297
+ * Return on assets greater than or equal to.
2298
+ */
2299
+ return_on_assets__gte?: number;
2300
+ /**
2301
+ * Return On Assets Lte
2302
+ * Return on assets less than or equal to.
2303
+ */
2304
+ return_on_assets__lte?: number;
2305
+ /**
2306
+ * Return On Total Capital Gte
2307
+ * Return on total capital greater than or equal to.
2308
+ */
2309
+ return_on_total_capital__gte?: number;
2310
+ /**
2311
+ * Return On Total Capital Lte
2312
+ * Return on total capital less than or equal to.
2313
+ */
2314
+ return_on_total_capital__lte?: number;
2315
+ /**
2316
+ * Revenue Per Employee In Thousands Gte
2317
+ * Revenue/employee in thousands greater than or equal to.
2318
+ */
2319
+ revenue_per_employee_in_thousands__gte?: number;
2320
+ /**
2321
+ * Revenue Per Employee In Thousands Lte
2322
+ * Revenue/employee in thousands less than or equal to.
2323
+ */
2324
+ revenue_per_employee_in_thousands__lte?: number;
2325
+ /**
2326
+ * Total Debt To Equity Gte
2327
+ * Total debt to equity greater than or equal to.
2328
+ */
2329
+ total_debt_to_equity__gte?: number;
2330
+ /**
2331
+ * Total Debt To Equity Lte
2332
+ * Total debt to equity less than or equal to.
2333
+ */
2334
+ total_debt_to_equity__lte?: number;
2335
+ /**
2336
+ * Total Revenues Gte
2337
+ * Total revenues greater than or equal to.
2338
+ */
2339
+ total_revenues__gte?: number;
2340
+ /**
2341
+ * Total Revenues Lte
2342
+ * Total revenues less than or equal to.
2343
+ */
2344
+ total_revenues__lte?: number;
2345
+ /**
2346
+ * Beta 1 Year Gte
2347
+ * Beta 1 year greater than or equal to.
2348
+ */
2349
+ beta_1_year__gte?: number;
2350
+ /**
2351
+ * Beta 1 Year Lte
2352
+ * Beta 1 year less than or equal to.
2353
+ */
2354
+ beta_1_year__lte?: number;
2355
+ /**
2356
+ * Analysis Fundamental Score Group
2357
+ * Analysis fundamental score group identifiers. <br>Example: 1,2,3,4,5</br>
2358
+ */
2359
+ analysis_fundamental_score_group?: string;
2360
+ /**
2361
+ * Analysis Fundamental Score Gte
2362
+ * Analysis fundamental score greater than or equal to.
2363
+ */
2364
+ analysis_fundamental_score__gte?: number;
2365
+ /**
2366
+ * Analysis Fundamental Score Lte
2367
+ * Analysis fundamental score less than or equal to.
2368
+ */
2369
+ analysis_fundamental_score__lte?: number;
2370
+ /**
2371
+ * Section Income Statement Score Gte
2372
+ * Section income statement score greater than or equal to.
2373
+ */
2374
+ section_income_statement_score__gte?: number;
2375
+ /**
2376
+ * Section Income Statement Score Lte
2377
+ * Section income statement score less than or equal to.
2378
+ */
2379
+ section_income_statement_score__lte?: number;
2380
+ /**
2381
+ * Section Income Statement Score Group
2382
+ * Comma-separated unique section income statement score groups. <br>Example: 1,2,3,4,5</br>
2383
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2384
+ */
2385
+ section_income_statement_score_group?: string;
2386
+ /**
2387
+ * Section Balance Sheet Score Gte
2388
+ * Section balance sheet score greater than or equal to.
2389
+ */
2390
+ section_balance_sheet_score__gte?: number;
2391
+ /**
2392
+ * Section Balance Sheet Score Lte
2393
+ * Section balance sheet score less than or equal to.
2394
+ */
2395
+ section_balance_sheet_score__lte?: number;
2396
+ /**
2397
+ * Section Balance Sheet Score Group
2398
+ * Comma-separated unique section balance sheet score groups. <br>Example: 1,2,3,4,5</br>
2399
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2400
+ */
2401
+ section_balance_sheet_score_group?: string;
2402
+ /**
2403
+ * Section Cash Flow Score Gte
2404
+ * Section cash flow score greater than or equal to.
2405
+ */
2406
+ section_cash_flow_score__gte?: number;
2407
+ /**
2408
+ * Section Cash Flow Score Lte
2409
+ * Section cash flow score less than or equal to.
2410
+ */
2411
+ section_cash_flow_score__lte?: number;
2412
+ /**
2413
+ * Section Cash Flow Score Group
2414
+ * Comma-separated unique section cash flow score groups. <br>Example: 1,2,3,4,5</br>
2415
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2416
+ */
2417
+ section_cash_flow_score_group?: string;
2418
+ /**
2419
+ * Analysis Esg Score Gte
2420
+ * Analysis ESG score greater than or equal to.
2421
+ */
2422
+ analysis_esg_score__gte?: number;
2423
+ /**
2424
+ * Analysis Esg Score Lte
2425
+ * Analysis ESG score less than or equal to.
2426
+ */
2427
+ analysis_esg_score__lte?: number;
2428
+ /**
2429
+ * Analysis Esg Score Group
2430
+ * Comma-separated unique analysis ESG score groups. <br>Example: 1,2,3,4,5</br>
2431
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2432
+ */
2433
+ analysis_esg_score_group?: string;
2434
+ /**
2435
+ * Section Environmental Score Gte
2436
+ * Section environmental score greater than or equal to.
2437
+ */
2438
+ section_environmental_score__gte?: number;
2439
+ /**
2440
+ * Section Environmental Score Lte
2441
+ * Section environmental score less than or equal to.
2442
+ */
2443
+ section_environmental_score__lte?: number;
2444
+ /**
2445
+ * Section Environmental Score Group
2446
+ * Comma-separated unique section environmental score groups. <br>Example: 1,2,3,4,5</br>
2447
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2448
+ */
2449
+ section_environmental_score_group?: string;
2450
+ /**
2451
+ * Section Social Score Gte
2452
+ * Section social score greater than or equal to.
2453
+ */
2454
+ section_social_score__gte?: number;
2455
+ /**
2456
+ * Section Social Score Lte
2457
+ * Section social score less than or equal to.
2458
+ */
2459
+ section_social_score__lte?: number;
2460
+ /**
2461
+ * Section Social Score Group
2462
+ * Comma-separated unique section social score groups. <br>Example: 1,2,3,4,5</br>
2463
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2464
+ */
2465
+ section_social_score_group?: string;
2466
+ /**
2467
+ * Section Governance Score Gte
2468
+ * Section governance score greater than or equal to.
2469
+ */
2470
+ section_governance_score__gte?: number;
2471
+ /**
2472
+ * Section Governance Score Lte
2473
+ * Section governance score less than or equal to.
2474
+ */
2475
+ section_governance_score__lte?: number;
2476
+ /**
2477
+ * Section Governance Score Group
2478
+ * Comma-separated unique section governance score groups. <br>Example: 1,2,3,4,5</br>
2479
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2480
+ */
2481
+ section_governance_score_group?: string;
2482
+ /**
2483
+ * Sector Score Gte
2484
+ * Sector score greater than or equal to.
2485
+ */
2486
+ sector_score__gte?: number;
2487
+ /**
2488
+ * Sector Score Lte
2489
+ * Sector score less than or equal to.
2490
+ */
2491
+ sector_score__lte?: number;
2492
+ /**
2493
+ * Sector Score Group
2494
+ * Comma-separated unique section sector score groups. <br>Example: 1,2,3,4,5</br>
2495
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2496
+ */
2497
+ sector_score_group?: string;
2498
+ /**
2499
+ * Tenant Id
2500
+ * Specify the tenant ID to filter and retrieve companies recommended by that tenant.
2501
+ * @format uuid
2502
+ */
2503
+ tenant_id?: string;
2504
+ /**
2505
+ * Internal Coverage
2506
+ * Internal coverage true or false.
2507
+ */
2508
+ internal_coverage?: boolean;
2509
+ /**
2510
+ * Policy Threshold
2511
+ * Policy threshold true or false.
2512
+ */
2513
+ policy_threshold?: boolean;
2514
+ /**
2515
+ * Return Range Gte
2516
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
2517
+ */
2518
+ return_range__gte?: string;
2519
+ /**
2520
+ * Return Value Gte
2521
+ * 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>
2522
+ */
2523
+ return_value__gte?: string;
2524
+ /**
2525
+ * Return Range Lte
2526
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
2527
+ */
2528
+ return_range__lte?: string;
2529
+ /**
2530
+ * Return Value Lte
2531
+ * 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>
2532
+ */
2533
+ return_value__lte?: string;
2534
+ /**
2535
+ * Page
2536
+ * Define the page number for pagination.
2537
+ * @exclusiveMin 0
2538
+ * @default 1
2539
+ */
2540
+ page?: number;
2541
+ /**
2542
+ * Page Size
2543
+ * Define the number of records per page for pagination purposes.
2544
+ * @exclusiveMin 0
2545
+ * @default 100
2546
+ */
2547
+ page_size?: number;
2548
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompaniesResponse, HandleError>>;
2549
+ /**
2550
+ * @description Retrieves the metadata object of a specific company identified by the company_id. It provides detailed information about the company's characteristics.
2551
+ * @tags Company Metadata
2552
+ * @name GetCompany
2553
+ * @summary Get Company
2554
+ * @request GET:/companies/{company_id}
2555
+ * @secure
2556
+ */
2557
+ getCompany(companyId: number, query?: {
2558
+ /**
2559
+ * Language
2560
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2561
+ * @default "en-US"
2562
+ */
2563
+ language?: BridgeWiseLanguageEnum;
2564
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyResponse[], HandleError>>;
2565
+ /**
2566
+ * @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.
2567
+ * @tags Company Metadata, Fund Metadata
2568
+ * @name GetIdentifierSearch
2569
+ * @summary Get Identifier Search
2570
+ * @request GET:/identifier-search
2571
+ * @secure
2572
+ */
2573
+ getIdentifierSearch(query: {
2574
+ /**
2575
+ * Identifier
2576
+ * Specify an external identifier such as ISIN or ticker-exchange for asset identification.
2577
+ */
2578
+ identifier: string;
2579
+ /**
2580
+ * Identifier Type
2581
+ * Define the type of the external identifier provided.
2582
+ * e.g., ISIN, ticker-exchange.
2583
+ */
2584
+ identifier_type: BridgeWiseIdentifierTypeEnum;
2585
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2586
+ }
2587
+ export class Logos<HandleError extends boolean = boolean> {
2588
+ protected readonly apiClient: JwtClient<HandleError>;
2589
+ constructor(apiClient: JwtClient<HandleError>);
2590
+ /**
2591
+ * @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
2592
+ * @tags Logos
2593
+ * @name FetchLogos
2594
+ * @summary Fetch Logos
2595
+ * @request GET:/companies/logos
2596
+ * @secure
2597
+ */
2598
+ fetchLogos(query?: {
2599
+ /**
2600
+ * Company Id In
2601
+ * Specify a list of BW identifiers for bulk queries.
2602
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
2603
+ * @example "74822,83343211"
2604
+ */
2605
+ company_id__in?: string;
2606
+ /**
2607
+ * Size
2608
+ * Page size
2609
+ * @min 1
2610
+ * @max 100
2611
+ * @default 50
2612
+ */
2613
+ size?: number;
2614
+ /**
2615
+ * Page
2616
+ * Page number
2617
+ * @min 1
2618
+ * @default 1
2619
+ */
2620
+ page?: number;
2621
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
2622
+ /**
2623
+ * @description Retrieves the logo for a specified company using the provided company_id.
2624
+ * @tags Logos
2625
+ * @name FetchLogo
2626
+ * @summary Fetch Logo
2627
+ * @request GET:/companies/{company_id}/logos
2628
+ * @secure
2629
+ */
2630
+ fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
2631
+ }
2632
+ export class Forecasts<HandleError extends boolean = boolean> {
2633
+ protected readonly apiClient: JwtClient<HandleError>;
2634
+ constructor(apiClient: JwtClient<HandleError>);
2635
+ /**
2636
+ * @description <b>!!!WILL BE DEPRECATED!!!</b>
2637
+ * @tags Forecasts
2638
+ * @name GetCompanyForecasts
2639
+ * @summary Get Company Forecasts
2640
+ * @request GET:/companies/{company_id}/forecasts
2641
+ * @secure
2642
+ */
2643
+ getCompanyForecasts(companyId: number, query?: {
2644
+ /**
2645
+ * Language
2646
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2647
+ * @default "en-US"
2648
+ */
2649
+ language?: BridgeWiseLanguageEnum;
2650
+ /**
2651
+ * Forecast Type
2652
+ * Desired forecast type.
2653
+ */
2654
+ forecast_type?: BridgeWiseForecastType;
2655
+ /**
2656
+ * Page
2657
+ * Define the page number for pagination.
2658
+ * @exclusiveMin 0
2659
+ */
2660
+ page?: number;
2661
+ /**
2662
+ * Page Size
2663
+ * Define the number of records per page for pagination purposes.
2664
+ * @exclusiveMin 0
2665
+ */
2666
+ page_size?: number;
2667
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
2668
+ }
2669
+ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
2670
+ protected readonly apiClient: JwtClient<HandleError>;
2671
+ constructor(apiClient: JwtClient<HandleError>);
2672
+ /**
2673
+ * @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
2674
+ * @tags Fundamental Analysis
2675
+ * @name GetCompanyFundamentalAnalysis
2676
+ * @summary Get Company Fundamental Analysis
2677
+ * @request GET:/companies/{company_id}/fundamental-analysis
2678
+ * @secure
2679
+ */
2680
+ getCompanyFundamentalAnalysis(companyId: number, query?: {
2681
+ /**
2682
+ * Language
2683
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2684
+ * @default "en-US"
2685
+ */
2686
+ language?: BridgeWiseLanguageEnum;
2687
+ /**
2688
+ * Show All
2689
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
2690
+ */
2691
+ show_all?: boolean;
2692
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResponse, HandleError>>;
2693
+ /**
2694
+ * @description This endpoint provides detailed textual analyses focused on a company's financial health, including its profitability, balance sheet, cash flow and income statement.
2695
+ * @tags Fundamental Analysis
2696
+ * @name GetCompanyFundamentalParagraphs
2697
+ * @summary Get Company Fundamental Paragraphs
2698
+ * @request GET:/companies/{company_id}/fundamental-paragraphs
2699
+ * @secure
2700
+ */
2701
+ getCompanyFundamentalParagraphs(companyId: number, query?: {
2702
+ /**
2703
+ * Language
2704
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2705
+ * @default "en-US"
2706
+ */
2707
+ language?: BridgeWiseLanguageEnum;
2708
+ /**
2709
+ * Section Type
2710
+ * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
2711
+ */
2712
+ section_type?: BridgeWiseFundamentalParagraphSectionTypeEnum;
2713
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
2714
+ /**
2715
+ * @description Offers an in-depth breakdown of the parameters used in the fundamental analysis, detailing more than 100 key metrics within the income statement, balance sheet and cash flow financial statements.
2716
+ * @tags Fundamental Analysis
2717
+ * @name GetCompanyFundamentalParameters
2718
+ * @summary Get Company Fundamental Parameters
2719
+ * @request GET:/companies/{company_id}/fundamental-parameters
2720
+ * @secure
2721
+ */
2722
+ getCompanyFundamentalParameters(companyId: number, query?: {
2723
+ /**
2724
+ * Language
2725
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2726
+ * @default "en-US"
2727
+ */
2728
+ language?: BridgeWiseLanguageEnum;
2729
+ /**
2730
+ * Section Type
2731
+ * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
2732
+ */
2733
+ section_type?: BridgeWiseSectionTypeEnum;
2734
+ /**
2735
+ * Has Score
2736
+ * Boolean flag. Filter out companies without BW scores (not valid for analysis).
2737
+ * @default false
2738
+ */
2739
+ has_score?: boolean;
2740
+ /**
2741
+ * Year
2742
+ * Specify the year for which the analysis is requested.
2743
+ */
2744
+ year?: number;
2745
+ /**
2746
+ * Quarter
2747
+ * Specify the quarter for which the analysis is requested.
2748
+ */
2749
+ quarter?: number;
2750
+ /**
2751
+ * Period Type
2752
+ * Define the data period format (e.g., TTM, Quarterly, Annual).
2753
+ * @default "quarterly"
2754
+ */
2755
+ period_type?: BridgeWisePeriodTypeEnum;
2756
+ /**
2757
+ * Parameter Id
2758
+ * Get desired parameter by ID.
2759
+ */
2760
+ parameter_id?: number;
2761
+ /**
2762
+ * Limit
2763
+ * Number of objects available for retrieval (based on period_type) starting from the most recent entry
2764
+ */
2765
+ limit?: number;
2766
+ /**
2767
+ * Show All
2768
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
2769
+ */
2770
+ show_all?: boolean;
2771
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyParametersItemList, HandleError>>;
2772
+ /**
2773
+ * @description Provides scores for individual sections of the company's fundamental analysis, including the balance sheet, income statement, and cash flow performance.
2774
+ * @tags Fundamental Analysis
2775
+ * @name GetCompanyFundamentalSections
2776
+ * @summary Get Company Fundamental Sections
2777
+ * @request GET:/companies/{company_id}/fundamental-sections
2778
+ * @secure
2779
+ */
2780
+ getCompanyFundamentalSections(companyId: number, query?: {
2781
+ /**
2782
+ * Language
2783
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2784
+ * @default "en-US"
2785
+ */
2786
+ language?: BridgeWiseLanguageEnum;
2787
+ /**
2788
+ * Section Type
2789
+ * Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
2790
+ */
2791
+ section_type?: BridgeWiseFundamentalSectionTypeEnum;
2792
+ /**
2793
+ * Show All
2794
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
2795
+ */
2796
+ show_all?: boolean;
2797
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalSectionsResponse, HandleError>>;
2798
+ /**
2799
+ * @description Provides Bridgewise's proprietary price target estimation for a specific company, including its percentage difference from the current stock price and the calculated probability of reaching this target.
2800
+ * @tags Fundamental Analysis
2801
+ * @name GetTargetPrice
2802
+ * @summary Get Target Price
2803
+ * @request GET:/companies/{company_id}/target-price
2804
+ * @secure
2805
+ */
2806
+ getTargetPrice(companyId: number, query?: {
2807
+ /**
2808
+ * Trading Item Id
2809
+ * Specify a BW trading asset identifier for a targeted query.
2810
+ */
2811
+ trading_item_id?: number;
2812
+ /**
2813
+ * Date Gte
2814
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
2815
+ */
2816
+ date__gte?: string;
2817
+ /**
2818
+ * Date Lte
2819
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
2820
+ */
2821
+ date__lte?: string;
2822
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
2823
+ }
2824
+ export class CompanyMarketData<HandleError extends boolean = boolean> {
2825
+ protected readonly apiClient: JwtClient<HandleError>;
2826
+ constructor(apiClient: JwtClient<HandleError>);
2827
+ /**
2828
+ * @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
2829
+ * @tags Company Market Data
2830
+ * @name GetCompanyMarketData
2831
+ * @summary Get Company Market Data
2832
+ * @request GET:/companies/{company_id}/market
2833
+ * @secure
2834
+ */
2835
+ getCompanyMarketData(companyId: number, query?: {
2836
+ /**
2837
+ * Trading Item Id
2838
+ * Specify a BW trading asset identifier for a targeted query.
2839
+ */
2840
+ trading_item_id?: number | null;
2841
+ /**
2842
+ * Date Ge
2843
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
2844
+ */
2845
+ date__ge?: string | null;
2846
+ /**
2847
+ * Date Le
2848
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
2849
+ */
2850
+ date__le?: string | null;
2851
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
2852
+ /**
2853
+ * @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
2854
+ * @tags Company Market Data
2855
+ * @name GetCompanyMarketStatistics
2856
+ * @summary Get Company Market Statistics
2857
+ * @request GET:/companies/{company_id}/market-statistics
2858
+ * @secure
2859
+ */
2860
+ getCompanyMarketStatistics(companyId: number, query?: {
2861
+ /**
2862
+ * Trading Item Id
2863
+ * Specify a BW trading asset identifier for a targeted query.
2864
+ */
2865
+ trading_item_id?: number | null;
2866
+ /**
2867
+ * Identifier In
2868
+ * Specify a list of external identifiers.
2869
+ */
2870
+ identifier__in?: string | null;
2871
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
2872
+ /**
2873
+ * @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
2874
+ * @tags Company Market Data
2875
+ * @name GetTradingItems
2876
+ * @summary Get Trading Items
2877
+ * @request GET:/companies/{company_id}/trading-items
2878
+ * @secure
2879
+ */
2880
+ getTradingItems(companyId: number, query?: {
2881
+ /**
2882
+ * Primary Flag
2883
+ * Boolean flag. Indicate if only primary trading item data is required (true/false).
2884
+ */
2885
+ primary_flag?: BridgeWiseStringBooleanEnum;
2886
+ /**
2887
+ * Security Primary Flag
2888
+ * Boolean flag. Indicate if only primary asset data is required (true/false).
2889
+ */
2890
+ security_primary_flag?: BridgeWiseStringBooleanEnum;
2891
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
2892
+ }
2893
+ export class CompanyNews<HandleError extends boolean = boolean> {
2894
+ protected readonly apiClient: JwtClient<HandleError>;
2895
+ constructor(apiClient: JwtClient<HandleError>);
2896
+ /**
2897
+ * @description This endpoint provides news articles related to the specified company.
2898
+ * @tags Company News
2899
+ * @name GetCompanyNews
2900
+ * @summary Get Company News
2901
+ * @request GET:/companies/{company_id}/news
2902
+ * @secure
2903
+ */
2904
+ getCompanyNews(companyId: number, query?: {
2905
+ /**
2906
+ * Languages
2907
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2908
+ * @default "en-US"
2909
+ * @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
2910
+ */
2911
+ languages?: string;
2912
+ /**
2913
+ * Published Date Gte
2914
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2915
+ * @format date
2916
+ * @default "2025-02-10"
2917
+ */
2918
+ published_date__gte?: string;
2919
+ /**
2920
+ * Published Date Lte
2921
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2922
+ * @format date
2923
+ * @default "2025-02-10"
2924
+ */
2925
+ published_date__lte?: string;
2926
+ /**
2927
+ * Sort By
2928
+ * Specify the field by which to sort the results.
2929
+ * @default "publication_date"
2930
+ */
2931
+ sort_by?: BridgeWiseCompanyNewsSortingEnum;
2932
+ /**
2933
+ * Size
2934
+ * Define the number of records per page for pagination purposes.
2935
+ * @default 10
2936
+ * @example 10
2937
+ */
2938
+ size?: number;
2939
+ /**
2940
+ * Page
2941
+ * Define the page number for pagination.
2942
+ * @default 1
2943
+ * @example 1
2944
+ */
2945
+ page?: number;
2946
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
2947
+ /**
2948
+ * @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.
2949
+ * @tags Company News
2950
+ * @name GetAverageCompanyNewsSentiment
2951
+ * @summary Get Average Company News Sentiment
2952
+ * @request GET:/companies/{company_id}/news-sentiment
2953
+ * @secure
2954
+ */
2955
+ getAverageCompanyNewsSentiment(companyId: number, query?: {
2956
+ /**
2957
+ * Published Date Gte
2958
+ * Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
2959
+ * @format date
2960
+ * @default "2025-02-10"
2961
+ */
2962
+ published_date__gte?: string;
2963
+ /**
2964
+ * Published Date Lte
2965
+ * Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
2966
+ * @format date
2967
+ * @default "2025-02-10"
2968
+ */
2969
+ published_date__lte?: string;
2970
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
2971
+ }
2972
+ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
2973
+ protected readonly apiClient: JwtClient<HandleError>;
2974
+ constructor(apiClient: JwtClient<HandleError>);
2975
+ /**
2976
+ * @description This endpoint offers technical analysis of a company's stock price movements and trends.
2977
+ * @tags Technical Analysis
2978
+ * @name GetCompanyTechnicalParagraphs
2979
+ * @summary Get Company Technical Paragraphs
2980
+ * @request GET:/companies/{company_id}/technical-paragraphs
2981
+ * @secure
2982
+ */
2983
+ getCompanyTechnicalParagraphs(companyId: number, query?: {
2984
+ /**
2985
+ * Language
2986
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
2987
+ * @default "en-US"
2988
+ */
2989
+ language?: BridgeWiseLanguageEnum;
2990
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
2991
+ }
2992
+ export class Metadata<HandleError extends boolean = boolean> {
2993
+ protected readonly apiClient: JwtClient<HandleError>;
2994
+ constructor(apiClient: JwtClient<HandleError>);
2995
+ /**
2996
+ * @description This endpoint provides filters
2997
+ * @tags Metadata
2998
+ * @name GetCompanyFilters
2999
+ * @summary Get Company Filters
3000
+ * @request GET:/filters
3001
+ * @secure
3002
+ */
3003
+ getCompanyFilters(query: {
3004
+ /**
3005
+ * Type
3006
+ * Desired filter type.
3007
+ */
3008
+ type: BridgeWiseCompanyFilterType;
3009
+ /**
3010
+ * Language
3011
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3012
+ * @default "en-US"
3013
+ */
3014
+ language?: BridgeWiseLanguageEnum;
3015
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
3016
+ }
3017
+ export class FundMetadata<HandleError extends boolean = boolean> {
3018
+ protected readonly apiClient: JwtClient<HandleError>;
3019
+ constructor(apiClient: JwtClient<HandleError>);
3020
+ /**
3021
+ * @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
3022
+ * @tags Fund Metadata
3023
+ * @name GetFunds
3024
+ * @summary Get Funds
3025
+ * @request GET:/funds
3026
+ * @secure
3027
+ */
3028
+ getFunds(query?: {
3029
+ /**
3030
+ * Search
3031
+ * Funds search.
3032
+ */
3033
+ search?: string;
3034
+ /**
3035
+ * Peers Of
3036
+ * Get peers funds of a specific fund.
3037
+ */
3038
+ peers_of?: number;
3039
+ /**
3040
+ * Sort By
3041
+ * Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br>
3042
+ */
3043
+ sort_by?: string;
3044
+ /**
3045
+ * Language
3046
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3047
+ * @default "en-US"
3048
+ */
3049
+ language?: BridgeWiseLanguageEnum;
3050
+ /**
3051
+ * Sponsor Id
3052
+ * Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
3053
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3054
+ */
3055
+ sponsor_id?: string;
3056
+ /**
3057
+ * Vehicle Type
3058
+ * Desired vehicle type for the fund.
3059
+ */
3060
+ vehicle_type?: string;
3061
+ /**
3062
+ * Management Style Id
3063
+ * Comma-separated unique identifiers of the management style for the fund. <br>Example: 9617760,9617759</br>
3064
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3065
+ */
3066
+ management_style_id?: string;
3067
+ /**
3068
+ * Market Cap Emphasis Id
3069
+ * Comma-separated unique identifiers of market capitalization emphasis. <br>Example: 4072,4073</br>
3070
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3071
+ */
3072
+ market_cap_emphasis_id?: string;
3073
+ /**
3074
+ * Sector Emphasis Id
3075
+ * Comma-separated unique identifiers of sector emphasis <br>Example: 50,60</br>.
3076
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3077
+ */
3078
+ sector_emphasis_id?: string;
3079
+ /**
3080
+ * Geography Emphasis Id
3081
+ * Geography emphasis on sector for the fund. <br>Example: 30,37</br>
3082
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3083
+ */
3084
+ geography_emphasis_id?: string;
3085
+ /**
3086
+ * Exposure Id
3087
+ * Comma-separated unique exposure identifiers of the fund
3088
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3089
+ */
3090
+ exposure_id?: string;
3091
+ /**
3092
+ * Leverage
3093
+ * Comma-separated unique leverage values of the fund. <br>Example: -200,-100,100,125,200,300</br>
3094
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3095
+ */
3096
+ leverage?: string;
3097
+ /**
3098
+ * Leverage Not In
3099
+ * Comma-separated unique leverage values to exclude from the fund search results. <br>Example: -200,-100,100,125,200,300</br>
3100
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3101
+ */
3102
+ leverage__not_in?: string;
3103
+ /**
3104
+ * Market Benchmark Id
3105
+ * Comma-separated unique identifiers of market benchmark. <br>Example: 42892091,29102231</br>
3106
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3107
+ */
3108
+ market_benchmark_id?: string;
3109
+ /**
3110
+ * Primary Benchmark Id
3111
+ * Comma-separated unique identifiers of primary benchmark. <br>Example: 42892091,29102231</br>
3112
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3113
+ */
3114
+ primary_benchmark_id?: string;
3115
+ /**
3116
+ * Has Score
3117
+ * Indicates if the fund has a score.
3118
+ */
3119
+ has_score?: boolean;
3120
+ /**
3121
+ * Currency Market Id
3122
+ * Comma-separated unique currency market identifiers. <br>Example: 55,149</br>
3123
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3124
+ */
3125
+ currency_market_id?: string;
3126
+ /**
3127
+ * Exchange Id
3128
+ * Comma-separated unique identifiers of fund exchange. <br>Example: 104,106</br>
3129
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3130
+ */
3131
+ exchange_id?: string;
3132
+ /**
3133
+ * Pct Of Equity Holdings Gte
3134
+ * Percentage of equity holdings greater than or equal specific value.
3135
+ */
3136
+ pct_of_equity_holdings__gte?: string;
3137
+ /**
3138
+ * Pct Of Equity Holdings Lte
3139
+ * Percentage of equity holdings less than or equal specific value.
3140
+ */
3141
+ pct_of_equity_holdings__lte?: string;
3142
+ /**
3143
+ * Beta 1Y Gte
3144
+ * Beta greater than or equal specific value.
3145
+ */
3146
+ beta_1y__gte?: string;
3147
+ /**
3148
+ * Beta 1Y Lte
3149
+ * Beta less than or equal specific value.
3150
+ */
3151
+ beta_1y__lte?: string;
3152
+ /**
3153
+ * Tracking Error 1Y Gte
3154
+ * Tracking error greater than or equal to the specified value.
3155
+ */
3156
+ tracking_error_1y__gte?: string;
3157
+ /**
3158
+ * Tracking Error 1Y Lte
3159
+ * Tracking error less than or equal to the specified value.
3160
+ */
3161
+ tracking_error_1y__lte?: string;
3162
+ /**
3163
+ * Expense Ratio Gte
3164
+ * Expense ratio greater than a specific value.
3165
+ */
3166
+ expense_ratio__gte?: string;
3167
+ /**
3168
+ * Expense Ratio Lte
3169
+ * Expense ratio less than a specific value.
3170
+ */
3171
+ expense_ratio__lte?: string;
3172
+ /**
3173
+ * Avg Trading Volume 3M Gte
3174
+ * Average 3-month volume greater than or equal specific value.
3175
+ */
3176
+ avg_trading_volume_3m__gte?: string;
3177
+ /**
3178
+ * Avg Trading Volume 3M Lte
3179
+ * Average 3-month volume less than or equal specific value.
3180
+ */
3181
+ avg_trading_volume_3m__lte?: string;
3182
+ /**
3183
+ * Trading Volume Ratio Gte
3184
+ * Trading volume ratio greater than or equal specific value.
3185
+ */
3186
+ trading_volume_ratio__gte?: string;
3187
+ /**
3188
+ * Trading Volume Ratio Lte
3189
+ * Trading volume ratio less than or equal specific value.
3190
+ */
3191
+ trading_volume_ratio__lte?: string;
3192
+ /**
3193
+ * Largest Holding Gte
3194
+ * Largest holding weight is greater than or equal specific value.
3195
+ */
3196
+ largest_holding__gte?: string;
3197
+ /**
3198
+ * Largest Holding Lte
3199
+ * Largest holding weight is less than or equal specific value.
3200
+ */
3201
+ largest_holding__lte?: string;
3202
+ /**
3203
+ * Sharpe Ratio 1Y Gte
3204
+ * Sharpe ratio greater than or equal specific value.
3205
+ */
3206
+ sharpe_ratio_1y__gte?: string;
3207
+ /**
3208
+ * Sharpe Ratio 1Y Lte
3209
+ * Sharpe ratio less than or equal specific value.
3210
+ */
3211
+ sharpe_ratio_1y__lte?: string;
3212
+ /**
3213
+ * Alpha 1Y Gte
3214
+ * Alpha greater than or equal specific value.
3215
+ */
3216
+ alpha_1y__gte?: string;
3217
+ /**
3218
+ * Alpha 1Y Lte
3219
+ * Alpha less than or equal specific value.
3220
+ */
3221
+ alpha_1y__lte?: string;
3222
+ /**
3223
+ * Dividend Yield Gte
3224
+ * Dividend yield greater than or equal specific value.
3225
+ */
3226
+ dividend_yield__gte?: string;
3227
+ /**
3228
+ * Dividend Yield Lte
3229
+ * Dividend yield less than or equal specific value.
3230
+ */
3231
+ dividend_yield__lte?: string;
3232
+ /**
3233
+ * Aum Usd Gte
3234
+ * AUM greater than or equal specific value.
3235
+ */
3236
+ aum_usd__gte?: string;
3237
+ /**
3238
+ * Aum Usd Lte
3239
+ * AUM less than or equal specific value.
3240
+ */
3241
+ aum_usd__lte?: string;
3242
+ /**
3243
+ * Sponsor Aum Usd Gte
3244
+ * Sponsor AUM greater than or equal specific value.
3245
+ */
3246
+ sponsor_aum_usd__gte?: string;
3247
+ /**
3248
+ * Sponsor Aum Usd Lte
3249
+ * Sponsor AUM less than or equal specific value.
3250
+ */
3251
+ sponsor_aum_usd__lte?: string;
3252
+ /**
3253
+ * Analysis Fundamental Score Group
3254
+ * Comma-separated unique identifiers of analysis fundamental score group <br>Example: 1,2,3,4,5</br>
3255
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3256
+ */
3257
+ analysis_fundamental_score_group?: string;
3258
+ /**
3259
+ * Section Risk Score Group
3260
+ * Comma-separated unique identifiers of section risk factors group. <br>Example: 1,2,3,4,5</br>
3261
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3262
+ */
3263
+ section_risk_score_group?: string;
3264
+ /**
3265
+ * Section Portfolio Score Group
3266
+ * Comma-separated unique identifiers of section portfolio score group. <br>Example: 1,2,3,4,5</br>
3267
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3268
+ */
3269
+ section_portfolio_score_group?: string;
3270
+ /**
3271
+ * Section Performance Score Group
3272
+ * Comma-separated unique identifiers of key metrics score group. <br>Example: 1,2,3,4,5</br>
3273
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3274
+ */
3275
+ section_performance_score_group?: string;
3276
+ /**
3277
+ * Growth Factor Gte
3278
+ * Growth factor greater than or equal to a specific value.
3279
+ */
3280
+ growth_factor__gte?: string;
3281
+ /**
3282
+ * Growth Factor Lte
3283
+ * Growth factor less than or equal to a specific value.
3284
+ */
3285
+ growth_factor__lte?: string;
3286
+ /**
3287
+ * Value Factor Gte
3288
+ * Value factor greater than or equal to a specific value.
3289
+ */
3290
+ value_factor__gte?: string;
3291
+ /**
3292
+ * Value Factor Lte
3293
+ * Value factor less than or equal to a specific value.
3294
+ */
3295
+ value_factor__lte?: string;
3296
+ /**
3297
+ * Segment Strength Score Gte
3298
+ * Quarter rank greater than or equal to a specific value.
3299
+ */
3300
+ segment_strength_score__gte?: string;
3301
+ /**
3302
+ * Segment Strength Score Lte
3303
+ * Quarter rank less than or equal to a specific value.
3304
+ */
3305
+ segment_strength_score__lte?: string;
3306
+ /**
3307
+ * Cash Flow Factor Gte
3308
+ * Cash flow factor greater than or equal to a specific value.
3309
+ */
3310
+ cash_flow_factor__gte?: string;
3311
+ /**
3312
+ * Cash Flow Factor Lte
3313
+ * Cash flow factor less than or equal to a specific value.
3314
+ */
3315
+ cash_flow_factor__lte?: string;
3316
+ /**
3317
+ * Analysis Fundamental Score Gte
3318
+ * Analysis fundamental score greater than or equal to.
3319
+ */
3320
+ analysis_fundamental_score__gte?: number;
3321
+ /**
3322
+ * Analysis Fundamental Score Lte
3323
+ * Analysis fundamental score less than or equal to.
3324
+ */
3325
+ analysis_fundamental_score__lte?: number;
3326
+ /**
3327
+ * Section Portfolio Score Gte
3328
+ * Section portfolio score greater than or equal to.
3329
+ */
3330
+ section_portfolio_score__gte?: number;
3331
+ /**
3332
+ * Section Portfolio Score Lte
3333
+ * Section portfolio score less than or equal to.
3334
+ */
3335
+ section_portfolio_score__lte?: number;
3336
+ /**
3337
+ * Section Risk Score Gte
3338
+ * Section risk score greater than or equal to.
3339
+ */
3340
+ section_risk_score__gte?: number;
3341
+ /**
3342
+ * Section Risk Score Lte
3343
+ * Section risk score less than or equal to.
3344
+ */
3345
+ section_risk_score__lte?: number;
3346
+ /**
3347
+ * Section Performance Score Gte
3348
+ * Section performance score greater than or equal to.
3349
+ */
3350
+ section_performance_score__gte?: number;
3351
+ /**
3352
+ * Section Performance Score Lte
3353
+ * Section performance score less than or equal to.
3354
+ */
3355
+ section_performance_score__lte?: number;
3356
+ /**
3357
+ * Return Range Gte
3358
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3359
+ */
3360
+ return_range__gte?: string;
3361
+ /**
3362
+ * Return Value Gte
3363
+ * 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>
3364
+ */
3365
+ return_value__gte?: string;
3366
+ /**
3367
+ * Return Range Lte
3368
+ * Comma-separated list of return ranges <br>Example: 1D,5D,1M,6M,1Y,2Y,5Y,YTD</br>
3369
+ */
3370
+ return_range__lte?: string;
3371
+ /**
3372
+ * Return Value Lte
3373
+ * 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>
3374
+ */
3375
+ return_value__lte?: string;
3376
+ /**
3377
+ * Page
3378
+ * Define the page number for pagination.
3379
+ * @exclusiveMin 0
3380
+ * @default 1
3381
+ */
3382
+ page?: number;
3383
+ /**
3384
+ * Page Size
3385
+ * Define the number of records per page for pagination purposes.
3386
+ * @exclusiveMin 0
3387
+ * @default 100
3388
+ */
3389
+ page_size?: number;
3390
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsResponse, HandleError>>;
3391
+ /**
3392
+ * @description Retrieves the metadata object of a specific fund identified by the fund_id. It provides detailed information about the fund's characteristics.
3393
+ * @tags Fund Metadata
3394
+ * @name GetFund
3395
+ * @summary Get Fund
3396
+ * @request GET:/funds/{fund_id}
3397
+ * @secure
3398
+ */
3399
+ getFund(fundId: number, query?: {
3400
+ /**
3401
+ * Language
3402
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3403
+ * @default "en-US"
3404
+ */
3405
+ language?: BridgeWiseLanguageEnum;
3406
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
3407
+ }
3408
+ export class FundAnalysis<HandleError extends boolean = boolean> {
3409
+ protected readonly apiClient: JwtClient<HandleError>;
3410
+ constructor(apiClient: JwtClient<HandleError>);
3411
+ /**
3412
+ * @description Returns Bridgewise final analysis for a specified fund.
3413
+ * @tags Fund Analysis
3414
+ * @name GetFundAnalysis
3415
+ * @summary Get Fund Analysis
3416
+ * @request GET:/funds/{fund_id}/analysis
3417
+ * @secure
3418
+ */
3419
+ getFundAnalysis(fundId: number, query?: {
3420
+ /**
3421
+ * Language
3422
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3423
+ * @default "en-US"
3424
+ */
3425
+ language?: BridgeWiseLanguageEnum;
3426
+ /**
3427
+ * Year
3428
+ * Specify the year for which the analysis is requested.
3429
+ */
3430
+ year?: number;
3431
+ /**
3432
+ * Quarter
3433
+ * Specify the quarter for which the analysis is requested.
3434
+ */
3435
+ quarter?: number;
3436
+ /**
3437
+ * Show All
3438
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3439
+ */
3440
+ show_all?: boolean;
3441
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
3442
+ /**
3443
+ * @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.
3444
+ * @tags Fund Analysis
3445
+ * @name GetFundsParagraphs
3446
+ * @summary Get Funds Paragraphs
3447
+ * @request GET:/funds/{fund_id}/paragraphs
3448
+ * @secure
3449
+ */
3450
+ getFundsParagraphs(fundId: number, query?: {
3451
+ /**
3452
+ * Language
3453
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3454
+ * @default "en-US"
3455
+ */
3456
+ language?: BridgeWiseLanguageEnum;
3457
+ /**
3458
+ * Year
3459
+ * Specify the year for which the analysis is requested.
3460
+ */
3461
+ year?: number | null;
3462
+ /**
3463
+ * Quarter
3464
+ * Specify the quarter for which the analysis is requested.
3465
+ */
3466
+ quarter?: number | null;
3467
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
3468
+ /**
3469
+ * @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.
3470
+ * @tags Fund Analysis
3471
+ * @name GetFundParameters
3472
+ * @summary Get Fund Parameters
3473
+ * @request GET:/funds/{fund_id}/parameters
3474
+ * @secure
3475
+ */
3476
+ getFundParameters(fundId: number, query?: {
3477
+ /**
3478
+ * Language
3479
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3480
+ * @default "en-US"
3481
+ */
3482
+ language?: BridgeWiseLanguageEnum;
3483
+ /**
3484
+ * Parameter Id
3485
+ * ID of the parameter for analysis.
3486
+ */
3487
+ parameter_id?: number;
3488
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
3489
+ /**
3490
+ * @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.
3491
+ * @tags Fund Analysis
3492
+ * @name GetFundSections
3493
+ * @summary Get Fund Sections
3494
+ * @request GET:/funds/{fund_id}/sections
3495
+ * @secure
3496
+ */
3497
+ getFundSections(fundId: number, query?: {
3498
+ /**
3499
+ * Year
3500
+ * Specify the year for which the analysis is requested.
3501
+ */
3502
+ year?: number;
3503
+ /**
3504
+ * Quarter
3505
+ * Specify the quarter for which the analysis is requested.
3506
+ */
3507
+ quarter?: number;
3508
+ /**
3509
+ * Language
3510
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3511
+ * @default "en-US"
3512
+ */
3513
+ language?: BridgeWiseLanguageEnum;
3514
+ /**
3515
+ * Show All
3516
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
3517
+ */
3518
+ show_all?: boolean;
3519
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
3520
+ }
3521
+ export class Holdings<HandleError extends boolean = boolean> {
3522
+ protected readonly apiClient: JwtClient<HandleError>;
3523
+ constructor(apiClient: JwtClient<HandleError>);
3524
+ /**
3525
+ * @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.
3526
+ * @tags Holdings
3527
+ * @name GetCompositions
3528
+ * @summary Get Compositions
3529
+ * @request GET:/funds/{fund_id}/compositions
3530
+ * @secure
3531
+ */
3532
+ getCompositions(fundId: number, query?: {
3533
+ /**
3534
+ * Language
3535
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3536
+ * @default "en-US"
3537
+ */
3538
+ language?: BridgeWiseLanguageEnum;
3539
+ /**
3540
+ * Composition Type
3541
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
3542
+ */
3543
+ composition_type?: BridgeWiseCompositionTypeEnum;
3544
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
3545
+ /**
3546
+ * @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
3547
+ * @tags Holdings
3548
+ * @name GetHoldingStatistics
3549
+ * @summary Get Holding Statistics
3550
+ * @request GET:/funds/{fund_id}/holding-statistics
3551
+ * @secure
3552
+ */
3553
+ getHoldingStatistics(fundId: number, query?: {
3554
+ /**
3555
+ * Language
3556
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3557
+ * @default "en-US"
3558
+ */
3559
+ language?: BridgeWiseLanguageEnum;
3560
+ /**
3561
+ * Composition Type
3562
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
3563
+ * @default "stocks"
3564
+ */
3565
+ composition_type?: BridgeWiseCompositionTypeEnum;
3566
+ /**
3567
+ * Page
3568
+ * Define the page number for pagination.
3569
+ * @exclusiveMin 0
3570
+ */
3571
+ page?: number;
3572
+ /**
3573
+ * Page Size
3574
+ * Define the number of records per page for pagination purposes.
3575
+ * @exclusiveMin 0
3576
+ */
3577
+ page_size?: number;
3578
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
3579
+ /**
3580
+ * @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.
3581
+ * @tags Holdings
3582
+ * @name GetHoldings
3583
+ * @summary Get Holdings
3584
+ * @request GET:/funds/{fund_id}/holdings
3585
+ * @secure
3586
+ */
3587
+ getHoldings(fundId: number, query?: {
3588
+ /**
3589
+ * Language
3590
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3591
+ * @default "en-US"
3592
+ */
3593
+ language?: BridgeWiseLanguageEnum;
3594
+ /**
3595
+ * Composition Type
3596
+ * Filter data by specific components of the fund composition (e.g., stocks, others).
3597
+ * @default "stocks"
3598
+ */
3599
+ composition_type?: BridgeWiseCompositionTypeEnum;
3600
+ /**
3601
+ * Page
3602
+ * Define the page number for pagination.
3603
+ * @exclusiveMin 0
3604
+ */
3605
+ page?: number;
3606
+ /**
3607
+ * Page Size
3608
+ * Define the number of records per page for pagination purposes.
3609
+ * @exclusiveMin 0
3610
+ */
3611
+ page_size?: number;
3612
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
3613
+ }
3614
+ export class FundMarketData<HandleError extends boolean = boolean> {
3615
+ protected readonly apiClient: JwtClient<HandleError>;
3616
+ constructor(apiClient: JwtClient<HandleError>);
3617
+ /**
3618
+ * @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
3619
+ * @tags Fund Market Data
3620
+ * @name GetFundsMarketData
3621
+ * @summary Get Funds Market Data
3622
+ * @request GET:/funds/{fund_id}/market
3623
+ * @secure
3624
+ */
3625
+ getFundsMarketData(fundId: number, query?: {
3626
+ /**
3627
+ * Trading Item Id
3628
+ * Specify a BW trading asset identifier for a targeted query.
3629
+ */
3630
+ trading_item_id?: number | null;
3631
+ /**
3632
+ * Date Ge
3633
+ * Specify the minimum date for data retrieval in YYYY-MM-DD format.
3634
+ */
3635
+ date__ge?: string | null;
3636
+ /**
3637
+ * Date Le
3638
+ * Specify the maximum date for data retrieval in YYYY-MM-DD format.
3639
+ */
3640
+ date__le?: string | null;
3641
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
3642
+ /**
3643
+ * @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.
3644
+ * @tags Fund Market Data
3645
+ * @name GetFundsMarketStatistics
3646
+ * @summary Get Funds Market Statistics
3647
+ * @request GET:/funds/{fund_id}/market-statistics
3648
+ * @secure
3649
+ */
3650
+ getFundsMarketStatistics(fundId: number, query?: {
3651
+ /**
3652
+ * Trading Item Id
3653
+ * Specify a BW trading asset identifier for a targeted query.
3654
+ */
3655
+ trading_item_id?: number | null;
3656
+ /**
3657
+ * Identifier In
3658
+ * Specify a list of external identifiers.
3659
+ */
3660
+ identifier__in?: string | null;
3661
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
3662
+ }
3663
+ export class Segmentations<HandleError extends boolean = boolean> {
3664
+ protected readonly apiClient: JwtClient<HandleError>;
3665
+ constructor(apiClient: JwtClient<HandleError>);
3666
+ /**
3667
+ * @description Provides key financial metrics for each segment within the specified fund, such as weighted averages of P/E ratio, P/B ratio, P/S ratio, Net Debt to EBITDA, Revenue Growth Rate, and Relative Market Value. It also includes the Weighted Average Segment Strength based on Bridgewise scores.
3668
+ * @tags Segmentations
3669
+ * @name GetSegmentParameters
3670
+ * @summary Get Segment Parameters
3671
+ * @request GET:/funds/{fund_id}/segment-parameters
3672
+ * @secure
3673
+ */
3674
+ getSegmentParameters(fundId: number, query?: {
3675
+ /**
3676
+ * Language
3677
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3678
+ * @default "en-US"
3679
+ */
3680
+ language?: BridgeWiseLanguageEnum;
3681
+ /**
3682
+ * Segment
3683
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
3684
+ */
3685
+ segment?: string;
3686
+ /**
3687
+ * Segment Type
3688
+ * Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
3689
+ */
3690
+ segment_type?: string;
3691
+ /**
3692
+ * Parameter Type
3693
+ * Desired segment parameter type.
3694
+ */
3695
+ parameter_type?: BridgeWiseFundsSegmentParameterEnum;
3696
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
3697
+ /**
3698
+ * @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
3699
+ * @tags Segmentations
3700
+ * @name GetSegment
3701
+ * @summary Get Segment
3702
+ * @request GET:/funds/{fund_id}/segments
3703
+ * @secure
3704
+ */
3705
+ getSegment(fundId: number, query?: {
3706
+ /**
3707
+ * Language
3708
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3709
+ * @default "en-US"
3710
+ */
3711
+ language?: BridgeWiseLanguageEnum;
3712
+ /**
3713
+ * Segment
3714
+ * Filter data by specific segments within the fund holdings (e.g., sector, region).
3715
+ */
3716
+ segment?: string;
3717
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
3718
+ }
3719
+ export class Tenants<HandleError extends boolean = boolean> {
3720
+ protected readonly apiClient: JwtClient<HandleError>;
3721
+ constructor(apiClient: JwtClient<HandleError>);
3722
+ /**
3723
+ * @tags Tenants
3724
+ * @name FetchTenant
3725
+ * @summary Fetch Tenant
3726
+ * @request GET:/tenants/{tenant_id}
3727
+ * @secure
3728
+ */
3729
+ fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
3730
+ /**
3731
+ * @tags Tenants
3732
+ * @name GetHistoricalPolicyChanges
3733
+ * @summary Get Historical Policy Changes
3734
+ * @request GET:/tenants/{tenant_id}/historical-policy-changes
3735
+ * @secure
3736
+ */
3737
+ getHistoricalPolicyChanges(tenantId: string, query?: {
3738
+ /**
3739
+ * Company Ids
3740
+ * Specify a list of BW identifiers for bulk queries.
3741
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3742
+ * @example "74822,83343211"
3743
+ */
3744
+ company_ids?: string;
3745
+ /**
3746
+ * Start Date Gte
3747
+ * Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
3748
+ * @format date
3749
+ */
3750
+ start_date__gte?: string;
3751
+ /**
3752
+ * End Date Lte
3753
+ * Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
3754
+ * @format date
3755
+ */
3756
+ end_date__lte?: string;
3757
+ /**
3758
+ * Current Value
3759
+ * Specify the current value reflecting the policy change
3760
+ */
3761
+ current_value?: number | boolean;
3762
+ /**
3763
+ * Event Type
3764
+ * Type of event that is being requested.
3765
+ */
3766
+ event_type?: BridgeWiseEventTypeEnum;
3767
+ /**
3768
+ * Size
3769
+ * Define the maximum number of results to retrieve.
3770
+ * @default 10
3771
+ * @example 10
3772
+ */
3773
+ size?: number;
3774
+ /**
3775
+ * Page
3776
+ * Define the page number for the results.
3777
+ * @default 1
3778
+ * @example 1
3779
+ */
3780
+ page?: number;
3781
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
3782
+ /**
3783
+ * @tags Tenants
3784
+ * @name CreateTenantInvestmentPoliciesConfig
3785
+ * @summary Create Tenant Investment Policies Config
3786
+ * @request POST:/tenants/{tenant_id}/investment-policies-config
3787
+ * @secure
3788
+ */
3789
+ createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
3790
+ /**
3791
+ * @tags Tenants
3792
+ * @name ListTenantInvestmentPoliciesConfigs
3793
+ * @summary List Tenant Investment Policies Configs
3794
+ * @request GET:/tenants/{tenant_id}/investment-policies-config
3795
+ * @secure
3796
+ */
3797
+ listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
3798
+ /**
3799
+ * @tags Tenants
3800
+ * @name CreateTenantInvestmentPoliciesConfigBulk
3801
+ * @summary Create Tenant Investment Policies Config Bulk
3802
+ * @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
3803
+ * @secure
3804
+ */
3805
+ createTenantInvestmentPoliciesConfigBulk(tenantId: string, data: BridgeWiseInvestmentPolicyConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
3806
+ /**
3807
+ * @tags Tenants
3808
+ * @name GetTenantInvestmentPoliciesConfig
3809
+ * @summary Get Tenant Investment Policies Config
3810
+ * @request GET:/tenants/{tenant_id}/investment-policies-config/{config_id}
3811
+ * @secure
3812
+ */
3813
+ getTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
3814
+ /**
3815
+ * @tags Tenants
3816
+ * @name PatchTenantInvestmentPoliciesConfig
3817
+ * @summary Patch Tenant Investment Policies Config
3818
+ * @request PATCH:/tenants/{tenant_id}/investment-policies-config/{config_id}
3819
+ * @secure
3820
+ */
3821
+ patchTenantInvestmentPoliciesConfig(configId: number, tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
3822
+ /**
3823
+ * @tags Tenants
3824
+ * @name DeleteTenantInvestmentPoliciesConfig
3825
+ * @summary Delete Tenant Investment Policies Config
3826
+ * @request DELETE:/tenants/{tenant_id}/investment-policies-config/{config_id}
3827
+ * @secure
3828
+ */
3829
+ deleteTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
3830
+ /**
3831
+ * @tags Tenants
3832
+ * @name CreateCognitoClientApplication
3833
+ * @summary Create Cognito Client Application
3834
+ * @request POST:/tenants/{tenant_id}/machine
3835
+ * @secure
3836
+ */
3837
+ createCognitoClientApplication(tenantId: string, data: BridgeWiseCreateTenantApp, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantApp, HandleError>>;
3838
+ /**
3839
+ * @tags Tenants
3840
+ * @name GetRecommendations
3841
+ * @summary Get Recommendations
3842
+ * @request GET:/tenants/{tenant_id}/recommendations
3843
+ * @secure
3844
+ */
3845
+ getRecommendations(tenantId: string, query: {
3846
+ /**
3847
+ * Company Ids
3848
+ * Specify a list of BW identifiers for bulk queries.
3849
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
3850
+ * @example "74822,83343211"
3851
+ */
3852
+ company_ids: string;
3853
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendation[], HandleError>>;
3854
+ /**
3855
+ * @tags Tenants
3856
+ * @name CreateTenantRecommendationsConfig
3857
+ * @summary Create Tenant Recommendations Config
3858
+ * @request POST:/tenants/{tenant_id}/recommendations-config
3859
+ * @secure
3860
+ */
3861
+ createTenantRecommendationsConfig(tenantId: string, data: BridgeWiseRecommendationConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
3862
+ /**
3863
+ * @tags Tenants
3864
+ * @name CreateTenantRecommendationsConfigBulk
3865
+ * @summary Create Tenant Recommendations Config Bulk
3866
+ * @request POST:/tenants/{tenant_id}/recommendations-config/bulk
3867
+ * @secure
3868
+ */
3869
+ createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
3870
+ /**
3871
+ * @tags Tenants
3872
+ * @name GetTenantRecommendationsConfig
3873
+ * @summary Get Tenant Recommendations Config
3874
+ * @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
3875
+ * @secure
3876
+ */
3877
+ getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
3878
+ /**
3879
+ * @tags Tenants
3880
+ * @name PatchTenantRecommendationsConfig
3881
+ * @summary Patch Tenant Recommendations Config
3882
+ * @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
3883
+ * @secure
3884
+ */
3885
+ patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
3886
+ /**
3887
+ * @tags Tenants
3888
+ * @name DeleteTenantRecommendationsConfig
3889
+ * @summary Delete Tenant Recommendations Config
3890
+ * @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
3891
+ * @secure
3892
+ */
3893
+ deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
3894
+ }
3895
+ export class Users<HandleError extends boolean = boolean> {
3896
+ protected readonly apiClient: JwtClient<HandleError>;
3897
+ constructor(apiClient: JwtClient<HandleError>);
3898
+ /**
3899
+ * @tags Users
3900
+ * @name Authenticate
3901
+ * @summary Authenticate
3902
+ * @request POST:/users/authenticate
3903
+ * @secure
3904
+ */
3905
+ authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
3906
+ /**
3907
+ * @tags Users
3908
+ * @name FetchClientDetails
3909
+ * @summary Fetch Client Details
3910
+ * @request GET:/users/machine
3911
+ * @secure
3912
+ */
3913
+ fetchClientDetails(headers: {
3914
+ /** Authorization */
3915
+ authorization: string;
3916
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
3917
+ }
3918
+ export class EarningCalls<HandleError extends boolean = boolean> {
3919
+ protected readonly apiClient: JwtClient<HandleError>;
3920
+ constructor(apiClient: JwtClient<HandleError>);
3921
+ /**
3922
+ * @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
3923
+ * @tags Earning Calls
3924
+ * @name GetCompanyEarningsCalls
3925
+ * @summary Get Company Earnings Calls
3926
+ * @request GET:/companies/{company_id}/earnings-call
3927
+ * @secure
3928
+ */
3929
+ getCompanyEarningsCalls(companyId: number, query?: {
3930
+ /**
3931
+ * Language
3932
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3933
+ * @default "en-US"
3934
+ */
3935
+ language?: BridgeWiseLanguageEnum;
3936
+ /**
3937
+ * Year
3938
+ * Specify the year for which the analysis is requested.
3939
+ */
3940
+ year?: number | null;
3941
+ /**
3942
+ * Quarter
3943
+ * Specify the quarter for which the analysis is requested.
3944
+ */
3945
+ quarter?: number | null;
3946
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
3947
+ /**
3948
+ * @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
3949
+ * @tags Earning Calls
3950
+ * @name GetEarningsCallsRecaps
3951
+ * @summary Get Earnings Calls Recaps
3952
+ * @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
3953
+ * @secure
3954
+ */
3955
+ getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
3956
+ /**
3957
+ * Language
3958
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3959
+ * @default "en-US"
3960
+ */
3961
+ language?: BridgeWiseLanguageEnum;
3962
+ /**
3963
+ * Type
3964
+ * Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
3965
+ */
3966
+ type?: BridgeWiseEarningsCallRecapEnum;
3967
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
3968
+ }
3969
+ export class Activities<HandleError extends boolean = boolean> {
3970
+ protected readonly apiClient: JwtClient<HandleError>;
3971
+ constructor(apiClient: JwtClient<HandleError>);
3972
+ /**
3973
+ * @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
3974
+ * @tags Activities
3975
+ * @name GetCompanyAlerts
3976
+ * @summary Get Company Alerts
3977
+ * @request GET:/companies/{company_id}/alerts
3978
+ * @secure
3979
+ */
3980
+ getCompanyAlerts(companyId: number, query?: {
3981
+ /**
3982
+ * Language
3983
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
3984
+ * @default "en-US"
3985
+ */
3986
+ language?: BridgeWiseLanguageEnum;
3987
+ /**
3988
+ * Alert Type
3989
+ * Specify the group of the alert type that will be presented (fundamental or market).
3990
+ */
3991
+ alert_type?: BridgeWiseCompanyAlertType;
3992
+ /**
3993
+ * Sentiment
3994
+ * Filter alerts by their sentiment.
3995
+ */
3996
+ sentiment?: BridgeWiseCompanyAlertSentiment;
3997
+ /**
3998
+ * Importance
3999
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
4000
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4001
+ */
4002
+ importance?: string;
4003
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
4004
+ /**
4005
+ * @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
4006
+ * @tags Activities
4007
+ * @name GetCompanyForecastsKeyDevelopment
4008
+ * @summary Get Company Forecasts Key Development
4009
+ * @request GET:/companies/{company_id}/key-developments
4010
+ * @secure
4011
+ */
4012
+ getCompanyForecastsKeyDevelopment(companyId: number, query?: {
4013
+ /**
4014
+ * Language
4015
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4016
+ * @default "en-US"
4017
+ */
4018
+ language?: BridgeWiseLanguageEnum;
4019
+ /**
4020
+ * Importance
4021
+ * Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
4022
+ * @default "0,1"
4023
+ * @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
4024
+ */
4025
+ importance?: string;
4026
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
4027
+ }
4028
+ export class EsgAnalysis<HandleError extends boolean = boolean> {
4029
+ protected readonly apiClient: JwtClient<HandleError>;
4030
+ constructor(apiClient: JwtClient<HandleError>);
4031
+ /**
4032
+ * @description Returns Bridgewise's comprehensive ESG (Environmental, Social, and Governance) analysis for a specified company, evaluating its sustainability practices and impact.
4033
+ * @tags ESG Analysis
4034
+ * @name GetCompanyEsgAnalysis
4035
+ * @summary Get Company Esg Analysis
4036
+ * @request GET:/companies/{company_id}/esg-analysis
4037
+ * @secure
4038
+ */
4039
+ getCompanyEsgAnalysis(companyId: number, query?: {
4040
+ /**
4041
+ * Language
4042
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4043
+ * @default "en-US"
4044
+ */
4045
+ language?: BridgeWiseLanguageEnum;
4046
+ /**
4047
+ * Show All
4048
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4049
+ */
4050
+ show_all?: boolean;
4051
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResponse, HandleError>>;
4052
+ /**
4053
+ * @description This endpoint delivers in-depth textual evaluations of a company's environmental, social, and governance (ESG) practices.
4054
+ * @tags ESG Analysis
4055
+ * @name GetCompanyEsgParagraphs
4056
+ * @summary Get Company Esg Paragraphs
4057
+ * @request GET:/companies/{company_id}/esg-paragraphs
4058
+ * @secure
4059
+ */
4060
+ getCompanyEsgParagraphs(companyId: number, query?: {
4061
+ /**
4062
+ * Language
4063
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4064
+ * @default "en-US"
4065
+ */
4066
+ language?: BridgeWiseLanguageEnum;
4067
+ /**
4068
+ * Section Type
4069
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
4070
+ */
4071
+ section_type?: BridgeWiseESGSectionTypeEnum;
4072
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
4073
+ /**
4074
+ * @description Breaks down the specific parameters used in the ESG analysis, including environmental metrics, social factors, and corporate governance indicators.
4075
+ * @tags ESG Analysis
4076
+ * @name GetCompanyEsgParameters
4077
+ * @summary Get Company Esg Parameters
4078
+ * @request GET:/companies/{company_id}/esg-parameters
4079
+ * @secure
4080
+ */
4081
+ getCompanyEsgParameters(companyId: number, query?: {
4082
+ /**
4083
+ * Language
4084
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4085
+ * @default "en-US"
4086
+ */
4087
+ language?: BridgeWiseLanguageEnum;
4088
+ /**
4089
+ * Parameter Id
4090
+ * Get desired parameter by ID.
4091
+ */
4092
+ parameter_id?: number;
4093
+ /**
4094
+ * Section Type
4095
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
4096
+ */
4097
+ section_type?: BridgeWiseSectionTypeEnum;
4098
+ /**
4099
+ * Show All
4100
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4101
+ */
4102
+ show_all?: boolean;
4103
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseESGParameterListV2, HandleError>>;
4104
+ /**
4105
+ * @description Provides scores for the different sections of the ESG analysis, such as environmental impact, social responsibility, and governance practices.
4106
+ * @tags ESG Analysis
4107
+ * @name GetCompanyEsgSections
4108
+ * @summary Get Company Esg Sections
4109
+ * @request GET:/companies/{company_id}/esg-sections
4110
+ * @secure
4111
+ */
4112
+ getCompanyEsgSections(companyId: number, query?: {
4113
+ /**
4114
+ * Language
4115
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4116
+ * @default "en-US"
4117
+ */
4118
+ language?: BridgeWiseLanguageEnum;
4119
+ /**
4120
+ * Section Type
4121
+ * Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
4122
+ */
4123
+ section_type?: BridgeWiseESGSectionTypeEnum;
4124
+ /**
4125
+ * Show All
4126
+ * Boolean flag. Indicate whether to return historical data (`true/false`).
4127
+ */
4128
+ show_all?: boolean;
4129
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectionsResponse, HandleError>>;
4130
+ /**
4131
+ * @description This endpoint provides access to a collection of external events, such as news articles, corporate announcements, and other relevant occurrences, that have the potential to impact a company's stock performance. Bridgewise enhances the utility of this information by including a sentiment analysis for each listed event, determining its likely positive or negative impact on the stock.
4132
+ * @tags ESG Analysis
4133
+ * @name GetCompanyForecastsMsa
4134
+ * @summary Get Company Forecasts Msa
4135
+ * @request GET:/companies/{company_id}/sustainability-incidents
4136
+ * @secure
4137
+ */
4138
+ getCompanyForecastsMsa(companyId: number, query?: {
4139
+ /**
4140
+ * Language
4141
+ * Define the language code (e.g., `'en-US'` for English) for the textual data output.
4142
+ * @default "en-US"
4143
+ */
4144
+ language?: BridgeWiseLanguageEnum;
4145
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEmptyModelList | BridgeWiseMSAForecastV2[], HandleError>>;
4146
+ }
4147
+ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4148
+ readonly config: JwtClientConfig<HandleError>;
4149
+ activities: Activities<HandleError>;
4150
+ companyMarketData: CompanyMarketData<HandleError>;
4151
+ companyMetadata: CompanyMetadata<HandleError>;
4152
+ companyNews: CompanyNews<HandleError>;
4153
+ earningCalls: EarningCalls<HandleError>;
4154
+ esgAnalysis: EsgAnalysis<HandleError>;
4155
+ fundamentalAnalysis: FundamentalAnalysis<HandleError>;
4156
+ fundAnalysis: FundAnalysis<HandleError>;
4157
+ fundMarketData: FundMarketData<HandleError>;
4158
+ holdings: Holdings<HandleError>;
4159
+ logos: Logos<HandleError>;
4160
+ metadata: Metadata<HandleError>;
4161
+ segmentations: Segmentations<HandleError>;
4162
+ technicalAnalysis: TechnicalAnalysis<HandleError>;
4163
+ constructor(config: JwtClientConfig<HandleError>);
4164
+ }
4165
+
4166
+ //# sourceMappingURL=index.d.ts.map