@orbis-systems/orbis-api-clients 0.7.7 → 0.7.9
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.
- package/dist/aesmidas/index.d.ts +257 -28
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +1777 -367
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +335 -299
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +34 -34
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +78 -78
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +351 -349
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +91 -91
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -77,6 +77,475 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
77
77
|
setRenewTokenCallback(renewTokenCallback: () => Promise<AuthData>): void;
|
|
78
78
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
79
|
}
|
|
80
|
+
export interface BridgeWiseExportResponse {
|
|
81
|
+
results: BridgeWiseExportRow[];
|
|
82
|
+
}
|
|
83
|
+
export interface BridgeWiseExportRow {
|
|
84
|
+
/** @format date-time */
|
|
85
|
+
timestamp: string;
|
|
86
|
+
tenant_id: string;
|
|
87
|
+
question_id: string;
|
|
88
|
+
user_id: string;
|
|
89
|
+
session_id: string;
|
|
90
|
+
client_id: string;
|
|
91
|
+
question: string;
|
|
92
|
+
answer: string;
|
|
93
|
+
feedback_type: string;
|
|
94
|
+
feedback_reason: string;
|
|
95
|
+
answer_requested_by_user: boolean;
|
|
96
|
+
}
|
|
97
|
+
export interface BridgeWiseExternalQuestionRequest {
|
|
98
|
+
/** @maxLength 2000 */
|
|
99
|
+
message: string;
|
|
100
|
+
/** @maxLength 256 */
|
|
101
|
+
session_id: string;
|
|
102
|
+
/** @maxLength 256 */
|
|
103
|
+
language: string;
|
|
104
|
+
}
|
|
105
|
+
export interface BridgeWiseExternalQuestionResponse {
|
|
106
|
+
message: string;
|
|
107
|
+
message_id: string;
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* AnalysisResultV2
|
|
111
|
+
* Represents a paragraph in the analysis response.
|
|
112
|
+
* Attributes:
|
|
113
|
+
* section_type (str): The type of section the paragraph belongs to.
|
|
114
|
+
* paragraph_type (str): The type of paragraph.
|
|
115
|
+
* paragraph (str): The content of the paragraph.
|
|
116
|
+
*/
|
|
117
|
+
export interface BridgeWiseAnalysisResultV2 {
|
|
118
|
+
/** Section Type */
|
|
119
|
+
section_type: string;
|
|
120
|
+
/** Paragraph Type */
|
|
121
|
+
paragraph_type: string;
|
|
122
|
+
/** Paragraph */
|
|
123
|
+
paragraph: string;
|
|
124
|
+
}
|
|
125
|
+
/**
|
|
126
|
+
* BalanceSheet
|
|
127
|
+
* Represents a balance sheet.
|
|
128
|
+
*
|
|
129
|
+
* Attributes:
|
|
130
|
+
* identifier (str): The identifier of the financial data.
|
|
131
|
+
* company_id (str): The identifier of the company.
|
|
132
|
+
* calendar_year (int): The calendar year.
|
|
133
|
+
* calendar_quarter (int): The calendar quarter.
|
|
134
|
+
* filing_date (str): The filing date of the report.
|
|
135
|
+
* language (str): The language of the report.
|
|
136
|
+
* analysis (str): The analysis of the balance sheet.
|
|
137
|
+
*/
|
|
138
|
+
export interface BridgeWiseBalanceSheet {
|
|
139
|
+
/** Identifier */
|
|
140
|
+
identifier: string;
|
|
141
|
+
/** Company Id */
|
|
142
|
+
company_id: string;
|
|
143
|
+
/** Calendar Year */
|
|
144
|
+
calendar_year: number;
|
|
145
|
+
/** Calendar Quarter */
|
|
146
|
+
calendar_quarter: number;
|
|
147
|
+
/** Filing Date */
|
|
148
|
+
filing_date: string;
|
|
149
|
+
/** Language */
|
|
150
|
+
language: string;
|
|
151
|
+
/** Analysis */
|
|
152
|
+
analysis: string;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* BusinessDescription
|
|
156
|
+
* Pydantic model representing business description information.
|
|
157
|
+
*
|
|
158
|
+
* Args:
|
|
159
|
+
* identifier (str): The unique identifier of the company.
|
|
160
|
+
* company_id (str): The company ID.
|
|
161
|
+
* description (str): The business description of the company.
|
|
162
|
+
*/
|
|
163
|
+
export interface BridgeWiseBusinessDescription {
|
|
164
|
+
/** Identifier */
|
|
165
|
+
identifier: string;
|
|
166
|
+
/** Company Id */
|
|
167
|
+
company_id: string;
|
|
168
|
+
/** Description */
|
|
169
|
+
description: string;
|
|
170
|
+
}
|
|
171
|
+
/**
|
|
172
|
+
* BusinessDescriptionResultV2
|
|
173
|
+
* Pydantic model representing the result of business description
|
|
174
|
+
* information version 2 API.
|
|
175
|
+
* Args:
|
|
176
|
+
* data (List[BusinessDescription]): A list of business descriptions.
|
|
177
|
+
*/
|
|
178
|
+
export interface BridgeWiseBusinessDescriptionResultV2 {
|
|
179
|
+
/** Data */
|
|
180
|
+
data: BridgeWiseBusinessDescription[];
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* CashFlow
|
|
184
|
+
* Represents a cash flow statement.
|
|
185
|
+
*
|
|
186
|
+
* Attributes:
|
|
187
|
+
* identifier (str): The identifier of the financial data.
|
|
188
|
+
* company_id (str): The identifier of the company.
|
|
189
|
+
* calendar_year (int): The calendar year.
|
|
190
|
+
* calendar_quarter (int): The calendar quarter.
|
|
191
|
+
* filing_date (str): The filing date of the report.
|
|
192
|
+
* language (str): The language of the report.
|
|
193
|
+
* analysis (str): The analysis of the cash flow statement.
|
|
194
|
+
*/
|
|
195
|
+
export interface BridgeWiseCashFlow {
|
|
196
|
+
/** Identifier */
|
|
197
|
+
identifier: string;
|
|
198
|
+
/** Company Id */
|
|
199
|
+
company_id: string;
|
|
200
|
+
/** Calendar Year */
|
|
201
|
+
calendar_year: number;
|
|
202
|
+
/** Calendar Quarter */
|
|
203
|
+
calendar_quarter: number;
|
|
204
|
+
/** Filing Date */
|
|
205
|
+
filing_date: string;
|
|
206
|
+
/** Language */
|
|
207
|
+
language: string;
|
|
208
|
+
/** Analysis */
|
|
209
|
+
analysis: string;
|
|
210
|
+
}
|
|
211
|
+
/**
|
|
212
|
+
* FundamentalAnalysis
|
|
213
|
+
* Represents a fundamental analysis including summaries, balance sheets, income statements, and cash flow statements.
|
|
214
|
+
*
|
|
215
|
+
* Attributes:
|
|
216
|
+
* summary (Optional[List[Summary]]): List of financial data summaries.
|
|
217
|
+
* balance_sheet (Optional[List[BalanceSheet]]): List of balance sheets.
|
|
218
|
+
* income_statement (Optional[List[IncomeStatement]]): List of income statements.
|
|
219
|
+
* cash_flow (Optional[List[CashFlow]]): List of cash flow statements.
|
|
220
|
+
*/
|
|
221
|
+
export interface BridgeWiseFundamentalAnalysis {
|
|
222
|
+
/** Summary */
|
|
223
|
+
summary?: BridgeWisepreparationSdkBwcModelsSummary[] | null;
|
|
224
|
+
/** Balance Sheet */
|
|
225
|
+
balance_sheet?: BridgeWiseBalanceSheet[] | null;
|
|
226
|
+
/** Income Statement */
|
|
227
|
+
income_statement?: BridgeWiseIncomeStatement[] | null;
|
|
228
|
+
/** Cash Flow */
|
|
229
|
+
cash_flow?: BridgeWiseCashFlow[] | null;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* FundamentalAnalysisResultV2
|
|
233
|
+
* Represents the fundamentals response model.
|
|
234
|
+
*
|
|
235
|
+
* Attributes:
|
|
236
|
+
* data (List[FundamentalAnalysis]): A list of FundamentalAnalysis objects representing fundamental analysis responses.
|
|
237
|
+
*/
|
|
238
|
+
export interface BridgeWiseFundamentalAnalysisResultV2 {
|
|
239
|
+
/**
|
|
240
|
+
* Represents a fundamental analysis including summaries, balance sheets, income statements, and cash flow statements.
|
|
241
|
+
*
|
|
242
|
+
* Attributes:
|
|
243
|
+
* summary (Optional[List[Summary]]): List of financial data summaries.
|
|
244
|
+
* balance_sheet (Optional[List[BalanceSheet]]): List of balance sheets.
|
|
245
|
+
* income_statement (Optional[List[IncomeStatement]]): List of income statements.
|
|
246
|
+
* cash_flow (Optional[List[CashFlow]]): List of cash flow statements.
|
|
247
|
+
*/
|
|
248
|
+
data: BridgeWiseFundamentalAnalysis;
|
|
249
|
+
}
|
|
250
|
+
/** HTTPValidationError */
|
|
251
|
+
export interface BridgeWiseHTTPValidationError {
|
|
252
|
+
/** Detail */
|
|
253
|
+
detail?: BridgeWiseValidationError[];
|
|
254
|
+
}
|
|
255
|
+
/**
|
|
256
|
+
* IncomeStatement
|
|
257
|
+
* Represents an income statement.
|
|
258
|
+
*
|
|
259
|
+
* Attributes:
|
|
260
|
+
* identifier (str): The identifier of the financial data.
|
|
261
|
+
* company_id (str): The identifier of the company.
|
|
262
|
+
* calendar_year (int): The calendar year.
|
|
263
|
+
* calendar_quarter (int): The calendar quarter.
|
|
264
|
+
* filing_date (str): The filing date of the report.
|
|
265
|
+
* language (str): The language of the report.
|
|
266
|
+
* analysis (str): The analysis of the income statement.
|
|
267
|
+
*/
|
|
268
|
+
export interface BridgeWiseIncomeStatement {
|
|
269
|
+
/** Identifier */
|
|
270
|
+
identifier: string;
|
|
271
|
+
/** Company Id */
|
|
272
|
+
company_id: string;
|
|
273
|
+
/** Calendar Year */
|
|
274
|
+
calendar_year: number;
|
|
275
|
+
/** Calendar Quarter */
|
|
276
|
+
calendar_quarter: number;
|
|
277
|
+
/** Filing Date */
|
|
278
|
+
filing_date: string;
|
|
279
|
+
/** Language */
|
|
280
|
+
language: string;
|
|
281
|
+
/** Analysis */
|
|
282
|
+
analysis: string;
|
|
283
|
+
}
|
|
284
|
+
/**
|
|
285
|
+
* Indicator
|
|
286
|
+
* Pydantic model representing trading indicators.
|
|
287
|
+
*
|
|
288
|
+
* Attributes:
|
|
289
|
+
* identifier (str): The unique identifier of the trading item.
|
|
290
|
+
* trading_item_id (str): The trading item ID.
|
|
291
|
+
* date (int): The date of the data.
|
|
292
|
+
* high (float): The high value.
|
|
293
|
+
* low (float): The low value.
|
|
294
|
+
* close (float): The closing value.
|
|
295
|
+
* support (float): The support value.
|
|
296
|
+
* resistance (float): The resistance value.
|
|
297
|
+
* moving_average_5d (float): The 5-day moving average.
|
|
298
|
+
* moving_average_50d (float): The 50-day moving average.
|
|
299
|
+
* moving_average_200d (float): The 200-day moving average.
|
|
300
|
+
* moving_average_convergence_divergence (float): The moving average
|
|
301
|
+
* convergence divergence value.
|
|
302
|
+
* relative_strength_index (float): The relative strength index value.
|
|
303
|
+
* stochastic_oscillator (float): The stochastic oscillator value.
|
|
304
|
+
* currency_iso3 (str): The currency ISO3 code.
|
|
305
|
+
* technical_indicator (float): The technical indicator value.
|
|
306
|
+
*/
|
|
307
|
+
export interface BridgeWiseIndicator {
|
|
308
|
+
/** Identifier */
|
|
309
|
+
identifier: string;
|
|
310
|
+
/** Trading Item Id */
|
|
311
|
+
trading_item_id: string;
|
|
312
|
+
/** Date */
|
|
313
|
+
date: number;
|
|
314
|
+
/** High */
|
|
315
|
+
high: number;
|
|
316
|
+
/** Low */
|
|
317
|
+
low: number;
|
|
318
|
+
/** Close */
|
|
319
|
+
close: number;
|
|
320
|
+
/** Support */
|
|
321
|
+
support: number;
|
|
322
|
+
/** Resistance */
|
|
323
|
+
resistance: number;
|
|
324
|
+
/** Moving Average 5D */
|
|
325
|
+
moving_average_5d: number;
|
|
326
|
+
/** Moving Average 50D */
|
|
327
|
+
moving_average_50d: number;
|
|
328
|
+
/** Moving Average 200D */
|
|
329
|
+
moving_average_200d: number;
|
|
330
|
+
/** Moving Average Convergence Divergence */
|
|
331
|
+
moving_average_convergence_divergence: number;
|
|
332
|
+
/** Relative Strength Index */
|
|
333
|
+
relative_strength_index: number;
|
|
334
|
+
/** Stochastic Oscillator */
|
|
335
|
+
stochastic_oscillator: number;
|
|
336
|
+
/** Currency Iso3 */
|
|
337
|
+
currency_iso3: string;
|
|
338
|
+
/** Technical Indicator */
|
|
339
|
+
technical_indicator: number;
|
|
340
|
+
}
|
|
341
|
+
/**
|
|
342
|
+
* IndustryDescription
|
|
343
|
+
* Pydantic model representing industry description information.
|
|
344
|
+
*
|
|
345
|
+
* Attributes:
|
|
346
|
+
* identifier (str): The unique identifier of the company.
|
|
347
|
+
* company_id (str): The company ID.
|
|
348
|
+
* calendar_year (int): The calendar year.
|
|
349
|
+
* calendar_quarter (int): The calendar quarter.
|
|
350
|
+
* filing_date (int): The filing date.
|
|
351
|
+
* description (str): The description of the industry.
|
|
352
|
+
*/
|
|
353
|
+
export interface BridgeWiseIndustryDescription {
|
|
354
|
+
/** Identifier */
|
|
355
|
+
identifier: string;
|
|
356
|
+
/** Company Id */
|
|
357
|
+
company_id: string;
|
|
358
|
+
/** Calendar Year */
|
|
359
|
+
calendar_year: number;
|
|
360
|
+
/** Calendar Quarter */
|
|
361
|
+
calendar_quarter: number;
|
|
362
|
+
/** Filing Date */
|
|
363
|
+
filing_date: number;
|
|
364
|
+
/** Description */
|
|
365
|
+
description: string;
|
|
366
|
+
}
|
|
367
|
+
/**
|
|
368
|
+
* IndustryDescriptionResultV2
|
|
369
|
+
* Pydantic model representing the result of industry description query.
|
|
370
|
+
*
|
|
371
|
+
* Attributes:
|
|
372
|
+
* data (List[IndustryDescription]): List of industry description data.
|
|
373
|
+
*/
|
|
374
|
+
export interface BridgeWiseIndustryDescriptionResultV2 {
|
|
375
|
+
/** Data */
|
|
376
|
+
data: BridgeWiseIndustryDescription[];
|
|
377
|
+
}
|
|
378
|
+
/** LanguageEnum */
|
|
379
|
+
export enum BridgeWiseLanguageEnum {
|
|
380
|
+
ArSA = "ar-SA",
|
|
381
|
+
DeDE = "de-DE",
|
|
382
|
+
EnUS = "en-US",
|
|
383
|
+
EsES = "es-ES",
|
|
384
|
+
FrFR = "fr-FR",
|
|
385
|
+
HeIL = "he-IL",
|
|
386
|
+
NlNL = "nl-NL",
|
|
387
|
+
PtBR = "pt-BR",
|
|
388
|
+
TrTR = "tr-TR",
|
|
389
|
+
ZhCN = "zh-CN",
|
|
390
|
+
JaJP = "ja-JP",
|
|
391
|
+
KoKR = "ko-KR",
|
|
392
|
+
ThTH = "th-TH",
|
|
393
|
+
ZhHK = "zh-HK"
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* Sentiment
|
|
397
|
+
* Pydantic model representing trading sentiments.
|
|
398
|
+
*
|
|
399
|
+
* Attributes:
|
|
400
|
+
* identifier (str): The unique identifier of the trading item.
|
|
401
|
+
* trading_item_id (str): The trading item ID.
|
|
402
|
+
* date (int): The date of the data.
|
|
403
|
+
* direction (str): The direction of sentiment.
|
|
404
|
+
* moving_average_5d (str): The sentiment of 5-day moving average.
|
|
405
|
+
* moving_average_50d (str): The sentiment of 50-day moving average.
|
|
406
|
+
* moving_average_200d (str): The sentiment of 200-day moving average.
|
|
407
|
+
* moving_average_convergence_divergence (str): The sentiment of
|
|
408
|
+
* moving average convergence divergence.
|
|
409
|
+
* relative_strength_index (str): The sentiment of relative strength index.
|
|
410
|
+
* stochastic_oscillator (str): The sentiment of stochastic oscillator.
|
|
411
|
+
* technical_sentiment (str): The overall technical sentiment.
|
|
412
|
+
*/
|
|
413
|
+
export interface BridgeWiseSentiment {
|
|
414
|
+
/** Identifier */
|
|
415
|
+
identifier: string;
|
|
416
|
+
/** Trading Item Id */
|
|
417
|
+
trading_item_id: string;
|
|
418
|
+
/** Date */
|
|
419
|
+
date: number;
|
|
420
|
+
/** Direction */
|
|
421
|
+
direction: string;
|
|
422
|
+
/** Moving Average 5D */
|
|
423
|
+
moving_average_5d: string;
|
|
424
|
+
/** Moving Average 50D */
|
|
425
|
+
moving_average_50d: string;
|
|
426
|
+
/** Moving Average 200D */
|
|
427
|
+
moving_average_200d: string;
|
|
428
|
+
/** Moving Average Convergence Divergence */
|
|
429
|
+
moving_average_convergence_divergence: string;
|
|
430
|
+
/** Relative Strength Index */
|
|
431
|
+
relative_strength_index: string;
|
|
432
|
+
/** Stochastic Oscillator */
|
|
433
|
+
stochastic_oscillator: string;
|
|
434
|
+
/** Technical Sentiment */
|
|
435
|
+
technical_sentiment: string;
|
|
436
|
+
}
|
|
437
|
+
/** StringBooleanEnum */
|
|
438
|
+
export enum BridgeWiseStringBooleanEnum {
|
|
439
|
+
True = "true",
|
|
440
|
+
False = "false"
|
|
441
|
+
}
|
|
442
|
+
/**
|
|
443
|
+
* TechnicalAnalysis
|
|
444
|
+
* Pydantic model representing trading data.
|
|
445
|
+
*
|
|
446
|
+
* Attributes:
|
|
447
|
+
* indicators (List[Indicator]): List of trading indicators.
|
|
448
|
+
* sentiments (List[Sentiment]): List of trading sentiments.
|
|
449
|
+
* summary (List[Summary]): List of trading summaries.
|
|
450
|
+
*/
|
|
451
|
+
export interface BridgeWiseTechnicalAnalysis {
|
|
452
|
+
/** Indicators */
|
|
453
|
+
indicators: BridgeWiseIndicator[];
|
|
454
|
+
/** Sentiments */
|
|
455
|
+
sentiments: BridgeWiseSentiment[];
|
|
456
|
+
/** Summary */
|
|
457
|
+
summary: BridgeWisemodelsSummary[];
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* TechnicalAnalysisResultV2
|
|
461
|
+
* Pydantic model representing the result of technical analysis version 2 API.
|
|
462
|
+
*
|
|
463
|
+
* Attributes:
|
|
464
|
+
* data TechnicalAnalysis: List of technical analysis data.
|
|
465
|
+
*/
|
|
466
|
+
export interface BridgeWiseTechnicalAnalysisResultV2 {
|
|
467
|
+
/**
|
|
468
|
+
* Pydantic model representing trading data.
|
|
469
|
+
*
|
|
470
|
+
* Attributes:
|
|
471
|
+
* indicators (List[Indicator]): List of trading indicators.
|
|
472
|
+
* sentiments (List[Sentiment]): List of trading sentiments.
|
|
473
|
+
* summary (List[Summary]): List of trading summaries.
|
|
474
|
+
*/
|
|
475
|
+
data: BridgeWiseTechnicalAnalysis;
|
|
476
|
+
}
|
|
477
|
+
/** ValidationError */
|
|
478
|
+
export interface BridgeWiseValidationError {
|
|
479
|
+
/** Location */
|
|
480
|
+
loc: (string | number)[];
|
|
481
|
+
/** Message */
|
|
482
|
+
msg: string;
|
|
483
|
+
/** Error Type */
|
|
484
|
+
type: string;
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* VerifyCompanyResultV2
|
|
488
|
+
* Pydantic model representing the result of verify company version 2 API.
|
|
489
|
+
*
|
|
490
|
+
* Attributes:
|
|
491
|
+
* exists (bool): Whether the company exists.
|
|
492
|
+
*/
|
|
493
|
+
export interface BridgeWiseVerifyCompanyResultV2 {
|
|
494
|
+
/** Exists */
|
|
495
|
+
exists: boolean;
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* Summary
|
|
499
|
+
* Pydantic model representing trading summaries.
|
|
500
|
+
*
|
|
501
|
+
* Attributes:
|
|
502
|
+
* identifier (str): The unique identifier of the trading item.
|
|
503
|
+
* trading_item_id (str): The trading item ID.
|
|
504
|
+
* date (int): The date of the data.
|
|
505
|
+
* language (str): The language of the analysis.
|
|
506
|
+
* analysis (str): The analysis summary.
|
|
507
|
+
*/
|
|
508
|
+
export interface BridgeWisemodelsSummary {
|
|
509
|
+
/** Identifier */
|
|
510
|
+
identifier: string;
|
|
511
|
+
/** Trading Item Id */
|
|
512
|
+
trading_item_id: string;
|
|
513
|
+
/** Date */
|
|
514
|
+
date: number;
|
|
515
|
+
/** Language */
|
|
516
|
+
language: string;
|
|
517
|
+
/** Analysis */
|
|
518
|
+
analysis: string;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Summary
|
|
522
|
+
* Represents a summary of financial data.
|
|
523
|
+
*
|
|
524
|
+
* Attributes:
|
|
525
|
+
* identifier (str): The identifier of the financial data.
|
|
526
|
+
* company_id (str): The identifier of the company.
|
|
527
|
+
* calendar_year (int): The calendar year.
|
|
528
|
+
* calendar_quarter (int): The calendar quarter.
|
|
529
|
+
* filing_date (str): The filing date of the report.
|
|
530
|
+
* language (str): The language of the report.
|
|
531
|
+
* analysis (str): The analysis of the financial data.
|
|
532
|
+
*/
|
|
533
|
+
export interface BridgeWisepreparationSdkBwcModelsSummary {
|
|
534
|
+
/** Identifier */
|
|
535
|
+
identifier: string;
|
|
536
|
+
/** Company Id */
|
|
537
|
+
company_id: string;
|
|
538
|
+
/** Calendar Year */
|
|
539
|
+
calendar_year: number;
|
|
540
|
+
/** Calendar Quarter */
|
|
541
|
+
calendar_quarter: number;
|
|
542
|
+
/** Filing Date */
|
|
543
|
+
filing_date: string;
|
|
544
|
+
/** Language */
|
|
545
|
+
language: string;
|
|
546
|
+
/** Analysis */
|
|
547
|
+
analysis: string;
|
|
548
|
+
}
|
|
80
549
|
/** BadRequest */
|
|
81
550
|
export interface BridgeWiseBadRequest {
|
|
82
551
|
/** Detail */
|
|
@@ -241,28 +710,6 @@ export enum BridgeWiseForecastType {
|
|
|
241
710
|
KeyDevelopments = "key_developments",
|
|
242
711
|
News = "news"
|
|
243
712
|
}
|
|
244
|
-
/** HTTPValidationError */
|
|
245
|
-
export interface BridgeWiseHTTPValidationError {
|
|
246
|
-
/** Detail */
|
|
247
|
-
detail?: BridgeWiseValidationError[];
|
|
248
|
-
}
|
|
249
|
-
/** LanguageEnum */
|
|
250
|
-
export enum BridgeWiseLanguageEnum {
|
|
251
|
-
ArSA = "ar-SA",
|
|
252
|
-
DeDE = "de-DE",
|
|
253
|
-
EnUS = "en-US",
|
|
254
|
-
EsES = "es-ES",
|
|
255
|
-
FrFR = "fr-FR",
|
|
256
|
-
HeIL = "he-IL",
|
|
257
|
-
NlNL = "nl-NL",
|
|
258
|
-
PtBR = "pt-BR",
|
|
259
|
-
TrTR = "tr-TR",
|
|
260
|
-
ZhCN = "zh-CN",
|
|
261
|
-
JaJP = "ja-JP",
|
|
262
|
-
KoKR = "ko-KR",
|
|
263
|
-
ThTH = "th-TH",
|
|
264
|
-
ZhHK = "zh-HK"
|
|
265
|
-
}
|
|
266
713
|
/** MSAForecastV2 */
|
|
267
714
|
export interface BridgeWiseMSAForecastV2 {
|
|
268
715
|
/**
|
|
@@ -299,15 +746,6 @@ export interface BridgeWiseNotFound {
|
|
|
299
746
|
*/
|
|
300
747
|
message?: string;
|
|
301
748
|
}
|
|
302
|
-
/** ValidationError */
|
|
303
|
-
export interface BridgeWiseValidationError {
|
|
304
|
-
/** Location */
|
|
305
|
-
loc: (string | number)[];
|
|
306
|
-
/** Message */
|
|
307
|
-
msg: string;
|
|
308
|
-
/** Error Type */
|
|
309
|
-
type: string;
|
|
310
|
-
}
|
|
311
749
|
/** MarketDataList */
|
|
312
750
|
export type BridgeWiseMarketDataList = BridgeWisepreparationSdkModelsMarketData[];
|
|
313
751
|
/** MarketList */
|
|
@@ -440,6 +878,151 @@ export interface BridgeWiseCompaniesResponse {
|
|
|
440
878
|
/** Total Count */
|
|
441
879
|
total_count: number;
|
|
442
880
|
}
|
|
881
|
+
/** CompaniesSortByEnum */
|
|
882
|
+
export enum BridgeWiseCompaniesSortByEnum {
|
|
883
|
+
ValueAnalysisEsgScore = "-analysis_esg_score",
|
|
884
|
+
ValueAnalysisEsgScoreGroup = "-analysis_esg_score_group",
|
|
885
|
+
ValueAnalysisFundamentalScore = "-analysis_fundamental_score",
|
|
886
|
+
ValueAnalysisFundamentalScoreGroup = "-analysis_fundamental_score_group",
|
|
887
|
+
ValueAssetTurnover = "-asset_turnover",
|
|
888
|
+
ValueAverageRevenuePerSubscriber = "-average_revenue_per_subscriber",
|
|
889
|
+
ValueBeta1Year = "-beta_1_year",
|
|
890
|
+
ValueBeta1Year1 = "-beta_1_year",
|
|
891
|
+
ValueBeta1Y = "-beta_1y",
|
|
892
|
+
ValuePeRatio = "-pe_ratio",
|
|
893
|
+
ValueCurrentRatio = "-current_ratio",
|
|
894
|
+
ValueDividendYield = "-dividend_yield",
|
|
895
|
+
ValueDividendYieldPercentage = "-dividend_yield_percentage",
|
|
896
|
+
ValueEbitInterestExpense = "-ebit_interest_expense",
|
|
897
|
+
ValueEbitdaMarginPercentage = "-ebitda_margin_percentage",
|
|
898
|
+
ValueEquityUnderManagement = "-equity_under_management",
|
|
899
|
+
ValueExpenseRatio = "-expense_ratio",
|
|
900
|
+
ValueFilingDate = "-filing_date",
|
|
901
|
+
ValueFilingDate2 = "-filing_date",
|
|
902
|
+
ValueFreeCashFlowShare = "-free_cash_flow_share",
|
|
903
|
+
ValueGicsSectorId = "-gics_sector_id",
|
|
904
|
+
ValueGrossProfitMarginPercentage = "-gross_profit_margin_percentage",
|
|
905
|
+
ValueImpliedMarketCap = "-implied_market_cap",
|
|
906
|
+
ValueLastCloseMarketCapUsd = "-last_close_market_cap_usd",
|
|
907
|
+
ValuePbRatio = "-pb_ratio",
|
|
908
|
+
ValueLastCloseTevEbitda = "-last_close_tev_ebitda",
|
|
909
|
+
ValueLongTermDebtTotalCapital = "-long_term_debt_total_capital",
|
|
910
|
+
ValueNetDebtToEbitda = "-net_debt_to_ebitda",
|
|
911
|
+
ValueTotalDebtEquity = "-total_debt_equity",
|
|
912
|
+
ValueNetEpsBasic = "-net_eps_basic",
|
|
913
|
+
ValueNetEpsDiluted = "-net_eps_diluted",
|
|
914
|
+
ValueNetIncomeMarginPercentage = "-net_income_margin_percentage",
|
|
915
|
+
ValueOperatingCashFlowToCurrentLiabilities = "-operating_cash_flow_to_current_liabilities",
|
|
916
|
+
ValuePayoutRatio = "-payout_ratio",
|
|
917
|
+
ValuePctOfEquityHoldings = "-pct_of_equity_holdings",
|
|
918
|
+
ValuePeRatio3 = "-pe_ratio",
|
|
919
|
+
ValuePeriodLastPriceBookValue = "-period_last_price_book_value",
|
|
920
|
+
ValuePriceCurrencyIso3 = "-price_currency_iso3",
|
|
921
|
+
ValueQuickRatio = "-quick_ratio",
|
|
922
|
+
ValueReturn1D = "-return_1d",
|
|
923
|
+
ValueReturn1M = "-return_1m",
|
|
924
|
+
ValueReturn1Y = "-return_1y",
|
|
925
|
+
ValueReturn2Y = "-return_2y",
|
|
926
|
+
ValueReturn5D = "-return_5d",
|
|
927
|
+
ValueReturn5Y = "-return_5y",
|
|
928
|
+
ValueReturn6M = "-return_6m",
|
|
929
|
+
ValueReturnYtd = "-return_ytd",
|
|
930
|
+
ValueReturnOnAssets = "-return_on_assets",
|
|
931
|
+
ValueReturnOnEquityPercentage = "-return_on_equity_percentage",
|
|
932
|
+
ValueReturnOnTotalCapital = "-return_on_total_capital",
|
|
933
|
+
ValueRevenuePerEmployeeInThousands = "-revenue_per_employee_in_thousands",
|
|
934
|
+
ValueSectionBalanceSheetScore = "-section_balance_sheet_score",
|
|
935
|
+
ValueSectionBalanceSheetScoreGroup = "-section_balance_sheet_score_group",
|
|
936
|
+
ValueSectionCashFlowScore = "-section_cash_flow_score",
|
|
937
|
+
ValueSectionCashFlowScoreGroup = "-section_cash_flow_score_group",
|
|
938
|
+
ValueSectionEnvironmentalScore = "-section_environmental_score",
|
|
939
|
+
ValueSectionEnvironmentalScoreGroup = "-section_environmental_score_group",
|
|
940
|
+
ValueSectionGovernanceScore = "-section_governance_score",
|
|
941
|
+
ValueSectionGovernanceScoreGroup = "-section_governance_score_group",
|
|
942
|
+
ValueSectionIncomeStatementScore = "-section_income_statement_score",
|
|
943
|
+
ValueSectionIncomeStatementScoreGroup = "-section_income_statement_score_group",
|
|
944
|
+
ValueSectionRiskFactorsGroup = "-section_risk_factors_group",
|
|
945
|
+
ValueSectionSocialScore = "-section_social_score",
|
|
946
|
+
ValueSectionSocialScoreGroup = "-section_social_score_group",
|
|
947
|
+
ValueSectorScore = "-sector_score",
|
|
948
|
+
ValueSectorScoreGroup = "-sector_score_group",
|
|
949
|
+
ValueSharpeRatio1Y = "-sharpe_ratio_1y",
|
|
950
|
+
ValueTotalDebtToCapitalPercentage = "-total_debt_to_capital_percentage",
|
|
951
|
+
ValueTotalDebtEquity4 = "-total_debt_equity",
|
|
952
|
+
ValueTotalRevenues = "-total_revenues",
|
|
953
|
+
ValueTotalRevenues1YearGrowthPercentage = "-total_revenues_1_year_growth_percentage",
|
|
954
|
+
AnalysisEsgScore = "analysis_esg_score",
|
|
955
|
+
AnalysisEsgScoreGroup = "analysis_esg_score_group",
|
|
956
|
+
AnalysisFundamentalScore = "analysis_fundamental_score",
|
|
957
|
+
AnalysisFundamentalScoreGroup = "analysis_fundamental_score_group",
|
|
958
|
+
AssetTurnover = "asset_turnover",
|
|
959
|
+
AverageRevenuePerSubscriber = "average_revenue_per_subscriber",
|
|
960
|
+
Beta1Year = "beta_1_year",
|
|
961
|
+
Beta1Year5 = "beta_1_year",
|
|
962
|
+
Beta1Y = "beta_1y",
|
|
963
|
+
PeRatio = "pe_ratio",
|
|
964
|
+
CurrentRatio = "current_ratio",
|
|
965
|
+
DividendYield = "dividend_yield",
|
|
966
|
+
DividendYieldPercentage = "dividend_yield_percentage",
|
|
967
|
+
EbitInterestExpense = "ebit_interest_expense",
|
|
968
|
+
EbitdaMarginPercentage = "ebitda_margin_percentage",
|
|
969
|
+
EquityUnderManagement = "equity_under_management",
|
|
970
|
+
ExpenseRatio = "expense_ratio",
|
|
971
|
+
FilingDate = "filing_date",
|
|
972
|
+
FilingDate6 = "filing_date",
|
|
973
|
+
FreeCashFlowShare = "free_cash_flow_share",
|
|
974
|
+
GicsSectorId = "gics_sector_id",
|
|
975
|
+
GrossProfitMarginPercentage = "gross_profit_margin_percentage",
|
|
976
|
+
ImpliedMarketCap = "implied_market_cap",
|
|
977
|
+
LastCloseMarketCapUsd = "last_close_market_cap_usd",
|
|
978
|
+
PbRatio = "pb_ratio",
|
|
979
|
+
LastCloseTevEbitda = "last_close_tev_ebitda",
|
|
980
|
+
LongTermDebtTotalCapital = "long_term_debt_total_capital",
|
|
981
|
+
NetDebtToEbitda = "net_debt_to_ebitda",
|
|
982
|
+
TotalDebtEquity = "total_debt_equity",
|
|
983
|
+
NetEpsBasic = "net_eps_basic",
|
|
984
|
+
NetEpsDiluted = "net_eps_diluted",
|
|
985
|
+
NetIncomeMarginPercentage = "net_income_margin_percentage",
|
|
986
|
+
OperatingCashFlowToCurrentLiabilities = "operating_cash_flow_to_current_liabilities",
|
|
987
|
+
PayoutRatio = "payout_ratio",
|
|
988
|
+
PctOfEquityHoldings = "pct_of_equity_holdings",
|
|
989
|
+
PeRatio7 = "pe_ratio",
|
|
990
|
+
PeriodLastPriceBookValue = "period_last_price_book_value",
|
|
991
|
+
PriceCurrencyIso3 = "price_currency_iso3",
|
|
992
|
+
QuickRatio = "quick_ratio",
|
|
993
|
+
Return1D = "return_1d",
|
|
994
|
+
Return1M = "return_1m",
|
|
995
|
+
Return1Y = "return_1y",
|
|
996
|
+
Return2Y = "return_2y",
|
|
997
|
+
Return5D = "return_5d",
|
|
998
|
+
Return5Y = "return_5y",
|
|
999
|
+
Return6M = "return_6m",
|
|
1000
|
+
ReturnYtd = "return_ytd",
|
|
1001
|
+
ReturnOnAssets = "return_on_assets",
|
|
1002
|
+
ReturnOnEquityPercentage = "return_on_equity_percentage",
|
|
1003
|
+
ReturnOnTotalCapital = "return_on_total_capital",
|
|
1004
|
+
RevenuePerEmployeeInThousands = "revenue_per_employee_in_thousands",
|
|
1005
|
+
SectionBalanceSheetScore = "section_balance_sheet_score",
|
|
1006
|
+
SectionBalanceSheetScoreGroup = "section_balance_sheet_score_group",
|
|
1007
|
+
SectionCashFlowScore = "section_cash_flow_score",
|
|
1008
|
+
SectionCashFlowScoreGroup = "section_cash_flow_score_group",
|
|
1009
|
+
SectionEnvironmentalScore = "section_environmental_score",
|
|
1010
|
+
SectionEnvironmentalScoreGroup = "section_environmental_score_group",
|
|
1011
|
+
SectionGovernanceScore = "section_governance_score",
|
|
1012
|
+
SectionGovernanceScoreGroup = "section_governance_score_group",
|
|
1013
|
+
SectionIncomeStatementScore = "section_income_statement_score",
|
|
1014
|
+
SectionIncomeStatementScoreGroup = "section_income_statement_score_group",
|
|
1015
|
+
SectionRiskFactorsGroup = "section_risk_factors_group",
|
|
1016
|
+
SectionSocialScore = "section_social_score",
|
|
1017
|
+
SectionSocialScoreGroup = "section_social_score_group",
|
|
1018
|
+
SectorScore = "sector_score",
|
|
1019
|
+
SectorScoreGroup = "sector_score_group",
|
|
1020
|
+
SharpeRatio1Y = "sharpe_ratio_1y",
|
|
1021
|
+
TotalDebtToCapitalPercentage = "total_debt_to_capital_percentage",
|
|
1022
|
+
TotalDebtEquity8 = "total_debt_equity",
|
|
1023
|
+
TotalRevenues = "total_revenues",
|
|
1024
|
+
TotalRevenues1YearGrowthPercentage = "total_revenues_1_year_growth_percentage"
|
|
1025
|
+
}
|
|
443
1026
|
/** CompanyData */
|
|
444
1027
|
export interface BridgeWiseCompanyData {
|
|
445
1028
|
/** Language */
|
|
@@ -677,7 +1260,7 @@ export interface BridgeWiseFundsCompositionItem {
|
|
|
677
1260
|
/** Composition Type */
|
|
678
1261
|
composition_type: string;
|
|
679
1262
|
/** Weight */
|
|
680
|
-
weight:
|
|
1263
|
+
weight: string;
|
|
681
1264
|
/** Is Direct Holding */
|
|
682
1265
|
is_direct_holding: boolean;
|
|
683
1266
|
/** Disclaimer */
|
|
@@ -692,6 +1275,103 @@ export interface BridgeWiseFundsResponse {
|
|
|
692
1275
|
/** Total Count */
|
|
693
1276
|
total_count: number;
|
|
694
1277
|
}
|
|
1278
|
+
/** FundsSortByEnum */
|
|
1279
|
+
export enum BridgeWiseFundsSortByEnum {
|
|
1280
|
+
ValueAlpha1Y = "-alpha_1y",
|
|
1281
|
+
ValueAnalysisFundamentalScore = "-analysis_fundamental_score",
|
|
1282
|
+
ValueAnalysisFundamentalScoreGroup = "-analysis_fundamental_score_group",
|
|
1283
|
+
ValueReturn52W = "-return_52w",
|
|
1284
|
+
ValueAum = "-aum",
|
|
1285
|
+
ValueAvgTradingVolume3M = "-avg_trading_volume_3m",
|
|
1286
|
+
ValueBeta1Y = "-beta_1y",
|
|
1287
|
+
ValueCashFlowFactor = "-cash_flow_factor",
|
|
1288
|
+
ValueCashFlowFactorGroup = "-cash_flow_factor_group",
|
|
1289
|
+
ValueDividendYield = "-dividend_yield",
|
|
1290
|
+
ValueDividendYieldPercentage = "-dividend_yield_percentage",
|
|
1291
|
+
ValueEquityUnderManagement = "-equity_under_management",
|
|
1292
|
+
ValueExpenseRatio = "-expense_ratio",
|
|
1293
|
+
ValueFilingDate = "-filing_date",
|
|
1294
|
+
ValueGrowthFactor = "-growth_factor",
|
|
1295
|
+
ValueGrowthFactorGroup = "-growth_factor_group",
|
|
1296
|
+
ValueLargestHolding = "-largest_holding",
|
|
1297
|
+
ValueLastCloseMarketCapUsd = "-last_close_market_cap_usd",
|
|
1298
|
+
ValueMarketBenchmarkId = "-market_benchmark_id",
|
|
1299
|
+
ValueConcentration = "-concentration",
|
|
1300
|
+
ValuePctOfEquityHoldings = "-pct_of_equity_holdings",
|
|
1301
|
+
ValuePriceCurrencyIso3 = "-price_currency_iso3",
|
|
1302
|
+
ValueBenchmarkId = "-benchmark_id",
|
|
1303
|
+
ValueReturn1D = "-return_1d",
|
|
1304
|
+
ValueReturn1M = "-return_1m",
|
|
1305
|
+
ValueReturn1Y = "-return_1y",
|
|
1306
|
+
ValueReturn2Y = "-return_2y",
|
|
1307
|
+
ValueReturn5D = "-return_5d",
|
|
1308
|
+
ValueReturn5Y = "-return_5y",
|
|
1309
|
+
ValueReturn6M = "-return_6m",
|
|
1310
|
+
ValueReturnYtd = "-return_ytd",
|
|
1311
|
+
ValueSectionHoldingsGroup = "-section_holdings_group",
|
|
1312
|
+
ValueSectionMgmtMetricGroup = "-section_mgmt_metric_group",
|
|
1313
|
+
ValueSectionPerformanceScore = "-section_performance_score",
|
|
1314
|
+
ValueSectionPerformanceScoreGroup = "-section_performance_score_group",
|
|
1315
|
+
ValueSectionPortfolioScore = "-section_portfolio_score",
|
|
1316
|
+
ValueSectionPortfolioScoreGroup = "-section_portfolio_score_group",
|
|
1317
|
+
ValueSectionRiskFactorsGroup = "-section_risk_factors_group",
|
|
1318
|
+
ValueSectionRiskScore = "-section_risk_score",
|
|
1319
|
+
ValueSectionRiskScoreGroup = "-section_risk_score_group",
|
|
1320
|
+
ValueSectorScore = "-sector_score",
|
|
1321
|
+
ValueSharpeRatio1Y = "-sharpe_ratio_1y",
|
|
1322
|
+
ValueSponsorAum = "-sponsor_aum",
|
|
1323
|
+
ValueTrackingError1Y = "-tracking_error_1y",
|
|
1324
|
+
ValueValueFactor = "-value_factor",
|
|
1325
|
+
ValueValueFactorGroup = "-value_factor_group",
|
|
1326
|
+
ValueNameVehicleType = "-name_vehicle_type",
|
|
1327
|
+
Alpha1Y = "alpha_1y",
|
|
1328
|
+
AnalysisFundamentalScore = "analysis_fundamental_score",
|
|
1329
|
+
AnalysisFundamentalScoreGroup = "analysis_fundamental_score_group",
|
|
1330
|
+
Return52W = "return_52w",
|
|
1331
|
+
Aum = "aum",
|
|
1332
|
+
AvgTradingVolume3M = "avg_trading_volume_3m",
|
|
1333
|
+
Beta1Y = "beta_1y",
|
|
1334
|
+
CashFlowFactor = "cash_flow_factor",
|
|
1335
|
+
CashFlowFactorGroup = "cash_flow_factor_group",
|
|
1336
|
+
DividendYield = "dividend_yield",
|
|
1337
|
+
DividendYieldPercentage = "dividend_yield_percentage",
|
|
1338
|
+
EquityUnderManagement = "equity_under_management",
|
|
1339
|
+
ExpenseRatio = "expense_ratio",
|
|
1340
|
+
FilingDate = "filing_date",
|
|
1341
|
+
GrowthFactor = "growth_factor",
|
|
1342
|
+
GrowthFactorGroup = "growth_factor_group",
|
|
1343
|
+
LargestHolding = "largest_holding",
|
|
1344
|
+
LastCloseMarketCapUsd = "last_close_market_cap_usd",
|
|
1345
|
+
MarketBenchmarkId = "market_benchmark_id",
|
|
1346
|
+
Concentration = "concentration",
|
|
1347
|
+
PctOfEquityHoldings = "pct_of_equity_holdings",
|
|
1348
|
+
PriceCurrencyIso3 = "price_currency_iso3",
|
|
1349
|
+
BenchmarkId = "benchmark_id",
|
|
1350
|
+
Return1D = "return_1d",
|
|
1351
|
+
Return1M = "return_1m",
|
|
1352
|
+
Return1Y = "return_1y",
|
|
1353
|
+
Return2Y = "return_2y",
|
|
1354
|
+
Return5D = "return_5d",
|
|
1355
|
+
Return5Y = "return_5y",
|
|
1356
|
+
Return6M = "return_6m",
|
|
1357
|
+
ReturnYtd = "return_ytd",
|
|
1358
|
+
SectionHoldingsGroup = "section_holdings_group",
|
|
1359
|
+
SectionMgmtMetricGroup = "section_mgmt_metric_group",
|
|
1360
|
+
SectionPerformanceScore = "section_performance_score",
|
|
1361
|
+
SectionPerformanceScoreGroup = "section_performance_score_group",
|
|
1362
|
+
SectionPortfolioScore = "section_portfolio_score",
|
|
1363
|
+
SectionPortfolioScoreGroup = "section_portfolio_score_group",
|
|
1364
|
+
SectionRiskFactorsGroup = "section_risk_factors_group",
|
|
1365
|
+
SectionRiskScore = "section_risk_score",
|
|
1366
|
+
SectionRiskScoreGroup = "section_risk_score_group",
|
|
1367
|
+
SectorScore = "sector_score",
|
|
1368
|
+
SharpeRatio1Y = "sharpe_ratio_1y",
|
|
1369
|
+
SponsorAum = "sponsor_aum",
|
|
1370
|
+
TrackingError1Y = "tracking_error_1y",
|
|
1371
|
+
ValueFactor = "value_factor",
|
|
1372
|
+
ValueFactorGroup = "value_factor_group",
|
|
1373
|
+
NameVehicleType = "name_vehicle_type"
|
|
1374
|
+
}
|
|
695
1375
|
/** HoldingItem */
|
|
696
1376
|
export interface BridgeWiseHoldingItem {
|
|
697
1377
|
/**
|
|
@@ -848,6 +1528,11 @@ export interface BridgeWiseMetadata {
|
|
|
848
1528
|
geographic_country_mandate: string | null;
|
|
849
1529
|
/** Geographic Region Mandate */
|
|
850
1530
|
geographic_region_mandate: string | null;
|
|
1531
|
+
/**
|
|
1532
|
+
* Geographic Emphasis
|
|
1533
|
+
* @default ""
|
|
1534
|
+
*/
|
|
1535
|
+
geographic_emphasis?: string | null;
|
|
851
1536
|
/** Market Capitalization Emphasis */
|
|
852
1537
|
market_capitalization_emphasis: string | null;
|
|
853
1538
|
/** Sector Emphasis */
|
|
@@ -1144,7 +1829,8 @@ export enum BridgeWiseScoringMethodEnum {
|
|
|
1144
1829
|
Global = "global",
|
|
1145
1830
|
Industry = "industry",
|
|
1146
1831
|
Country = "country",
|
|
1147
|
-
Sector = "sector"
|
|
1832
|
+
Sector = "sector",
|
|
1833
|
+
Specific = "specific"
|
|
1148
1834
|
}
|
|
1149
1835
|
/** CompanyParameter */
|
|
1150
1836
|
export interface BridgeWiseCompanyParameter {
|
|
@@ -1309,6 +1995,8 @@ export interface BridgeWiseESGParameterV2 {
|
|
|
1309
1995
|
* @default 0
|
|
1310
1996
|
*/
|
|
1311
1997
|
parameter_score_industry_median?: number | null;
|
|
1998
|
+
/** Section Type Name */
|
|
1999
|
+
section_type_name: string;
|
|
1312
2000
|
}
|
|
1313
2001
|
/**
|
|
1314
2002
|
* ESGScoreGroup
|
|
@@ -1321,6 +2009,12 @@ export enum BridgeWiseESGScoreGroup {
|
|
|
1321
2009
|
Value2 = 2,
|
|
1322
2010
|
Value1 = 1
|
|
1323
2011
|
}
|
|
2012
|
+
/** ESGSectionTypeParamEnumV2 */
|
|
2013
|
+
export enum BridgeWiseESGSectionTypeParamEnumV2 {
|
|
2014
|
+
Environmental = "environmental",
|
|
2015
|
+
Social = "social",
|
|
2016
|
+
Governance = "governance"
|
|
2017
|
+
}
|
|
1324
2018
|
/** FundParameter */
|
|
1325
2019
|
export interface BridgeWiseFundParameter {
|
|
1326
2020
|
/**
|
|
@@ -1421,17 +2115,6 @@ export enum BridgeWisePeriodTypeEnum {
|
|
|
1421
2115
|
Annually = "annually",
|
|
1422
2116
|
Last12Month = "last_12_month"
|
|
1423
2117
|
}
|
|
1424
|
-
/** SectionTypeEnum */
|
|
1425
|
-
export enum BridgeWiseSectionTypeEnum {
|
|
1426
|
-
BalanceSheet = "balance_sheet",
|
|
1427
|
-
IncomeStatement = "income_statement",
|
|
1428
|
-
CashFlow = "cash_flow",
|
|
1429
|
-
Social = "social",
|
|
1430
|
-
Environmental = "environmental",
|
|
1431
|
-
Governance = "governance",
|
|
1432
|
-
Summary = "summary",
|
|
1433
|
-
Probability = "probability"
|
|
1434
|
-
}
|
|
1435
2118
|
/** SegmentItem */
|
|
1436
2119
|
export interface BridgeWiseSegmentItem {
|
|
1437
2120
|
/** Language */
|
|
@@ -1699,7 +2382,8 @@ export enum BridgeWiseScoreMethodology {
|
|
|
1699
2382
|
Global = "global",
|
|
1700
2383
|
Industry = "industry",
|
|
1701
2384
|
Country = "country",
|
|
1702
|
-
Sector = "sector"
|
|
2385
|
+
Sector = "sector",
|
|
2386
|
+
Specific = "specific"
|
|
1703
2387
|
}
|
|
1704
2388
|
/** SectionsResponse */
|
|
1705
2389
|
export type BridgeWiseSectionsResponse = BridgeWiseSectionsResponseItem[];
|
|
@@ -1835,6 +2519,15 @@ export interface BridgeWiseCreateTenantApp {
|
|
|
1835
2519
|
/** Scopes */
|
|
1836
2520
|
scopes: string[];
|
|
1837
2521
|
}
|
|
2522
|
+
/** CreateTenantIdentifier */
|
|
2523
|
+
export interface BridgeWiseCreateTenantIdentifier {
|
|
2524
|
+
/** Identifier */
|
|
2525
|
+
identifier?: string | null;
|
|
2526
|
+
/** External Identifier */
|
|
2527
|
+
external_identifier: string;
|
|
2528
|
+
/** @default "active" */
|
|
2529
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
2530
|
+
}
|
|
1838
2531
|
/** EventTypeEnum */
|
|
1839
2532
|
export enum BridgeWiseEventTypeEnum {
|
|
1840
2533
|
PolicyThreshold = "policy_threshold",
|
|
@@ -2018,6 +2711,25 @@ export interface BridgeWiseTenantApp {
|
|
|
2018
2711
|
*/
|
|
2019
2712
|
tenant_id: string;
|
|
2020
2713
|
}
|
|
2714
|
+
/** TenantIdentifier */
|
|
2715
|
+
export interface BridgeWiseTenantIdentifier {
|
|
2716
|
+
/** Identifier */
|
|
2717
|
+
identifier?: string | null;
|
|
2718
|
+
/** External Identifier */
|
|
2719
|
+
external_identifier: string;
|
|
2720
|
+
/**
|
|
2721
|
+
* Tenant Id
|
|
2722
|
+
* @format uuid4
|
|
2723
|
+
*/
|
|
2724
|
+
tenant_id: string;
|
|
2725
|
+
/** @default "active" */
|
|
2726
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
2727
|
+
}
|
|
2728
|
+
/** TenantIdentifierStatusEnum */
|
|
2729
|
+
export enum BridgeWiseTenantIdentifierStatusEnum {
|
|
2730
|
+
Active = "active",
|
|
2731
|
+
Blacklisted = "blacklisted"
|
|
2732
|
+
}
|
|
2021
2733
|
/**
|
|
2022
2734
|
* TenantResponse
|
|
2023
2735
|
* Model for tenant response.
|
|
@@ -2047,6 +2759,122 @@ export interface BridgeWiseTenantResponse {
|
|
|
2047
2759
|
*/
|
|
2048
2760
|
updated_at: string;
|
|
2049
2761
|
}
|
|
2762
|
+
/** UpdateTenantIdentifier */
|
|
2763
|
+
export interface BridgeWiseUpdateTenantIdentifier {
|
|
2764
|
+
/** Identifier */
|
|
2765
|
+
identifier?: string | null;
|
|
2766
|
+
status?: BridgeWiseTenantIdentifierStatusEnum | null;
|
|
2767
|
+
}
|
|
2768
|
+
/** CompanyTheme */
|
|
2769
|
+
export interface BridgeWiseCompanyTheme {
|
|
2770
|
+
/** Id */
|
|
2771
|
+
id: number;
|
|
2772
|
+
package: BridgeWiseThemePackageEnum;
|
|
2773
|
+
type: BridgeWiseThemeTypeEnum;
|
|
2774
|
+
/** Name */
|
|
2775
|
+
name?: string | null;
|
|
2776
|
+
/** Additional Name */
|
|
2777
|
+
additional_name?: string | null;
|
|
2778
|
+
/** Description */
|
|
2779
|
+
description?: string | null;
|
|
2780
|
+
/**
|
|
2781
|
+
* Companies Count
|
|
2782
|
+
* @default 0
|
|
2783
|
+
*/
|
|
2784
|
+
companies_count?: number;
|
|
2785
|
+
/** Group */
|
|
2786
|
+
group?: number | null;
|
|
2787
|
+
/** Group Text */
|
|
2788
|
+
group_text?: string | null;
|
|
2789
|
+
/** Rank */
|
|
2790
|
+
rank?: number | null;
|
|
2791
|
+
}
|
|
2792
|
+
/** CompanyThemeListResponse */
|
|
2793
|
+
export type BridgeWiseCompanyThemeListResponse = BridgeWiseCompanyTheme[];
|
|
2794
|
+
/** Theme */
|
|
2795
|
+
export interface BridgeWiseTheme {
|
|
2796
|
+
/** Id */
|
|
2797
|
+
id: number;
|
|
2798
|
+
package: BridgeWiseThemePackageEnum;
|
|
2799
|
+
type: BridgeWiseThemeTypeEnum;
|
|
2800
|
+
/** Name */
|
|
2801
|
+
name?: string | null;
|
|
2802
|
+
/** Additional Name */
|
|
2803
|
+
additional_name?: string | null;
|
|
2804
|
+
/** Description */
|
|
2805
|
+
description?: string | null;
|
|
2806
|
+
/**
|
|
2807
|
+
* Companies Count
|
|
2808
|
+
* @default 0
|
|
2809
|
+
*/
|
|
2810
|
+
companies_count?: number;
|
|
2811
|
+
/** Rank */
|
|
2812
|
+
rank?: number | null;
|
|
2813
|
+
}
|
|
2814
|
+
/** ThemeFilter */
|
|
2815
|
+
export interface BridgeWiseThemeFilter {
|
|
2816
|
+
/** Name */
|
|
2817
|
+
name: string;
|
|
2818
|
+
/** Value */
|
|
2819
|
+
value: any;
|
|
2820
|
+
/** Operator */
|
|
2821
|
+
operator: string;
|
|
2822
|
+
}
|
|
2823
|
+
/** ThemeGroupEnum */
|
|
2824
|
+
export enum BridgeWiseThemeGroupEnum {
|
|
2825
|
+
Value1 = 1,
|
|
2826
|
+
Value2 = 2,
|
|
2827
|
+
Value3 = 3
|
|
2828
|
+
}
|
|
2829
|
+
/** ThemeLanguageEnum */
|
|
2830
|
+
export enum BridgeWiseThemeLanguageEnum {
|
|
2831
|
+
EnUS = "en-US",
|
|
2832
|
+
HeIL = "he-IL",
|
|
2833
|
+
PtBR = "pt-BR",
|
|
2834
|
+
JaJP = "ja-JP"
|
|
2835
|
+
}
|
|
2836
|
+
/** ThemeListFilter */
|
|
2837
|
+
export type BridgeWiseThemeListFilter = BridgeWiseThemeFilter[];
|
|
2838
|
+
/** ThemeListResponse */
|
|
2839
|
+
export type BridgeWiseThemeListResponse = BridgeWiseTheme[];
|
|
2840
|
+
/** ThemePackageEnum */
|
|
2841
|
+
export enum BridgeWiseThemePackageEnum {
|
|
2842
|
+
Basic = "basic",
|
|
2843
|
+
Advanced = "advanced"
|
|
2844
|
+
}
|
|
2845
|
+
/** ThemeResponse */
|
|
2846
|
+
export interface BridgeWiseThemeResponse {
|
|
2847
|
+
/** Id */
|
|
2848
|
+
id: number;
|
|
2849
|
+
package: BridgeWiseThemePackageEnum;
|
|
2850
|
+
type: BridgeWiseThemeTypeEnum;
|
|
2851
|
+
/** Name */
|
|
2852
|
+
name?: string | null;
|
|
2853
|
+
/** Additional Name */
|
|
2854
|
+
additional_name?: string | null;
|
|
2855
|
+
/** Description */
|
|
2856
|
+
description?: string | null;
|
|
2857
|
+
/**
|
|
2858
|
+
* Companies Count
|
|
2859
|
+
* @default 0
|
|
2860
|
+
*/
|
|
2861
|
+
companies_count?: number;
|
|
2862
|
+
/** Rank */
|
|
2863
|
+
rank?: number | null;
|
|
2864
|
+
/** Filters */
|
|
2865
|
+
filters?: BridgeWiseThemeFilter[];
|
|
2866
|
+
}
|
|
2867
|
+
/** ThemeTypeEnum */
|
|
2868
|
+
export enum BridgeWiseThemeTypeEnum {
|
|
2869
|
+
Geographic = "geographic",
|
|
2870
|
+
Strategy = "strategy",
|
|
2871
|
+
Technology = "technology",
|
|
2872
|
+
Income = "income",
|
|
2873
|
+
Index = "index",
|
|
2874
|
+
Sector = "sector",
|
|
2875
|
+
Esg = "esg",
|
|
2876
|
+
Factor = "factor"
|
|
2877
|
+
}
|
|
2050
2878
|
/** InvalidCredentials */
|
|
2051
2879
|
export interface BridgeWiseInvalidCredentials {
|
|
2052
2880
|
/**
|
|
@@ -2158,18 +2986,423 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
2158
2986
|
Gt = "gt",
|
|
2159
2987
|
Lt = "lt"
|
|
2160
2988
|
}
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
|
|
2165
|
-
|
|
2166
|
-
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
|
|
2171
|
-
|
|
2172
|
-
|
|
2989
|
+
/**
|
|
2990
|
+
* Date-Format
|
|
2991
|
+
* Desired date format.
|
|
2992
|
+
* @default "epoch"
|
|
2993
|
+
*/
|
|
2994
|
+
export enum BridgeWiseGetBusinessDescriptionParamsDateFormatEnum {
|
|
2995
|
+
Iso = "iso",
|
|
2996
|
+
Epoch = "epoch"
|
|
2997
|
+
}
|
|
2998
|
+
/**
|
|
2999
|
+
* Date Format
|
|
3000
|
+
* Desired date format.
|
|
3001
|
+
* @default "epoch"
|
|
3002
|
+
*/
|
|
3003
|
+
export enum BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum {
|
|
3004
|
+
Epoch = "epoch",
|
|
3005
|
+
Iso = "iso"
|
|
3006
|
+
}
|
|
3007
|
+
/**
|
|
3008
|
+
* Date-Format
|
|
3009
|
+
* Desired date format.
|
|
3010
|
+
* @default "epoch"
|
|
3011
|
+
*/
|
|
3012
|
+
export enum BridgeWiseGetIndustryDescriptionParamsDateFormatEnum {
|
|
3013
|
+
Iso = "iso",
|
|
3014
|
+
Epoch = "epoch"
|
|
3015
|
+
}
|
|
3016
|
+
/**
|
|
3017
|
+
* Date-Format
|
|
3018
|
+
* Desired date format.
|
|
3019
|
+
* @default "epoch"
|
|
3020
|
+
*/
|
|
3021
|
+
export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
3022
|
+
Iso = "iso",
|
|
3023
|
+
Epoch = "epoch"
|
|
3024
|
+
}
|
|
3025
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
3026
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3027
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3028
|
+
/**
|
|
3029
|
+
* @tags Bridget
|
|
3030
|
+
* @name QuestionCreate
|
|
3031
|
+
* @request POST:/bridget/v2/external/question
|
|
3032
|
+
* @secure
|
|
3033
|
+
*/
|
|
3034
|
+
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3035
|
+
/**
|
|
3036
|
+
* @tags Bridget
|
|
3037
|
+
* @name TenantsExportRetrieve
|
|
3038
|
+
* @request GET:/bridget/v2/external/tenants/{tenant_id}/export
|
|
3039
|
+
* @secure
|
|
3040
|
+
*/
|
|
3041
|
+
tenantsExportRetrieve(tenantId: string, query: {
|
|
3042
|
+
/** Client ID for filtering logs */
|
|
3043
|
+
client_id?: string;
|
|
3044
|
+
/**
|
|
3045
|
+
* Date for filtering logs
|
|
3046
|
+
* @format date
|
|
3047
|
+
*/
|
|
3048
|
+
date: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* End date for filtering logs
|
|
3051
|
+
* @format date
|
|
3052
|
+
*/
|
|
3053
|
+
end_date: string;
|
|
3054
|
+
/** Feedback type for filtering logs */
|
|
3055
|
+
feedback_type?: string;
|
|
3056
|
+
/** Session ID for filtering logs */
|
|
3057
|
+
session_id?: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* Start date for filtering logs
|
|
3060
|
+
* @format date
|
|
3061
|
+
*/
|
|
3062
|
+
start_date: string;
|
|
3063
|
+
/** User ID for filtering logs */
|
|
3064
|
+
user_id?: string;
|
|
3065
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3066
|
+
}
|
|
3067
|
+
export class Bwc<HandleError extends boolean = boolean> {
|
|
3068
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3069
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3070
|
+
/**
|
|
3071
|
+
* @description Get bulk data for a company
|
|
3072
|
+
* @tags bwc
|
|
3073
|
+
* @name Bulkdata
|
|
3074
|
+
* @summary Bulkdata
|
|
3075
|
+
* @request GET:/bulkdata/{name}
|
|
3076
|
+
* @secure
|
|
3077
|
+
*/
|
|
3078
|
+
bulkdata(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3079
|
+
/**
|
|
3080
|
+
* @description Get investment policy for a company
|
|
3081
|
+
* @tags bwc
|
|
3082
|
+
* @name InvestmentPolicy
|
|
3083
|
+
* @summary Investment Policy
|
|
3084
|
+
* @request GET:/investment-policy/{name}
|
|
3085
|
+
* @secure
|
|
3086
|
+
*/
|
|
3087
|
+
investmentPolicy(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3088
|
+
/**
|
|
3089
|
+
* @description Get analysis for a company
|
|
3090
|
+
* @tags bwc
|
|
3091
|
+
* @name GetAnalysis
|
|
3092
|
+
* @summary Get Analysis
|
|
3093
|
+
* @request GET:/v2/analysis
|
|
3094
|
+
* @secure
|
|
3095
|
+
*/
|
|
3096
|
+
getAnalysis(query: {
|
|
3097
|
+
/**
|
|
3098
|
+
* Identifier
|
|
3099
|
+
* String of comma separated unique identifiers.
|
|
3100
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3101
|
+
* @example "C74822,C83343214"
|
|
3102
|
+
*/
|
|
3103
|
+
identifier: string;
|
|
3104
|
+
/**
|
|
3105
|
+
* Language
|
|
3106
|
+
* Desired language.
|
|
3107
|
+
* @default "en-US"
|
|
3108
|
+
*/
|
|
3109
|
+
language?: BridgeWiseLanguageEnum;
|
|
3110
|
+
/**
|
|
3111
|
+
* Section Types
|
|
3112
|
+
* String of comma separated unique section types.
|
|
3113
|
+
* @example "section_type1,section_type2"
|
|
3114
|
+
*/
|
|
3115
|
+
section_types?: string;
|
|
3116
|
+
/**
|
|
3117
|
+
* Paragraph Types
|
|
3118
|
+
* String of comma separated unique paragraph types.
|
|
3119
|
+
* @example "paragraph_type1,paragraph_type2"
|
|
3120
|
+
*/
|
|
3121
|
+
paragraph_types?: string;
|
|
3122
|
+
}, headers: {
|
|
3123
|
+
/**
|
|
3124
|
+
* Api-Key
|
|
3125
|
+
* Desired Api Key.
|
|
3126
|
+
*/
|
|
3127
|
+
'Api-Key': string;
|
|
3128
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResultV2[], HandleError>>;
|
|
3129
|
+
/**
|
|
3130
|
+
* @description Get business description for a company
|
|
3131
|
+
* @tags bwc
|
|
3132
|
+
* @name GetBusinessDescription
|
|
3133
|
+
* @summary Get Business Description
|
|
3134
|
+
* @request GET:/v2/business-description
|
|
3135
|
+
* @secure
|
|
3136
|
+
*/
|
|
3137
|
+
getBusinessDescription(query: {
|
|
3138
|
+
/**
|
|
3139
|
+
* Identifier
|
|
3140
|
+
* String of comma separated unique identifiers.
|
|
3141
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3142
|
+
* @example "C74822,C83343214"
|
|
3143
|
+
*/
|
|
3144
|
+
identifier: string;
|
|
3145
|
+
/**
|
|
3146
|
+
* Language
|
|
3147
|
+
* Desired language.
|
|
3148
|
+
* @default "en-US"
|
|
3149
|
+
*/
|
|
3150
|
+
language?: BridgeWiseLanguageEnum;
|
|
3151
|
+
/**
|
|
3152
|
+
* Importancelevel
|
|
3153
|
+
* Desired importance level.
|
|
3154
|
+
* @default ""
|
|
3155
|
+
*/
|
|
3156
|
+
ImportanceLevel?: string;
|
|
3157
|
+
/**
|
|
3158
|
+
* Short Name
|
|
3159
|
+
* Desired short name.
|
|
3160
|
+
* @default "false"
|
|
3161
|
+
*/
|
|
3162
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
3163
|
+
}, headers: {
|
|
3164
|
+
/**
|
|
3165
|
+
* Api-Key
|
|
3166
|
+
* Desired Api Key.
|
|
3167
|
+
*/
|
|
3168
|
+
'Api-Key': string;
|
|
3169
|
+
/**
|
|
3170
|
+
* Date-Format
|
|
3171
|
+
* Desired date format.
|
|
3172
|
+
* @default "epoch"
|
|
3173
|
+
*/
|
|
3174
|
+
'Date-Format'?: BridgeWiseGetBusinessDescriptionParamsDateFormatEnum;
|
|
3175
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBusinessDescriptionResultV2, HandleError>>;
|
|
3176
|
+
/**
|
|
3177
|
+
* @description Get fundamental analysis for a company
|
|
3178
|
+
* @tags bwc
|
|
3179
|
+
* @name GetFundamentalAnalysis
|
|
3180
|
+
* @summary Get Fundamental Analysis
|
|
3181
|
+
* @request GET:/v2/fundamental-analysis
|
|
3182
|
+
* @secure
|
|
3183
|
+
*/
|
|
3184
|
+
getFundamentalAnalysis(query: {
|
|
3185
|
+
/**
|
|
3186
|
+
* Identifier
|
|
3187
|
+
* String of comma separated unique identifiers.
|
|
3188
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3189
|
+
* @example "C74822,C83343214"
|
|
3190
|
+
*/
|
|
3191
|
+
identifier: string;
|
|
3192
|
+
/**
|
|
3193
|
+
* Date Format
|
|
3194
|
+
* Desired date format.
|
|
3195
|
+
* @default "epoch"
|
|
3196
|
+
*/
|
|
3197
|
+
date_format?: BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum;
|
|
3198
|
+
/**
|
|
3199
|
+
* Importancelevel
|
|
3200
|
+
* Desired importance level.
|
|
3201
|
+
* @default ""
|
|
3202
|
+
*/
|
|
3203
|
+
ImportanceLevel?: string;
|
|
3204
|
+
/**
|
|
3205
|
+
* Period
|
|
3206
|
+
* Desired period.
|
|
3207
|
+
*/
|
|
3208
|
+
period?: string;
|
|
3209
|
+
/**
|
|
3210
|
+
* Language
|
|
3211
|
+
* Desired language.
|
|
3212
|
+
* @default "en-US"
|
|
3213
|
+
*/
|
|
3214
|
+
language?: BridgeWiseLanguageEnum;
|
|
3215
|
+
/**
|
|
3216
|
+
* Short Name
|
|
3217
|
+
* Desired short name.
|
|
3218
|
+
* @default "false"
|
|
3219
|
+
*/
|
|
3220
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
3221
|
+
/**
|
|
3222
|
+
* Summary
|
|
3223
|
+
* Desired summary.
|
|
3224
|
+
* @default "false"
|
|
3225
|
+
*/
|
|
3226
|
+
summary?: BridgeWiseStringBooleanEnum;
|
|
3227
|
+
/**
|
|
3228
|
+
* Balance Sheet
|
|
3229
|
+
* Desired balance sheet.
|
|
3230
|
+
* @default "false"
|
|
3231
|
+
*/
|
|
3232
|
+
balance_sheet?: BridgeWiseStringBooleanEnum;
|
|
3233
|
+
/**
|
|
3234
|
+
* Income Statement
|
|
3235
|
+
* Desired income statement.
|
|
3236
|
+
* @default "false"
|
|
3237
|
+
*/
|
|
3238
|
+
income_statement?: BridgeWiseStringBooleanEnum;
|
|
3239
|
+
/**
|
|
3240
|
+
* Cash Flow
|
|
3241
|
+
* Desired cash flow.
|
|
3242
|
+
* @default "false"
|
|
3243
|
+
*/
|
|
3244
|
+
cash_flow?: BridgeWiseStringBooleanEnum;
|
|
3245
|
+
}, headers: {
|
|
3246
|
+
/**
|
|
3247
|
+
* Api-Key
|
|
3248
|
+
* Desired Api Key.
|
|
3249
|
+
*/
|
|
3250
|
+
'Api-Key': string;
|
|
3251
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResultV2, HandleError>>;
|
|
3252
|
+
/**
|
|
3253
|
+
* @description Get industry description for a company
|
|
3254
|
+
* @tags bwc
|
|
3255
|
+
* @name GetIndustryDescription
|
|
3256
|
+
* @summary Get Industry Description
|
|
3257
|
+
* @request GET:/v2/industry-description
|
|
3258
|
+
* @secure
|
|
3259
|
+
*/
|
|
3260
|
+
getIndustryDescription(query: {
|
|
3261
|
+
/**
|
|
3262
|
+
* Identifier
|
|
3263
|
+
* String of comma separated unique identifiers.
|
|
3264
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3265
|
+
* @example "C74822,C83343214"
|
|
3266
|
+
*/
|
|
3267
|
+
identifier: string;
|
|
3268
|
+
/**
|
|
3269
|
+
* Period
|
|
3270
|
+
* String of comma separated unique periods.
|
|
3271
|
+
* @example "period1,period2"
|
|
3272
|
+
*/
|
|
3273
|
+
period?: string;
|
|
3274
|
+
/**
|
|
3275
|
+
* Language
|
|
3276
|
+
* Desired language.
|
|
3277
|
+
* @default "en-US"
|
|
3278
|
+
*/
|
|
3279
|
+
language?: BridgeWiseLanguageEnum;
|
|
3280
|
+
/**
|
|
3281
|
+
* Importancelevel
|
|
3282
|
+
* Desired importance level.
|
|
3283
|
+
* @default ""
|
|
3284
|
+
*/
|
|
3285
|
+
ImportanceLevel?: string;
|
|
3286
|
+
/**
|
|
3287
|
+
* Short Name
|
|
3288
|
+
* Desired short name.
|
|
3289
|
+
* @default "false"
|
|
3290
|
+
*/
|
|
3291
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
3292
|
+
}, headers: {
|
|
3293
|
+
/**
|
|
3294
|
+
* Api-Key
|
|
3295
|
+
* Desired Api Key.
|
|
3296
|
+
*/
|
|
3297
|
+
'Api-Key': string;
|
|
3298
|
+
/**
|
|
3299
|
+
* Date-Format
|
|
3300
|
+
* Desired date format.
|
|
3301
|
+
* @default "epoch"
|
|
3302
|
+
*/
|
|
3303
|
+
'Date-Format'?: BridgeWiseGetIndustryDescriptionParamsDateFormatEnum;
|
|
3304
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseIndustryDescriptionResultV2, HandleError>>;
|
|
3305
|
+
/**
|
|
3306
|
+
* @description Get technical analysis for a company
|
|
3307
|
+
* @tags bwc
|
|
3308
|
+
* @name GetTechnicalAnalysis
|
|
3309
|
+
* @summary Get Technical Analysis
|
|
3310
|
+
* @request GET:/v2/technical-analysis
|
|
3311
|
+
* @secure
|
|
3312
|
+
*/
|
|
3313
|
+
getTechnicalAnalysis(query: {
|
|
3314
|
+
/**
|
|
3315
|
+
* Identifier
|
|
3316
|
+
* String of comma separated unique identifiers.
|
|
3317
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3318
|
+
* @example "C74822,C83343214"
|
|
3319
|
+
*/
|
|
3320
|
+
identifier: string;
|
|
3321
|
+
/**
|
|
3322
|
+
* Decimals
|
|
3323
|
+
* Desired output round decimals.
|
|
3324
|
+
* @default 2
|
|
3325
|
+
*/
|
|
3326
|
+
decimals?: number;
|
|
3327
|
+
/**
|
|
3328
|
+
* Language
|
|
3329
|
+
* Desired language.
|
|
3330
|
+
* @default "en-US"
|
|
3331
|
+
*/
|
|
3332
|
+
language?: BridgeWiseLanguageEnum;
|
|
3333
|
+
/**
|
|
3334
|
+
* Importancelevel
|
|
3335
|
+
* Desired importance level.
|
|
3336
|
+
* @default ""
|
|
3337
|
+
*/
|
|
3338
|
+
ImportanceLevel?: string;
|
|
3339
|
+
/**
|
|
3340
|
+
* Short Name
|
|
3341
|
+
* Desired short name.
|
|
3342
|
+
* @default "false"
|
|
3343
|
+
*/
|
|
3344
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
3345
|
+
/**
|
|
3346
|
+
* Indicators
|
|
3347
|
+
* Desired indicators.
|
|
3348
|
+
* @default "true"
|
|
3349
|
+
*/
|
|
3350
|
+
indicators?: BridgeWiseStringBooleanEnum;
|
|
3351
|
+
/**
|
|
3352
|
+
* Sentiments
|
|
3353
|
+
* Desired sentiments.
|
|
3354
|
+
* @default "true"
|
|
3355
|
+
*/
|
|
3356
|
+
sentiments?: BridgeWiseStringBooleanEnum;
|
|
3357
|
+
/**
|
|
3358
|
+
* Summary
|
|
3359
|
+
* Desired summary.
|
|
3360
|
+
* @default "false"
|
|
3361
|
+
*/
|
|
3362
|
+
summary?: BridgeWiseStringBooleanEnum;
|
|
3363
|
+
}, headers: {
|
|
3364
|
+
/**
|
|
3365
|
+
* Api-Key
|
|
3366
|
+
* Desired Api Key.
|
|
3367
|
+
*/
|
|
3368
|
+
'Api-Key': string;
|
|
3369
|
+
/**
|
|
3370
|
+
* Date-Format
|
|
3371
|
+
* Desired date format.
|
|
3372
|
+
* @default "epoch"
|
|
3373
|
+
*/
|
|
3374
|
+
'Date-Format'?: BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum;
|
|
3375
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechnicalAnalysisResultV2, HandleError>>;
|
|
3376
|
+
/**
|
|
3377
|
+
* @description Verify if a company exists
|
|
3378
|
+
* @tags bwc
|
|
3379
|
+
* @name VerifyCompanyExists
|
|
3380
|
+
* @summary Verify Company Exists
|
|
3381
|
+
* @request GET:/v2/verify-company-exists
|
|
3382
|
+
* @secure
|
|
3383
|
+
*/
|
|
3384
|
+
verifyCompanyExists(query: {
|
|
3385
|
+
/**
|
|
3386
|
+
* Identifier
|
|
3387
|
+
* String of comma separated unique identifiers.
|
|
3388
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3389
|
+
* @example "C74822,C83343214"
|
|
3390
|
+
*/
|
|
3391
|
+
identifier: string;
|
|
3392
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3393
|
+
}
|
|
3394
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
3395
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3396
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3397
|
+
/**
|
|
3398
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
3399
|
+
* @tags Logos
|
|
3400
|
+
* @name FetchLogos
|
|
3401
|
+
* @summary Fetch Logos
|
|
3402
|
+
* @request GET:/companies/logos
|
|
3403
|
+
* @secure
|
|
3404
|
+
*/
|
|
3405
|
+
fetchLogos(query?: {
|
|
2173
3406
|
/**
|
|
2174
3407
|
* Company Id In
|
|
2175
3408
|
* Specify a list of BW identifiers for bulk queries.
|
|
@@ -2203,6 +3436,56 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
2203
3436
|
*/
|
|
2204
3437
|
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2205
3438
|
}
|
|
3439
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
3440
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3441
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3442
|
+
/**
|
|
3443
|
+
* @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.
|
|
3444
|
+
* @tags Activities
|
|
3445
|
+
* @name GetCompanyAlerts
|
|
3446
|
+
* @summary Get Company Alerts
|
|
3447
|
+
* @request GET:/companies/{company_id}/alerts
|
|
3448
|
+
* @secure
|
|
3449
|
+
*/
|
|
3450
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
3451
|
+
/**
|
|
3452
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3453
|
+
* @default "en-US"
|
|
3454
|
+
*/
|
|
3455
|
+
language?: BridgeWiseLanguageEnum;
|
|
3456
|
+
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
3457
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
3458
|
+
/** Filter alerts by their sentiment. */
|
|
3459
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
3460
|
+
/**
|
|
3461
|
+
* Importance
|
|
3462
|
+
* 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
|
|
3463
|
+
*/
|
|
3464
|
+
importance?: string | null;
|
|
3465
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
3466
|
+
/**
|
|
3467
|
+
* @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.
|
|
3468
|
+
* @tags Activities
|
|
3469
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
3470
|
+
* @summary Get Company Forecasts Key Development
|
|
3471
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
3472
|
+
* @secure
|
|
3473
|
+
*/
|
|
3474
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
3475
|
+
/**
|
|
3476
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3477
|
+
* @default "en-US"
|
|
3478
|
+
*/
|
|
3479
|
+
language?: BridgeWiseLanguageEnum;
|
|
3480
|
+
/**
|
|
3481
|
+
* Importance
|
|
3482
|
+
* 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
|
|
3483
|
+
* @default "0,1"
|
|
3484
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3485
|
+
*/
|
|
3486
|
+
importance?: string;
|
|
3487
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
3488
|
+
}
|
|
2206
3489
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
2207
3490
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2208
3491
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2306,11 +3589,8 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2306
3589
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2307
3590
|
*/
|
|
2308
3591
|
currency_market_id?: string;
|
|
2309
|
-
/**
|
|
2310
|
-
|
|
2311
|
-
* Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -last_close_market_cap_usd</br>
|
|
2312
|
-
*/
|
|
2313
|
-
sort_by?: string;
|
|
3592
|
+
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -last_close_market_cap_usd</br> */
|
|
3593
|
+
sort_by?: BridgeWiseCompaniesSortByEnum;
|
|
2314
3594
|
/**
|
|
2315
3595
|
* Filling Date Gte
|
|
2316
3596
|
* Companies with filing dates greater than specific date.
|
|
@@ -2845,101 +4125,80 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2845
4125
|
identifier_type: string;
|
|
2846
4126
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2847
4127
|
}
|
|
2848
|
-
export class
|
|
4128
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2849
4129
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2850
4130
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2851
4131
|
/**
|
|
2852
|
-
* @description Provides
|
|
2853
|
-
* @tags
|
|
2854
|
-
* @name
|
|
2855
|
-
* @summary Get Company
|
|
2856
|
-
* @request GET:/companies/{company_id}/
|
|
4132
|
+
* @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.
|
|
4133
|
+
* @tags Earning Calls
|
|
4134
|
+
* @name GetCompanyEarningsCalls
|
|
4135
|
+
* @summary Get Company Earnings Calls
|
|
4136
|
+
* @request GET:/companies/{company_id}/earnings-call
|
|
2857
4137
|
* @secure
|
|
2858
4138
|
*/
|
|
2859
|
-
|
|
4139
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2860
4140
|
/**
|
|
2861
4141
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2862
4142
|
* @default "en-US"
|
|
2863
4143
|
*/
|
|
2864
4144
|
language?: BridgeWiseLanguageEnum;
|
|
2865
|
-
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
2866
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
2867
|
-
/** Filter alerts by their sentiment. */
|
|
2868
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2869
4145
|
/**
|
|
2870
|
-
*
|
|
2871
|
-
*
|
|
4146
|
+
* Year
|
|
4147
|
+
* Specify the year for which the analysis is requested.
|
|
2872
4148
|
*/
|
|
2873
|
-
|
|
2874
|
-
|
|
4149
|
+
year?: number | null;
|
|
4150
|
+
/**
|
|
4151
|
+
* Quarter
|
|
4152
|
+
* Specify the quarter for which the analysis is requested.
|
|
4153
|
+
*/
|
|
4154
|
+
quarter?: number | null;
|
|
4155
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2875
4156
|
/**
|
|
2876
|
-
* @description Provides
|
|
2877
|
-
* @tags
|
|
2878
|
-
* @name
|
|
2879
|
-
* @summary Get
|
|
2880
|
-
* @request GET:/companies/{company_id}/
|
|
4157
|
+
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
4158
|
+
* @tags Earning Calls
|
|
4159
|
+
* @name GetEarningsCallsRecaps
|
|
4160
|
+
* @summary Get Earnings Calls Recaps
|
|
4161
|
+
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2881
4162
|
* @secure
|
|
2882
4163
|
*/
|
|
2883
|
-
|
|
4164
|
+
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
2884
4165
|
/**
|
|
2885
4166
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2886
4167
|
* @default "en-US"
|
|
2887
4168
|
*/
|
|
2888
4169
|
language?: BridgeWiseLanguageEnum;
|
|
2889
|
-
/**
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
* @default "0,1"
|
|
2893
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2894
|
-
*/
|
|
2895
|
-
importance?: string;
|
|
2896
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
4170
|
+
/** Specify the type of earnings call recap to receive (e.g., highlights, lowlights). */
|
|
4171
|
+
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4172
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
2897
4173
|
}
|
|
2898
|
-
export class
|
|
4174
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
2899
4175
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2900
4176
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2901
4177
|
/**
|
|
2902
|
-
* @description Provides
|
|
2903
|
-
* @tags
|
|
2904
|
-
* @name
|
|
2905
|
-
* @summary Get
|
|
2906
|
-
* @request GET:/companies/{company_id}/
|
|
4178
|
+
* @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
|
|
4179
|
+
* @tags Consensus Analysts
|
|
4180
|
+
* @name GetConsensusRatings
|
|
4181
|
+
* @summary Get Consensus Ratings
|
|
4182
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
2907
4183
|
* @secure
|
|
2908
4184
|
*/
|
|
2909
|
-
|
|
2910
|
-
/**
|
|
2911
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2912
|
-
* @default "en-US"
|
|
2913
|
-
*/
|
|
2914
|
-
language?: BridgeWiseLanguageEnum;
|
|
2915
|
-
/**
|
|
2916
|
-
* Year
|
|
2917
|
-
* Specify the year for which the analysis is requested.
|
|
2918
|
-
*/
|
|
2919
|
-
year?: number | null;
|
|
4185
|
+
getConsensusRatings(companyId: number, query?: {
|
|
2920
4186
|
/**
|
|
2921
|
-
*
|
|
2922
|
-
* Specify
|
|
4187
|
+
* Trading Item Id
|
|
4188
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
2923
4189
|
*/
|
|
2924
|
-
|
|
2925
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2926
|
-
/**
|
|
2927
|
-
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
2928
|
-
* @tags Earning Calls
|
|
2929
|
-
* @name GetEarningsCallsRecaps
|
|
2930
|
-
* @summary Get Earnings Calls Recaps
|
|
2931
|
-
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2932
|
-
* @secure
|
|
2933
|
-
*/
|
|
2934
|
-
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
4190
|
+
trading_item_id?: number;
|
|
2935
4191
|
/**
|
|
2936
4192
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2937
4193
|
* @default "en-US"
|
|
2938
4194
|
*/
|
|
2939
4195
|
language?: BridgeWiseLanguageEnum;
|
|
2940
|
-
/**
|
|
2941
|
-
|
|
2942
|
-
|
|
4196
|
+
/**
|
|
4197
|
+
* Date Gte
|
|
4198
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4199
|
+
*/
|
|
4200
|
+
date__gte?: string | null;
|
|
4201
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
2943
4202
|
}
|
|
2944
4203
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
2945
4204
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3001,7 +4260,7 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
3001
4260
|
*/
|
|
3002
4261
|
parameter_id?: number;
|
|
3003
4262
|
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
3004
|
-
section_type?:
|
|
4263
|
+
section_type?: BridgeWiseESGSectionTypeParamEnumV2;
|
|
3005
4264
|
/**
|
|
3006
4265
|
* Show All
|
|
3007
4266
|
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
@@ -3220,35 +4479,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3220
4479
|
date__lte?: string;
|
|
3221
4480
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3222
4481
|
}
|
|
3223
|
-
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
3224
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3225
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3226
|
-
/**
|
|
3227
|
-
* @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
|
|
3228
|
-
* @tags Consensus Analysts
|
|
3229
|
-
* @name GetConsensusRatings
|
|
3230
|
-
* @summary Get Consensus Ratings
|
|
3231
|
-
* @request GET:/companies/{company_id}/consensus-ratings
|
|
3232
|
-
* @secure
|
|
3233
|
-
*/
|
|
3234
|
-
getConsensusRatings(companyId: number, query?: {
|
|
3235
|
-
/**
|
|
3236
|
-
* Trading Item Id
|
|
3237
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3238
|
-
*/
|
|
3239
|
-
trading_item_id?: number;
|
|
3240
|
-
/**
|
|
3241
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3242
|
-
* @default "en-US"
|
|
3243
|
-
*/
|
|
3244
|
-
language?: BridgeWiseLanguageEnum;
|
|
3245
|
-
/**
|
|
3246
|
-
* Date Gte
|
|
3247
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3248
|
-
*/
|
|
3249
|
-
date__gte?: string | null;
|
|
3250
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
3251
|
-
}
|
|
3252
4482
|
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3253
4483
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3254
4484
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3341,14 +4571,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3341
4571
|
* Published Date Gte
|
|
3342
4572
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3343
4573
|
* @format date
|
|
3344
|
-
* @default "2025-06-
|
|
4574
|
+
* @default "2025-06-26"
|
|
3345
4575
|
*/
|
|
3346
4576
|
published_date__gte?: string;
|
|
3347
4577
|
/**
|
|
3348
4578
|
* Published Date Lte
|
|
3349
4579
|
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3350
4580
|
* @format date
|
|
3351
|
-
* @default "2025-06-
|
|
4581
|
+
* @default "2025-06-26"
|
|
3352
4582
|
*/
|
|
3353
4583
|
published_date__lte?: string;
|
|
3354
4584
|
/**
|
|
@@ -3384,14 +4614,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3384
4614
|
* Published Date Gte
|
|
3385
4615
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3386
4616
|
* @format date
|
|
3387
|
-
* @default "2025-06-
|
|
4617
|
+
* @default "2025-06-26"
|
|
3388
4618
|
*/
|
|
3389
4619
|
published_date__gte?: string;
|
|
3390
4620
|
/**
|
|
3391
4621
|
* Published Date Lte
|
|
3392
4622
|
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3393
4623
|
* @format date
|
|
3394
|
-
* @default "2025-06-
|
|
4624
|
+
* @default "2025-06-26"
|
|
3395
4625
|
*/
|
|
3396
4626
|
published_date__lte?: string;
|
|
3397
4627
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
@@ -3465,6 +4695,124 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3465
4695
|
parameter_id?: number;
|
|
3466
4696
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
3467
4697
|
}
|
|
4698
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
4699
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4700
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4701
|
+
/**
|
|
4702
|
+
* @description Retrieve a list of themes and their details associated with the company.
|
|
4703
|
+
* @tags Themes
|
|
4704
|
+
* @name GetCompanyThemes
|
|
4705
|
+
* @summary Get Company Themes
|
|
4706
|
+
* @request GET:/companies/{company_id}/themes
|
|
4707
|
+
* @secure
|
|
4708
|
+
*/
|
|
4709
|
+
getCompanyThemes(companyId: number, query?: {
|
|
4710
|
+
/**
|
|
4711
|
+
* Sort By
|
|
4712
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4713
|
+
* @default "group,rank"
|
|
4714
|
+
*/
|
|
4715
|
+
sort_by?: string | null;
|
|
4716
|
+
/**
|
|
4717
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4718
|
+
* @default "en-US"
|
|
4719
|
+
*/
|
|
4720
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4721
|
+
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
4722
|
+
group?: BridgeWiseThemeGroupEnum;
|
|
4723
|
+
/** Filter basic and advanced theme packages. */
|
|
4724
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4725
|
+
/** The type of the theme. */
|
|
4726
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4727
|
+
/**
|
|
4728
|
+
* Page
|
|
4729
|
+
* Define the page number for pagination.
|
|
4730
|
+
* @min 1
|
|
4731
|
+
* @default 1
|
|
4732
|
+
*/
|
|
4733
|
+
page?: number;
|
|
4734
|
+
/**
|
|
4735
|
+
* Page Size
|
|
4736
|
+
* Define the number of records per page for pagination purposes.
|
|
4737
|
+
* @min 1
|
|
4738
|
+
* @default 10
|
|
4739
|
+
*/
|
|
4740
|
+
page_size?: number;
|
|
4741
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
4742
|
+
/**
|
|
4743
|
+
* @description Retrieve a list of themes with their details. Filter by theme_id or search term, and order by any theme field. If no filter is provided, all themes are returned.
|
|
4744
|
+
* @tags Themes
|
|
4745
|
+
* @name GetThemes
|
|
4746
|
+
* @summary Get Themes
|
|
4747
|
+
* @request GET:/themes
|
|
4748
|
+
* @secure
|
|
4749
|
+
*/
|
|
4750
|
+
getThemes(query?: {
|
|
4751
|
+
/**
|
|
4752
|
+
* Search
|
|
4753
|
+
* Search string to filter themes by name or description.
|
|
4754
|
+
*/
|
|
4755
|
+
search?: string | null;
|
|
4756
|
+
/**
|
|
4757
|
+
* Sort By
|
|
4758
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4759
|
+
* @default "rank"
|
|
4760
|
+
*/
|
|
4761
|
+
sort_by?: string;
|
|
4762
|
+
/**
|
|
4763
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4764
|
+
* @default "en-US"
|
|
4765
|
+
*/
|
|
4766
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4767
|
+
/** Filter basic and advanced theme packages. */
|
|
4768
|
+
package?: BridgeWiseThemePackageEnum;
|
|
4769
|
+
/** The type of the theme. */
|
|
4770
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
4771
|
+
/**
|
|
4772
|
+
* Page
|
|
4773
|
+
* Define the page number for pagination.
|
|
4774
|
+
* @min 1
|
|
4775
|
+
* @default 1
|
|
4776
|
+
*/
|
|
4777
|
+
page?: number;
|
|
4778
|
+
/**
|
|
4779
|
+
* Page Size
|
|
4780
|
+
* Define the number of records per page for pagination purposes.
|
|
4781
|
+
* @min 1
|
|
4782
|
+
* @default 10
|
|
4783
|
+
*/
|
|
4784
|
+
page_size?: number;
|
|
4785
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
4786
|
+
/**
|
|
4787
|
+
* @description Retrieve a specific theme by its ID.
|
|
4788
|
+
* @tags Themes
|
|
4789
|
+
* @name GetTheme
|
|
4790
|
+
* @summary Get Theme
|
|
4791
|
+
* @request GET:/themes/{theme_id}
|
|
4792
|
+
* @secure
|
|
4793
|
+
*/
|
|
4794
|
+
getTheme(themeId: number, query?: {
|
|
4795
|
+
/**
|
|
4796
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4797
|
+
* @default "en-US"
|
|
4798
|
+
*/
|
|
4799
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
4800
|
+
/**
|
|
4801
|
+
* Include Filter
|
|
4802
|
+
* Include theme filters.
|
|
4803
|
+
* @default false
|
|
4804
|
+
*/
|
|
4805
|
+
include_filter?: boolean;
|
|
4806
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
4807
|
+
/**
|
|
4808
|
+
* @tags Themes
|
|
4809
|
+
* @name GetThemeFilters
|
|
4810
|
+
* @summary Get Theme Filters
|
|
4811
|
+
* @request GET:/themes/{theme_id}/filters
|
|
4812
|
+
* @secure
|
|
4813
|
+
*/
|
|
4814
|
+
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4815
|
+
}
|
|
3468
4816
|
export class Metadata<HandleError extends boolean = boolean> {
|
|
3469
4817
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3470
4818
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3508,11 +4856,8 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3508
4856
|
* Get peers funds of a specific fund.
|
|
3509
4857
|
*/
|
|
3510
4858
|
peers_of?: number;
|
|
3511
|
-
/**
|
|
3512
|
-
|
|
3513
|
-
* Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br>
|
|
3514
|
-
*/
|
|
3515
|
-
sort_by?: string;
|
|
4859
|
+
/** Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br> */
|
|
4860
|
+
sort_by?: BridgeWiseFundsSortByEnum;
|
|
3516
4861
|
/**
|
|
3517
4862
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3518
4863
|
* @default "en-US"
|
|
@@ -4069,233 +5414,66 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4069
5414
|
page_size?: number;
|
|
4070
5415
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4071
5416
|
}
|
|
4072
|
-
export class
|
|
5417
|
+
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
4073
5418
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4074
5419
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4075
5420
|
/**
|
|
4076
|
-
* @description
|
|
4077
|
-
* @tags
|
|
4078
|
-
* @name
|
|
4079
|
-
* @summary Get
|
|
4080
|
-
* @request GET:/
|
|
5421
|
+
* @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
|
|
5422
|
+
* @tags Sector Analysis
|
|
5423
|
+
* @name GetSectorAnalysis
|
|
5424
|
+
* @summary Get Sector Analysis
|
|
5425
|
+
* @request GET:/sectors/{sector_id}/analysis
|
|
4081
5426
|
* @secure
|
|
4082
5427
|
*/
|
|
4083
|
-
|
|
5428
|
+
getSectorAnalysis(sectorId: number, query?: {
|
|
4084
5429
|
/**
|
|
4085
|
-
*
|
|
4086
|
-
*
|
|
5430
|
+
* Year
|
|
5431
|
+
* Specify the year for which the analysis is requested.
|
|
4087
5432
|
*/
|
|
4088
|
-
|
|
5433
|
+
year?: number;
|
|
5434
|
+
/**
|
|
5435
|
+
* Quarter
|
|
5436
|
+
* Specify the quarter for which the analysis is requested.
|
|
5437
|
+
*/
|
|
5438
|
+
quarter?: number;
|
|
4089
5439
|
/**
|
|
4090
5440
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4091
5441
|
* @default "en-US"
|
|
4092
5442
|
*/
|
|
4093
5443
|
language?: BridgeWiseLanguageEnum;
|
|
4094
|
-
|
|
5444
|
+
/**
|
|
5445
|
+
* Limit
|
|
5446
|
+
* Number of sector strength periods to be returned (default is 1).
|
|
5447
|
+
*/
|
|
5448
|
+
limit?: number;
|
|
5449
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
4095
5450
|
}
|
|
4096
|
-
export class
|
|
5451
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
4097
5452
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4098
5453
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4099
5454
|
/**
|
|
4100
|
-
* @
|
|
4101
|
-
* @
|
|
4102
|
-
* @
|
|
4103
|
-
* @
|
|
4104
|
-
* @request GET:/funds/{fund_id}/market
|
|
5455
|
+
* @tags Tenants
|
|
5456
|
+
* @name FetchTenant
|
|
5457
|
+
* @summary Fetch Tenant
|
|
5458
|
+
* @request GET:/tenants/{tenant_id}
|
|
4105
5459
|
* @secure
|
|
4106
5460
|
*/
|
|
4107
|
-
|
|
4108
|
-
/**
|
|
4109
|
-
* Trading Item Id
|
|
4110
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4111
|
-
*/
|
|
4112
|
-
trading_item_id?: number | null;
|
|
4113
|
-
/**
|
|
4114
|
-
* Date Ge
|
|
4115
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4116
|
-
*/
|
|
4117
|
-
date__ge?: string | null;
|
|
4118
|
-
/**
|
|
4119
|
-
* Date Le
|
|
4120
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4121
|
-
*/
|
|
4122
|
-
date__le?: string | null;
|
|
4123
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5461
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
4124
5462
|
/**
|
|
4125
|
-
* @
|
|
4126
|
-
* @
|
|
4127
|
-
* @
|
|
4128
|
-
* @
|
|
4129
|
-
* @request GET:/funds/{fund_id}/market-statistics
|
|
5463
|
+
* @tags Tenants
|
|
5464
|
+
* @name GetHistoricalPolicyChanges
|
|
5465
|
+
* @summary Get Historical Policy Changes
|
|
5466
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
4130
5467
|
* @secure
|
|
4131
5468
|
*/
|
|
4132
|
-
|
|
5469
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
4133
5470
|
/**
|
|
4134
|
-
*
|
|
4135
|
-
* Specify a
|
|
5471
|
+
* Company Ids
|
|
5472
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5473
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5474
|
+
* @example "74822,83343211"
|
|
4136
5475
|
*/
|
|
4137
|
-
|
|
4138
|
-
/**
|
|
4139
|
-
* Identifier In
|
|
4140
|
-
* Specify a list of external identifiers.
|
|
4141
|
-
*/
|
|
4142
|
-
identifier__in?: string | null;
|
|
4143
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
4144
|
-
/**
|
|
4145
|
-
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
4146
|
-
* @tags Fund Market Data
|
|
4147
|
-
* @name GetFundTradingItems
|
|
4148
|
-
* @summary Get Fund Trading Items
|
|
4149
|
-
* @request GET:/funds/{fund_id}/trading-items
|
|
4150
|
-
* @secure
|
|
4151
|
-
*/
|
|
4152
|
-
getFundTradingItems(fundId: number, query?: {
|
|
4153
|
-
/**
|
|
4154
|
-
* Primary Flag
|
|
4155
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4156
|
-
*/
|
|
4157
|
-
primary_flag?: boolean;
|
|
4158
|
-
/**
|
|
4159
|
-
* Security Primary Flag
|
|
4160
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4161
|
-
*/
|
|
4162
|
-
security_primary_flag?: boolean;
|
|
4163
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
4164
|
-
}
|
|
4165
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
4166
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4167
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4168
|
-
/**
|
|
4169
|
-
* @tags Users
|
|
4170
|
-
* @name Authenticate
|
|
4171
|
-
* @summary Authenticate
|
|
4172
|
-
* @request POST:/users/authenticate
|
|
4173
|
-
* @secure
|
|
4174
|
-
*/
|
|
4175
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4176
|
-
/**
|
|
4177
|
-
* @tags Users
|
|
4178
|
-
* @name FetchClientDetails
|
|
4179
|
-
* @summary Fetch Client Details
|
|
4180
|
-
* @request GET:/users/machine
|
|
4181
|
-
* @secure
|
|
4182
|
-
*/
|
|
4183
|
-
fetchClientDetails(headers: {
|
|
4184
|
-
/** Authorization */
|
|
4185
|
-
authorization: string;
|
|
4186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4187
|
-
}
|
|
4188
|
-
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
4189
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4190
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4191
|
-
/**
|
|
4192
|
-
* @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
|
|
4193
|
-
* @tags Sector Analysis
|
|
4194
|
-
* @name GetSectorAnalysis
|
|
4195
|
-
* @summary Get Sector Analysis
|
|
4196
|
-
* @request GET:/sectors/{sector_id}/analysis
|
|
4197
|
-
* @secure
|
|
4198
|
-
*/
|
|
4199
|
-
getSectorAnalysis(sectorId: number, query?: {
|
|
4200
|
-
/**
|
|
4201
|
-
* Year
|
|
4202
|
-
* Specify the year for which the analysis is requested.
|
|
4203
|
-
*/
|
|
4204
|
-
year?: number;
|
|
4205
|
-
/**
|
|
4206
|
-
* Quarter
|
|
4207
|
-
* Specify the quarter for which the analysis is requested.
|
|
4208
|
-
*/
|
|
4209
|
-
quarter?: number;
|
|
4210
|
-
/**
|
|
4211
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4212
|
-
* @default "en-US"
|
|
4213
|
-
*/
|
|
4214
|
-
language?: BridgeWiseLanguageEnum;
|
|
4215
|
-
/**
|
|
4216
|
-
* Limit
|
|
4217
|
-
* Number of sector strength periods to be returned (default is 1).
|
|
4218
|
-
*/
|
|
4219
|
-
limit?: number;
|
|
4220
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
4221
|
-
}
|
|
4222
|
-
export class Segmentations<HandleError extends boolean = boolean> {
|
|
4223
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4224
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4225
|
-
/**
|
|
4226
|
-
* @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.
|
|
4227
|
-
* @tags Segmentations
|
|
4228
|
-
* @name GetSegmentParameters
|
|
4229
|
-
* @summary Get Segment Parameters
|
|
4230
|
-
* @request GET:/funds/{fund_id}/segment-parameters
|
|
4231
|
-
* @secure
|
|
4232
|
-
*/
|
|
4233
|
-
getSegmentParameters(fundId: number, query?: {
|
|
4234
|
-
/**
|
|
4235
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4236
|
-
* @default "en-US"
|
|
4237
|
-
*/
|
|
4238
|
-
language?: BridgeWiseLanguageEnum;
|
|
4239
|
-
/**
|
|
4240
|
-
* Segment
|
|
4241
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4242
|
-
*/
|
|
4243
|
-
segment?: string;
|
|
4244
|
-
/**
|
|
4245
|
-
* Segment Type
|
|
4246
|
-
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
4247
|
-
*/
|
|
4248
|
-
segment_type?: string;
|
|
4249
|
-
/** Desired segment parameter type. */
|
|
4250
|
-
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
4251
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
4252
|
-
/**
|
|
4253
|
-
* @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.
|
|
4254
|
-
* @tags Segmentations
|
|
4255
|
-
* @name GetSegment
|
|
4256
|
-
* @summary Get Segment
|
|
4257
|
-
* @request GET:/funds/{fund_id}/segments
|
|
4258
|
-
* @secure
|
|
4259
|
-
*/
|
|
4260
|
-
getSegment(fundId: number, query?: {
|
|
4261
|
-
/**
|
|
4262
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4263
|
-
* @default "en-US"
|
|
4264
|
-
*/
|
|
4265
|
-
language?: BridgeWiseLanguageEnum;
|
|
4266
|
-
/**
|
|
4267
|
-
* Segment
|
|
4268
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4269
|
-
*/
|
|
4270
|
-
segment?: string;
|
|
4271
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4272
|
-
}
|
|
4273
|
-
export class Tenants<HandleError extends boolean = boolean> {
|
|
4274
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4275
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4276
|
-
/**
|
|
4277
|
-
* @tags Tenants
|
|
4278
|
-
* @name FetchTenant
|
|
4279
|
-
* @summary Fetch Tenant
|
|
4280
|
-
* @request GET:/tenants/{tenant_id}
|
|
4281
|
-
* @secure
|
|
4282
|
-
*/
|
|
4283
|
-
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
4284
|
-
/**
|
|
4285
|
-
* @tags Tenants
|
|
4286
|
-
* @name GetHistoricalPolicyChanges
|
|
4287
|
-
* @summary Get Historical Policy Changes
|
|
4288
|
-
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
4289
|
-
* @secure
|
|
4290
|
-
*/
|
|
4291
|
-
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
4292
|
-
/**
|
|
4293
|
-
* Company Ids
|
|
4294
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
4295
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4296
|
-
* @example "74822,83343211"
|
|
4297
|
-
*/
|
|
4298
|
-
company_ids?: string;
|
|
5476
|
+
company_ids?: string;
|
|
4299
5477
|
/**
|
|
4300
5478
|
* Start Date Gte
|
|
4301
5479
|
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
@@ -4443,15 +5621,242 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4443
5621
|
*/
|
|
4444
5622
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4445
5623
|
}
|
|
5624
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5625
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5626
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5627
|
+
/**
|
|
5628
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5629
|
+
* @tags Fund Market Data
|
|
5630
|
+
* @name GetFundsMarketData
|
|
5631
|
+
* @summary Get Funds Market Data
|
|
5632
|
+
* @request GET:/funds/{fund_id}/market
|
|
5633
|
+
* @secure
|
|
5634
|
+
*/
|
|
5635
|
+
getFundsMarketData(fundId: number, query?: {
|
|
5636
|
+
/**
|
|
5637
|
+
* Trading Item Id
|
|
5638
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5639
|
+
*/
|
|
5640
|
+
trading_item_id?: number | null;
|
|
5641
|
+
/**
|
|
5642
|
+
* Date Ge
|
|
5643
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5644
|
+
*/
|
|
5645
|
+
date__ge?: string | null;
|
|
5646
|
+
/**
|
|
5647
|
+
* Date Le
|
|
5648
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5649
|
+
*/
|
|
5650
|
+
date__le?: string | null;
|
|
5651
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5652
|
+
/**
|
|
5653
|
+
* @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.
|
|
5654
|
+
* @tags Fund Market Data
|
|
5655
|
+
* @name GetFundsMarketStatistics
|
|
5656
|
+
* @summary Get Funds Market Statistics
|
|
5657
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
5658
|
+
* @secure
|
|
5659
|
+
*/
|
|
5660
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
5661
|
+
/**
|
|
5662
|
+
* Trading Item Id
|
|
5663
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5664
|
+
*/
|
|
5665
|
+
trading_item_id?: number | null;
|
|
5666
|
+
/**
|
|
5667
|
+
* Identifier In
|
|
5668
|
+
* Specify a list of external identifiers.
|
|
5669
|
+
*/
|
|
5670
|
+
identifier__in?: string | null;
|
|
5671
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5672
|
+
/**
|
|
5673
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5674
|
+
* @tags Fund Market Data
|
|
5675
|
+
* @name GetFundTradingItems
|
|
5676
|
+
* @summary Get Fund Trading Items
|
|
5677
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
5678
|
+
* @secure
|
|
5679
|
+
*/
|
|
5680
|
+
getFundTradingItems(fundId: number, query?: {
|
|
5681
|
+
/**
|
|
5682
|
+
* Primary Flag
|
|
5683
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5684
|
+
*/
|
|
5685
|
+
primary_flag?: boolean;
|
|
5686
|
+
/**
|
|
5687
|
+
* Security Primary Flag
|
|
5688
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
5689
|
+
*/
|
|
5690
|
+
security_primary_flag?: boolean;
|
|
5691
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5692
|
+
}
|
|
5693
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5694
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5696
|
+
/**
|
|
5697
|
+
* @description Get list of tenant identifiers
|
|
5698
|
+
* @tags Tenant Identifiers
|
|
5699
|
+
* @name GetTenantIdentifiers
|
|
5700
|
+
* @summary Get Tenant Identifiers
|
|
5701
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5702
|
+
* @secure
|
|
5703
|
+
*/
|
|
5704
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
5705
|
+
/** Tenant custom identifier status. */
|
|
5706
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5707
|
+
/**
|
|
5708
|
+
* Page
|
|
5709
|
+
* Define the page number for the results.
|
|
5710
|
+
* @default 1
|
|
5711
|
+
* @example 1
|
|
5712
|
+
*/
|
|
5713
|
+
page?: number;
|
|
5714
|
+
/**
|
|
5715
|
+
* Page Size
|
|
5716
|
+
* Define the maximum number of results to retrieve.
|
|
5717
|
+
* @default 20
|
|
5718
|
+
* @example 10
|
|
5719
|
+
*/
|
|
5720
|
+
page_size?: number;
|
|
5721
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5722
|
+
/**
|
|
5723
|
+
* @description Create a new identifier for a tenant
|
|
5724
|
+
* @tags Tenant Identifiers
|
|
5725
|
+
* @name CreateTenantIdentifier
|
|
5726
|
+
* @summary Create Tenant Identifier
|
|
5727
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5728
|
+
* @secure
|
|
5729
|
+
*/
|
|
5730
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5731
|
+
/**
|
|
5732
|
+
* @description Update an existing identifier for a tenant
|
|
5733
|
+
* @tags Tenant Identifiers
|
|
5734
|
+
* @name UpdateTenantIdentifier
|
|
5735
|
+
* @summary Update Tenant Identifier
|
|
5736
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5737
|
+
* @secure
|
|
5738
|
+
*/
|
|
5739
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5740
|
+
/**
|
|
5741
|
+
* @description Delete identifier for a tenant
|
|
5742
|
+
* @tags Tenant Identifiers
|
|
5743
|
+
* @name DeleteTenantIdentifier
|
|
5744
|
+
* @summary Delete Tenant Identifier
|
|
5745
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5746
|
+
* @secure
|
|
5747
|
+
*/
|
|
5748
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5749
|
+
}
|
|
5750
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5751
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5752
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5753
|
+
/**
|
|
5754
|
+
* @tags Users
|
|
5755
|
+
* @name Authenticate
|
|
5756
|
+
* @summary Authenticate
|
|
5757
|
+
* @request POST:/users/authenticate
|
|
5758
|
+
* @secure
|
|
5759
|
+
*/
|
|
5760
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5761
|
+
/**
|
|
5762
|
+
* @tags Users
|
|
5763
|
+
* @name FetchClientDetails
|
|
5764
|
+
* @summary Fetch Client Details
|
|
5765
|
+
* @request GET:/users/machine
|
|
5766
|
+
* @secure
|
|
5767
|
+
*/
|
|
5768
|
+
fetchClientDetails(headers: {
|
|
5769
|
+
/** Authorization */
|
|
5770
|
+
authorization: string;
|
|
5771
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5772
|
+
}
|
|
5773
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5774
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5775
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5776
|
+
/**
|
|
5777
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5778
|
+
* @tags Fund ESG Analysis
|
|
5779
|
+
* @name GetFundEsgAnalysis
|
|
5780
|
+
* @summary Get Fund Esg Analysis
|
|
5781
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5782
|
+
* @secure
|
|
5783
|
+
*/
|
|
5784
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5785
|
+
/**
|
|
5786
|
+
* Limit
|
|
5787
|
+
* Number of historical periods to be returned (default is 1).
|
|
5788
|
+
*/
|
|
5789
|
+
limit?: number;
|
|
5790
|
+
/**
|
|
5791
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5792
|
+
* @default "en-US"
|
|
5793
|
+
*/
|
|
5794
|
+
language?: BridgeWiseLanguageEnum;
|
|
5795
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5796
|
+
}
|
|
5797
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5798
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5799
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5800
|
+
/**
|
|
5801
|
+
* @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.
|
|
5802
|
+
* @tags Segmentations
|
|
5803
|
+
* @name GetSegmentParameters
|
|
5804
|
+
* @summary Get Segment Parameters
|
|
5805
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5806
|
+
* @secure
|
|
5807
|
+
*/
|
|
5808
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5809
|
+
/**
|
|
5810
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5811
|
+
* @default "en-US"
|
|
5812
|
+
*/
|
|
5813
|
+
language?: BridgeWiseLanguageEnum;
|
|
5814
|
+
/**
|
|
5815
|
+
* Segment
|
|
5816
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5817
|
+
*/
|
|
5818
|
+
segment?: string;
|
|
5819
|
+
/**
|
|
5820
|
+
* Segment Type
|
|
5821
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5822
|
+
*/
|
|
5823
|
+
segment_type?: string;
|
|
5824
|
+
/** Desired segment parameter type. */
|
|
5825
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5826
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5827
|
+
/**
|
|
5828
|
+
* @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.
|
|
5829
|
+
* @tags Segmentations
|
|
5830
|
+
* @name GetSegment
|
|
5831
|
+
* @summary Get Segment
|
|
5832
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5833
|
+
* @secure
|
|
5834
|
+
*/
|
|
5835
|
+
getSegment(fundId: number, query?: {
|
|
5836
|
+
/**
|
|
5837
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5838
|
+
* @default "en-US"
|
|
5839
|
+
*/
|
|
5840
|
+
language?: BridgeWiseLanguageEnum;
|
|
5841
|
+
/**
|
|
5842
|
+
* Segment
|
|
5843
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5844
|
+
*/
|
|
5845
|
+
segment?: string;
|
|
5846
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5847
|
+
}
|
|
4446
5848
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4447
5849
|
readonly config: JwtClientConfig<HandleError>;
|
|
4448
5850
|
activities: Activities<HandleError>;
|
|
5851
|
+
bridget: Bridget<HandleError>;
|
|
5852
|
+
bwc: Bwc<HandleError>;
|
|
4449
5853
|
companyMarketData: CompanyMarketData<HandleError>;
|
|
4450
5854
|
companyMetadata: CompanyMetadata<HandleError>;
|
|
4451
5855
|
companyNews: CompanyNews<HandleError>;
|
|
4452
5856
|
consensusAnalysts: ConsensusAnalysts<HandleError>;
|
|
4453
5857
|
earningCalls: EarningCalls<HandleError>;
|
|
4454
5858
|
esgAnalysis: EsgAnalysis<HandleError>;
|
|
5859
|
+
forecasts: Forecasts<HandleError>;
|
|
4455
5860
|
fundamentalAnalysis: FundamentalAnalysis<HandleError>;
|
|
4456
5861
|
fundAnalysis: FundAnalysis<HandleError>;
|
|
4457
5862
|
fundEsgAnalysis: FundEsgAnalysis<HandleError>;
|
|
@@ -4460,8 +5865,13 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
4460
5865
|
holdings: Holdings<HandleError>;
|
|
4461
5866
|
logos: Logos<HandleError>;
|
|
4462
5867
|
metadata: Metadata<HandleError>;
|
|
5868
|
+
sectorAnalysis: SectorAnalysis<HandleError>;
|
|
4463
5869
|
segmentations: Segmentations<HandleError>;
|
|
4464
5870
|
technicalAnalysis: TechnicalAnalysis<HandleError>;
|
|
5871
|
+
tenantIdentifiers: TenantIdentifiers<HandleError>;
|
|
5872
|
+
tenants: Tenants<HandleError>;
|
|
5873
|
+
themes: Themes<HandleError>;
|
|
5874
|
+
users: Users<HandleError>;
|
|
4465
5875
|
constructor(config: JwtClientConfig<HandleError>);
|
|
4466
5876
|
}
|
|
4467
5877
|
|