@orbis-systems/orbis-api-clients 0.7.6 → 0.7.8
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 +148 -129
- 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 +1245 -284
- 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 +281 -229
- 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 +74 -74
- 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 +3021 -3017
- 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 +354 -340
- 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 +170 -170
- 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 */
|
|
@@ -597,7 +1035,7 @@ export interface BridgeWiseCompanyResponse {
|
|
|
597
1035
|
* Include
|
|
598
1036
|
* @default []
|
|
599
1037
|
*/
|
|
600
|
-
include?:
|
|
1038
|
+
include?: Record<string, any>[];
|
|
601
1039
|
}
|
|
602
1040
|
/** CompositionTypeEnum */
|
|
603
1041
|
export enum BridgeWiseCompositionTypeEnum {
|
|
@@ -639,6 +1077,37 @@ export interface BridgeWiseConsensusRatingsResponse {
|
|
|
639
1077
|
}
|
|
640
1078
|
/** FundHoldingsList */
|
|
641
1079
|
export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
|
|
1080
|
+
/** FundTradingItems */
|
|
1081
|
+
export interface BridgeWiseFundTradingItems {
|
|
1082
|
+
/** Fund Id */
|
|
1083
|
+
fund_id: number | null;
|
|
1084
|
+
/** Security Id */
|
|
1085
|
+
security_id: number | null;
|
|
1086
|
+
/** Security Primary Flag */
|
|
1087
|
+
security_primary_flag: boolean | null;
|
|
1088
|
+
/** Trading Item Id */
|
|
1089
|
+
trading_item_id: number | null;
|
|
1090
|
+
/** Primary Flag */
|
|
1091
|
+
primary_flag: boolean | null;
|
|
1092
|
+
/** Ticker Symbol */
|
|
1093
|
+
ticker_symbol: string | null;
|
|
1094
|
+
/** Exchange Symbol */
|
|
1095
|
+
exchange_symbol: string | null;
|
|
1096
|
+
/** Exchange Name */
|
|
1097
|
+
exchange_name: string | null;
|
|
1098
|
+
/** Exchange Id */
|
|
1099
|
+
exchange_id: number | null;
|
|
1100
|
+
/** Exchange Importance Level */
|
|
1101
|
+
exchange_importance_level: number | null;
|
|
1102
|
+
/** Currency Iso3 */
|
|
1103
|
+
currency_iso3: string | null;
|
|
1104
|
+
/** Asset Type */
|
|
1105
|
+
asset_type: string | null;
|
|
1106
|
+
/** Has Score */
|
|
1107
|
+
has_score: boolean | null;
|
|
1108
|
+
}
|
|
1109
|
+
/** FundTradingItemsList */
|
|
1110
|
+
export type BridgeWiseFundTradingItemsList = BridgeWiseFundTradingItems[];
|
|
642
1111
|
/** FundsCompositionItem */
|
|
643
1112
|
export interface BridgeWiseFundsCompositionItem {
|
|
644
1113
|
/** Updated At */
|
|
@@ -877,11 +1346,6 @@ export interface BridgeWisePageLogo {
|
|
|
877
1346
|
/** Pages */
|
|
878
1347
|
pages?: number | null;
|
|
879
1348
|
}
|
|
880
|
-
/** StringBooleanEnum */
|
|
881
|
-
export enum BridgeWiseStringBooleanEnum {
|
|
882
|
-
True = "true",
|
|
883
|
-
False = "false"
|
|
884
|
-
}
|
|
885
1349
|
/** TradingItems */
|
|
886
1350
|
export interface BridgeWiseTradingItems {
|
|
887
1351
|
/** Company Id */
|
|
@@ -1209,8 +1673,10 @@ export interface BridgeWiseCompanyTechParameter {
|
|
|
1209
1673
|
parameter_description: number | string;
|
|
1210
1674
|
/** Parameter Value */
|
|
1211
1675
|
parameter_value: number | null;
|
|
1212
|
-
/**
|
|
1213
|
-
|
|
1676
|
+
/** Score Group */
|
|
1677
|
+
score_group: string | number | null;
|
|
1678
|
+
/** Score Group Text */
|
|
1679
|
+
score_group_text: string | number | null;
|
|
1214
1680
|
/** Parameter Currency Iso3 */
|
|
1215
1681
|
parameter_currency_iso3: string | null;
|
|
1216
1682
|
/**
|
|
@@ -1332,11 +1798,6 @@ export interface BridgeWiseFundParameter {
|
|
|
1332
1798
|
parameter_description?: number | string | null;
|
|
1333
1799
|
/** Has Score */
|
|
1334
1800
|
has_score: boolean;
|
|
1335
|
-
/**
|
|
1336
|
-
* Is Penalized
|
|
1337
|
-
* @default false
|
|
1338
|
-
*/
|
|
1339
|
-
is_penalized?: boolean;
|
|
1340
1801
|
/** Parameter Score Group */
|
|
1341
1802
|
parameter_score_group: number | null;
|
|
1342
1803
|
/** Parameter Score Group Text */
|
|
@@ -1676,7 +2137,8 @@ export enum BridgeWiseScoreMethodology {
|
|
|
1676
2137
|
Global = "global",
|
|
1677
2138
|
Industry = "industry",
|
|
1678
2139
|
Country = "country",
|
|
1679
|
-
Sector = "sector"
|
|
2140
|
+
Sector = "sector",
|
|
2141
|
+
Specific = "specific"
|
|
1680
2142
|
}
|
|
1681
2143
|
/** SectionsResponse */
|
|
1682
2144
|
export type BridgeWiseSectionsResponse = BridgeWiseSectionsResponseItem[];
|
|
@@ -1715,6 +2177,27 @@ export interface BridgeWiseSectionsResponseItem {
|
|
|
1715
2177
|
/** Section Percentile */
|
|
1716
2178
|
section_percentile?: number | null;
|
|
1717
2179
|
}
|
|
2180
|
+
/** SectorStrengthModel */
|
|
2181
|
+
export interface BridgeWiseSectorStrengthModel {
|
|
2182
|
+
/** Sector Id */
|
|
2183
|
+
sector_id: number;
|
|
2184
|
+
/** Year */
|
|
2185
|
+
year: number;
|
|
2186
|
+
/** Quarter */
|
|
2187
|
+
quarter: number;
|
|
2188
|
+
/** Sector Score */
|
|
2189
|
+
sector_score: number;
|
|
2190
|
+
/** Sector Name */
|
|
2191
|
+
sector_name: number | string | null;
|
|
2192
|
+
/** Updated At */
|
|
2193
|
+
updated_at: string | null;
|
|
2194
|
+
/** Score Group */
|
|
2195
|
+
score_group: number | null;
|
|
2196
|
+
/** Score Group Text */
|
|
2197
|
+
score_group_text: number | string | null;
|
|
2198
|
+
}
|
|
2199
|
+
/** SectorStrengthRoot */
|
|
2200
|
+
export type BridgeWiseSectorStrengthRoot = BridgeWiseSectorStrengthModel[];
|
|
1718
2201
|
/** TargetPriceList */
|
|
1719
2202
|
export type BridgeWiseTargetPriceList = BridgeWiseTargetPriceResponse[];
|
|
1720
2203
|
/** TargetPriceResponse */
|
|
@@ -1791,6 +2274,15 @@ export interface BridgeWiseCreateTenantApp {
|
|
|
1791
2274
|
/** Scopes */
|
|
1792
2275
|
scopes: string[];
|
|
1793
2276
|
}
|
|
2277
|
+
/** CreateTenantIdentifier */
|
|
2278
|
+
export interface BridgeWiseCreateTenantIdentifier {
|
|
2279
|
+
/** Identifier */
|
|
2280
|
+
identifier?: string | null;
|
|
2281
|
+
/** External Identifier */
|
|
2282
|
+
external_identifier: string;
|
|
2283
|
+
/** @default "active" */
|
|
2284
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
2285
|
+
}
|
|
1794
2286
|
/** EventTypeEnum */
|
|
1795
2287
|
export enum BridgeWiseEventTypeEnum {
|
|
1796
2288
|
PolicyThreshold = "policy_threshold",
|
|
@@ -1974,6 +2466,25 @@ export interface BridgeWiseTenantApp {
|
|
|
1974
2466
|
*/
|
|
1975
2467
|
tenant_id: string;
|
|
1976
2468
|
}
|
|
2469
|
+
/** TenantIdentifier */
|
|
2470
|
+
export interface BridgeWiseTenantIdentifier {
|
|
2471
|
+
/** Identifier */
|
|
2472
|
+
identifier?: string | null;
|
|
2473
|
+
/** External Identifier */
|
|
2474
|
+
external_identifier: string;
|
|
2475
|
+
/**
|
|
2476
|
+
* Tenant Id
|
|
2477
|
+
* @format uuid4
|
|
2478
|
+
*/
|
|
2479
|
+
tenant_id: string;
|
|
2480
|
+
/** @default "active" */
|
|
2481
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
2482
|
+
}
|
|
2483
|
+
/** TenantIdentifierStatusEnum */
|
|
2484
|
+
export enum BridgeWiseTenantIdentifierStatusEnum {
|
|
2485
|
+
Active = "active",
|
|
2486
|
+
Blacklisted = "blacklisted"
|
|
2487
|
+
}
|
|
1977
2488
|
/**
|
|
1978
2489
|
* TenantResponse
|
|
1979
2490
|
* Model for tenant response.
|
|
@@ -2003,6 +2514,12 @@ export interface BridgeWiseTenantResponse {
|
|
|
2003
2514
|
*/
|
|
2004
2515
|
updated_at: string;
|
|
2005
2516
|
}
|
|
2517
|
+
/** UpdateTenantIdentifier */
|
|
2518
|
+
export interface BridgeWiseUpdateTenantIdentifier {
|
|
2519
|
+
/** Identifier */
|
|
2520
|
+
identifier?: string | null;
|
|
2521
|
+
status?: BridgeWiseTenantIdentifierStatusEnum | null;
|
|
2522
|
+
}
|
|
2006
2523
|
/** InvalidCredentials */
|
|
2007
2524
|
export interface BridgeWiseInvalidCredentials {
|
|
2008
2525
|
/**
|
|
@@ -2114,50 +2631,410 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
2114
2631
|
Gt = "gt",
|
|
2115
2632
|
Lt = "lt"
|
|
2116
2633
|
}
|
|
2117
|
-
|
|
2634
|
+
/**
|
|
2635
|
+
* Date-Format
|
|
2636
|
+
* Desired date format.
|
|
2637
|
+
* @default "epoch"
|
|
2638
|
+
*/
|
|
2639
|
+
export enum BridgeWiseGetBusinessDescriptionParamsDateFormatEnum {
|
|
2640
|
+
Iso = "iso",
|
|
2641
|
+
Epoch = "epoch"
|
|
2642
|
+
}
|
|
2643
|
+
/**
|
|
2644
|
+
* Date Format
|
|
2645
|
+
* Desired date format.
|
|
2646
|
+
* @default "epoch"
|
|
2647
|
+
*/
|
|
2648
|
+
export enum BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum {
|
|
2649
|
+
Epoch = "epoch",
|
|
2650
|
+
Iso = "iso"
|
|
2651
|
+
}
|
|
2652
|
+
/**
|
|
2653
|
+
* Date-Format
|
|
2654
|
+
* Desired date format.
|
|
2655
|
+
* @default "epoch"
|
|
2656
|
+
*/
|
|
2657
|
+
export enum BridgeWiseGetIndustryDescriptionParamsDateFormatEnum {
|
|
2658
|
+
Iso = "iso",
|
|
2659
|
+
Epoch = "epoch"
|
|
2660
|
+
}
|
|
2661
|
+
/**
|
|
2662
|
+
* Date-Format
|
|
2663
|
+
* Desired date format.
|
|
2664
|
+
* @default "epoch"
|
|
2665
|
+
*/
|
|
2666
|
+
export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
2667
|
+
Iso = "iso",
|
|
2668
|
+
Epoch = "epoch"
|
|
2669
|
+
}
|
|
2670
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
2118
2671
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2119
2672
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2120
2673
|
/**
|
|
2121
|
-
* @
|
|
2122
|
-
* @
|
|
2123
|
-
* @
|
|
2124
|
-
* @summary Fetch Logos
|
|
2125
|
-
* @request GET:/companies/logos
|
|
2674
|
+
* @tags Bridget
|
|
2675
|
+
* @name QuestionCreate
|
|
2676
|
+
* @request POST:/bridget/v2/external/question
|
|
2126
2677
|
* @secure
|
|
2127
2678
|
*/
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
|
|
2132
|
-
|
|
2133
|
-
|
|
2679
|
+
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
2680
|
+
/**
|
|
2681
|
+
* @tags Bridget
|
|
2682
|
+
* @name TenantsExportRetrieve
|
|
2683
|
+
* @request GET:/bridget/v2/external/tenants/{tenant_id}/export
|
|
2684
|
+
* @secure
|
|
2685
|
+
*/
|
|
2686
|
+
tenantsExportRetrieve(tenantId: string, query: {
|
|
2687
|
+
/** Client ID for filtering logs */
|
|
2688
|
+
client_id?: string;
|
|
2689
|
+
/**
|
|
2690
|
+
* Date for filtering logs
|
|
2691
|
+
* @format date
|
|
2134
2692
|
*/
|
|
2135
|
-
|
|
2693
|
+
date: string;
|
|
2136
2694
|
/**
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2139
|
-
* @min 1
|
|
2140
|
-
* @max 100
|
|
2141
|
-
* @default 50
|
|
2695
|
+
* End date for filtering logs
|
|
2696
|
+
* @format date
|
|
2142
2697
|
*/
|
|
2143
|
-
|
|
2698
|
+
end_date: string;
|
|
2699
|
+
/** Feedback type for filtering logs */
|
|
2700
|
+
feedback_type?: string;
|
|
2701
|
+
/** Session ID for filtering logs */
|
|
2702
|
+
session_id?: string;
|
|
2144
2703
|
/**
|
|
2145
|
-
*
|
|
2146
|
-
*
|
|
2147
|
-
* @min 1
|
|
2148
|
-
* @default 1
|
|
2704
|
+
* Start date for filtering logs
|
|
2705
|
+
* @format date
|
|
2149
2706
|
*/
|
|
2150
|
-
|
|
2151
|
-
|
|
2707
|
+
start_date: string;
|
|
2708
|
+
/** User ID for filtering logs */
|
|
2709
|
+
user_id?: string;
|
|
2710
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
2711
|
+
}
|
|
2712
|
+
export class Bwc<HandleError extends boolean = boolean> {
|
|
2713
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2714
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2152
2715
|
/**
|
|
2153
|
-
* @description
|
|
2154
|
-
* @tags
|
|
2155
|
-
* @name
|
|
2156
|
-
* @summary
|
|
2157
|
-
* @request GET:/
|
|
2716
|
+
* @description Get bulk data for a company
|
|
2717
|
+
* @tags bwc
|
|
2718
|
+
* @name Bulkdata
|
|
2719
|
+
* @summary Bulkdata
|
|
2720
|
+
* @request GET:/bulkdata/{name}
|
|
2158
2721
|
* @secure
|
|
2159
2722
|
*/
|
|
2160
|
-
|
|
2723
|
+
bulkdata(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2724
|
+
/**
|
|
2725
|
+
* @description Get investment policy for a company
|
|
2726
|
+
* @tags bwc
|
|
2727
|
+
* @name InvestmentPolicy
|
|
2728
|
+
* @summary Investment Policy
|
|
2729
|
+
* @request GET:/investment-policy/{name}
|
|
2730
|
+
* @secure
|
|
2731
|
+
*/
|
|
2732
|
+
investmentPolicy(name: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2733
|
+
/**
|
|
2734
|
+
* @description Get analysis for a company
|
|
2735
|
+
* @tags bwc
|
|
2736
|
+
* @name GetAnalysis
|
|
2737
|
+
* @summary Get Analysis
|
|
2738
|
+
* @request GET:/v2/analysis
|
|
2739
|
+
* @secure
|
|
2740
|
+
*/
|
|
2741
|
+
getAnalysis(query: {
|
|
2742
|
+
/**
|
|
2743
|
+
* Identifier
|
|
2744
|
+
* String of comma separated unique identifiers.
|
|
2745
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
2746
|
+
* @example "C74822,C83343214"
|
|
2747
|
+
*/
|
|
2748
|
+
identifier: string;
|
|
2749
|
+
/**
|
|
2750
|
+
* Language
|
|
2751
|
+
* Desired language.
|
|
2752
|
+
* @default "en-US"
|
|
2753
|
+
*/
|
|
2754
|
+
language?: BridgeWiseLanguageEnum;
|
|
2755
|
+
/**
|
|
2756
|
+
* Section Types
|
|
2757
|
+
* String of comma separated unique section types.
|
|
2758
|
+
* @example "section_type1,section_type2"
|
|
2759
|
+
*/
|
|
2760
|
+
section_types?: string;
|
|
2761
|
+
/**
|
|
2762
|
+
* Paragraph Types
|
|
2763
|
+
* String of comma separated unique paragraph types.
|
|
2764
|
+
* @example "paragraph_type1,paragraph_type2"
|
|
2765
|
+
*/
|
|
2766
|
+
paragraph_types?: string;
|
|
2767
|
+
}, headers: {
|
|
2768
|
+
/**
|
|
2769
|
+
* Api-Key
|
|
2770
|
+
* Desired Api Key.
|
|
2771
|
+
*/
|
|
2772
|
+
'Api-Key': string;
|
|
2773
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAnalysisResultV2[], HandleError>>;
|
|
2774
|
+
/**
|
|
2775
|
+
* @description Get business description for a company
|
|
2776
|
+
* @tags bwc
|
|
2777
|
+
* @name GetBusinessDescription
|
|
2778
|
+
* @summary Get Business Description
|
|
2779
|
+
* @request GET:/v2/business-description
|
|
2780
|
+
* @secure
|
|
2781
|
+
*/
|
|
2782
|
+
getBusinessDescription(query: {
|
|
2783
|
+
/**
|
|
2784
|
+
* Identifier
|
|
2785
|
+
* String of comma separated unique identifiers.
|
|
2786
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
2787
|
+
* @example "C74822,C83343214"
|
|
2788
|
+
*/
|
|
2789
|
+
identifier: string;
|
|
2790
|
+
/**
|
|
2791
|
+
* Language
|
|
2792
|
+
* Desired language.
|
|
2793
|
+
* @default "en-US"
|
|
2794
|
+
*/
|
|
2795
|
+
language?: BridgeWiseLanguageEnum;
|
|
2796
|
+
/**
|
|
2797
|
+
* Importancelevel
|
|
2798
|
+
* Desired importance level.
|
|
2799
|
+
* @default ""
|
|
2800
|
+
*/
|
|
2801
|
+
ImportanceLevel?: string;
|
|
2802
|
+
/**
|
|
2803
|
+
* Short Name
|
|
2804
|
+
* Desired short name.
|
|
2805
|
+
* @default "false"
|
|
2806
|
+
*/
|
|
2807
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
2808
|
+
}, headers: {
|
|
2809
|
+
/**
|
|
2810
|
+
* Api-Key
|
|
2811
|
+
* Desired Api Key.
|
|
2812
|
+
*/
|
|
2813
|
+
'Api-Key': string;
|
|
2814
|
+
/**
|
|
2815
|
+
* Date-Format
|
|
2816
|
+
* Desired date format.
|
|
2817
|
+
* @default "epoch"
|
|
2818
|
+
*/
|
|
2819
|
+
'Date-Format'?: BridgeWiseGetBusinessDescriptionParamsDateFormatEnum;
|
|
2820
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBusinessDescriptionResultV2, HandleError>>;
|
|
2821
|
+
/**
|
|
2822
|
+
* @description Get fundamental analysis for a company
|
|
2823
|
+
* @tags bwc
|
|
2824
|
+
* @name GetFundamentalAnalysis
|
|
2825
|
+
* @summary Get Fundamental Analysis
|
|
2826
|
+
* @request GET:/v2/fundamental-analysis
|
|
2827
|
+
* @secure
|
|
2828
|
+
*/
|
|
2829
|
+
getFundamentalAnalysis(query: {
|
|
2830
|
+
/**
|
|
2831
|
+
* Identifier
|
|
2832
|
+
* String of comma separated unique identifiers.
|
|
2833
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
2834
|
+
* @example "C74822,C83343214"
|
|
2835
|
+
*/
|
|
2836
|
+
identifier: string;
|
|
2837
|
+
/**
|
|
2838
|
+
* Date Format
|
|
2839
|
+
* Desired date format.
|
|
2840
|
+
* @default "epoch"
|
|
2841
|
+
*/
|
|
2842
|
+
date_format?: BridgeWiseGetFundamentalAnalysisParamsDateFormatEnum;
|
|
2843
|
+
/**
|
|
2844
|
+
* Importancelevel
|
|
2845
|
+
* Desired importance level.
|
|
2846
|
+
* @default ""
|
|
2847
|
+
*/
|
|
2848
|
+
ImportanceLevel?: string;
|
|
2849
|
+
/**
|
|
2850
|
+
* Period
|
|
2851
|
+
* Desired period.
|
|
2852
|
+
*/
|
|
2853
|
+
period?: string;
|
|
2854
|
+
/**
|
|
2855
|
+
* Language
|
|
2856
|
+
* Desired language.
|
|
2857
|
+
* @default "en-US"
|
|
2858
|
+
*/
|
|
2859
|
+
language?: BridgeWiseLanguageEnum;
|
|
2860
|
+
/**
|
|
2861
|
+
* Short Name
|
|
2862
|
+
* Desired short name.
|
|
2863
|
+
* @default "false"
|
|
2864
|
+
*/
|
|
2865
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
2866
|
+
/**
|
|
2867
|
+
* Summary
|
|
2868
|
+
* Desired summary.
|
|
2869
|
+
* @default "false"
|
|
2870
|
+
*/
|
|
2871
|
+
summary?: BridgeWiseStringBooleanEnum;
|
|
2872
|
+
/**
|
|
2873
|
+
* Balance Sheet
|
|
2874
|
+
* Desired balance sheet.
|
|
2875
|
+
* @default "false"
|
|
2876
|
+
*/
|
|
2877
|
+
balance_sheet?: BridgeWiseStringBooleanEnum;
|
|
2878
|
+
/**
|
|
2879
|
+
* Income Statement
|
|
2880
|
+
* Desired income statement.
|
|
2881
|
+
* @default "false"
|
|
2882
|
+
*/
|
|
2883
|
+
income_statement?: BridgeWiseStringBooleanEnum;
|
|
2884
|
+
/**
|
|
2885
|
+
* Cash Flow
|
|
2886
|
+
* Desired cash flow.
|
|
2887
|
+
* @default "false"
|
|
2888
|
+
*/
|
|
2889
|
+
cash_flow?: BridgeWiseStringBooleanEnum;
|
|
2890
|
+
}, headers: {
|
|
2891
|
+
/**
|
|
2892
|
+
* Api-Key
|
|
2893
|
+
* Desired Api Key.
|
|
2894
|
+
*/
|
|
2895
|
+
'Api-Key': string;
|
|
2896
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResultV2, HandleError>>;
|
|
2897
|
+
/**
|
|
2898
|
+
* @description Get industry description for a company
|
|
2899
|
+
* @tags bwc
|
|
2900
|
+
* @name GetIndustryDescription
|
|
2901
|
+
* @summary Get Industry Description
|
|
2902
|
+
* @request GET:/v2/industry-description
|
|
2903
|
+
* @secure
|
|
2904
|
+
*/
|
|
2905
|
+
getIndustryDescription(query: {
|
|
2906
|
+
/**
|
|
2907
|
+
* Identifier
|
|
2908
|
+
* String of comma separated unique identifiers.
|
|
2909
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
2910
|
+
* @example "C74822,C83343214"
|
|
2911
|
+
*/
|
|
2912
|
+
identifier: string;
|
|
2913
|
+
/**
|
|
2914
|
+
* Period
|
|
2915
|
+
* String of comma separated unique periods.
|
|
2916
|
+
* @example "period1,period2"
|
|
2917
|
+
*/
|
|
2918
|
+
period?: string;
|
|
2919
|
+
/**
|
|
2920
|
+
* Language
|
|
2921
|
+
* Desired language.
|
|
2922
|
+
* @default "en-US"
|
|
2923
|
+
*/
|
|
2924
|
+
language?: BridgeWiseLanguageEnum;
|
|
2925
|
+
/**
|
|
2926
|
+
* Importancelevel
|
|
2927
|
+
* Desired importance level.
|
|
2928
|
+
* @default ""
|
|
2929
|
+
*/
|
|
2930
|
+
ImportanceLevel?: string;
|
|
2931
|
+
/**
|
|
2932
|
+
* Short Name
|
|
2933
|
+
* Desired short name.
|
|
2934
|
+
* @default "false"
|
|
2935
|
+
*/
|
|
2936
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
2937
|
+
}, headers: {
|
|
2938
|
+
/**
|
|
2939
|
+
* Api-Key
|
|
2940
|
+
* Desired Api Key.
|
|
2941
|
+
*/
|
|
2942
|
+
'Api-Key': string;
|
|
2943
|
+
/**
|
|
2944
|
+
* Date-Format
|
|
2945
|
+
* Desired date format.
|
|
2946
|
+
* @default "epoch"
|
|
2947
|
+
*/
|
|
2948
|
+
'Date-Format'?: BridgeWiseGetIndustryDescriptionParamsDateFormatEnum;
|
|
2949
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseIndustryDescriptionResultV2, HandleError>>;
|
|
2950
|
+
/**
|
|
2951
|
+
* @description Get technical analysis for a company
|
|
2952
|
+
* @tags bwc
|
|
2953
|
+
* @name GetTechnicalAnalysis
|
|
2954
|
+
* @summary Get Technical Analysis
|
|
2955
|
+
* @request GET:/v2/technical-analysis
|
|
2956
|
+
* @secure
|
|
2957
|
+
*/
|
|
2958
|
+
getTechnicalAnalysis(query: {
|
|
2959
|
+
/**
|
|
2960
|
+
* Identifier
|
|
2961
|
+
* String of comma separated unique identifiers.
|
|
2962
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
2963
|
+
* @example "C74822,C83343214"
|
|
2964
|
+
*/
|
|
2965
|
+
identifier: string;
|
|
2966
|
+
/**
|
|
2967
|
+
* Decimals
|
|
2968
|
+
* Desired output round decimals.
|
|
2969
|
+
* @default 2
|
|
2970
|
+
*/
|
|
2971
|
+
decimals?: number;
|
|
2972
|
+
/**
|
|
2973
|
+
* Language
|
|
2974
|
+
* Desired language.
|
|
2975
|
+
* @default "en-US"
|
|
2976
|
+
*/
|
|
2977
|
+
language?: BridgeWiseLanguageEnum;
|
|
2978
|
+
/**
|
|
2979
|
+
* Importancelevel
|
|
2980
|
+
* Desired importance level.
|
|
2981
|
+
* @default ""
|
|
2982
|
+
*/
|
|
2983
|
+
ImportanceLevel?: string;
|
|
2984
|
+
/**
|
|
2985
|
+
* Short Name
|
|
2986
|
+
* Desired short name.
|
|
2987
|
+
* @default "false"
|
|
2988
|
+
*/
|
|
2989
|
+
short_name?: BridgeWiseStringBooleanEnum;
|
|
2990
|
+
/**
|
|
2991
|
+
* Indicators
|
|
2992
|
+
* Desired indicators.
|
|
2993
|
+
* @default "true"
|
|
2994
|
+
*/
|
|
2995
|
+
indicators?: BridgeWiseStringBooleanEnum;
|
|
2996
|
+
/**
|
|
2997
|
+
* Sentiments
|
|
2998
|
+
* Desired sentiments.
|
|
2999
|
+
* @default "true"
|
|
3000
|
+
*/
|
|
3001
|
+
sentiments?: BridgeWiseStringBooleanEnum;
|
|
3002
|
+
/**
|
|
3003
|
+
* Summary
|
|
3004
|
+
* Desired summary.
|
|
3005
|
+
* @default "false"
|
|
3006
|
+
*/
|
|
3007
|
+
summary?: BridgeWiseStringBooleanEnum;
|
|
3008
|
+
}, headers: {
|
|
3009
|
+
/**
|
|
3010
|
+
* Api-Key
|
|
3011
|
+
* Desired Api Key.
|
|
3012
|
+
*/
|
|
3013
|
+
'Api-Key': string;
|
|
3014
|
+
/**
|
|
3015
|
+
* Date-Format
|
|
3016
|
+
* Desired date format.
|
|
3017
|
+
* @default "epoch"
|
|
3018
|
+
*/
|
|
3019
|
+
'Date-Format'?: BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum;
|
|
3020
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechnicalAnalysisResultV2, HandleError>>;
|
|
3021
|
+
/**
|
|
3022
|
+
* @description Verify if a company exists
|
|
3023
|
+
* @tags bwc
|
|
3024
|
+
* @name VerifyCompanyExists
|
|
3025
|
+
* @summary Verify Company Exists
|
|
3026
|
+
* @request GET:/v2/verify-company-exists
|
|
3027
|
+
* @secure
|
|
3028
|
+
*/
|
|
3029
|
+
verifyCompanyExists(query: {
|
|
3030
|
+
/**
|
|
3031
|
+
* Identifier
|
|
3032
|
+
* String of comma separated unique identifiers.
|
|
3033
|
+
* @pattern ^[0-9a-zA-Z\-]+(?:,[0-9a-zA-Z\-]+)*$
|
|
3034
|
+
* @example "C74822,C83343214"
|
|
3035
|
+
*/
|
|
3036
|
+
identifier: string;
|
|
3037
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
2161
3038
|
}
|
|
2162
3039
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
2163
3040
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2172,7 +3049,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2172
3049
|
*/
|
|
2173
3050
|
getCompanies(query?: {
|
|
2174
3051
|
/**
|
|
2175
|
-
* Language
|
|
2176
3052
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2177
3053
|
* @default "en-US"
|
|
2178
3054
|
*/
|
|
@@ -2763,7 +3639,6 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2763
3639
|
*/
|
|
2764
3640
|
getCompany(companyId: number, query?: {
|
|
2765
3641
|
/**
|
|
2766
|
-
* Language
|
|
2767
3642
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2768
3643
|
* @default "en-US"
|
|
2769
3644
|
*/
|
|
@@ -2816,20 +3691,13 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2816
3691
|
*/
|
|
2817
3692
|
getCompanyAlerts(companyId: number, query?: {
|
|
2818
3693
|
/**
|
|
2819
|
-
* Language
|
|
2820
3694
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2821
3695
|
* @default "en-US"
|
|
2822
3696
|
*/
|
|
2823
3697
|
language?: BridgeWiseLanguageEnum;
|
|
2824
|
-
/**
|
|
2825
|
-
* Alert Type
|
|
2826
|
-
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
2827
|
-
*/
|
|
3698
|
+
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
2828
3699
|
alert_type?: BridgeWiseCompanyAlertType;
|
|
2829
|
-
/**
|
|
2830
|
-
* Sentiment
|
|
2831
|
-
* Filter alerts by their sentiment.
|
|
2832
|
-
*/
|
|
3700
|
+
/** Filter alerts by their sentiment. */
|
|
2833
3701
|
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2834
3702
|
/**
|
|
2835
3703
|
* Importance
|
|
@@ -2847,7 +3715,6 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2847
3715
|
*/
|
|
2848
3716
|
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
2849
3717
|
/**
|
|
2850
|
-
* Language
|
|
2851
3718
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2852
3719
|
* @default "en-US"
|
|
2853
3720
|
*/
|
|
@@ -2861,6 +3728,51 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2861
3728
|
importance?: string;
|
|
2862
3729
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2863
3730
|
}
|
|
3731
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
3732
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3733
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3734
|
+
/**
|
|
3735
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
3736
|
+
* @tags Logos
|
|
3737
|
+
* @name FetchLogos
|
|
3738
|
+
* @summary Fetch Logos
|
|
3739
|
+
* @request GET:/companies/logos
|
|
3740
|
+
* @secure
|
|
3741
|
+
*/
|
|
3742
|
+
fetchLogos(query?: {
|
|
3743
|
+
/**
|
|
3744
|
+
* Company Id In
|
|
3745
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
3746
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3747
|
+
* @example "74822,83343211"
|
|
3748
|
+
*/
|
|
3749
|
+
company_id__in?: string;
|
|
3750
|
+
/**
|
|
3751
|
+
* Size
|
|
3752
|
+
* Page size
|
|
3753
|
+
* @min 1
|
|
3754
|
+
* @max 100
|
|
3755
|
+
* @default 50
|
|
3756
|
+
*/
|
|
3757
|
+
size?: number;
|
|
3758
|
+
/**
|
|
3759
|
+
* Page
|
|
3760
|
+
* Page number
|
|
3761
|
+
* @min 1
|
|
3762
|
+
* @default 1
|
|
3763
|
+
*/
|
|
3764
|
+
page?: number;
|
|
3765
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
3766
|
+
/**
|
|
3767
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
3768
|
+
* @tags Logos
|
|
3769
|
+
* @name FetchLogo
|
|
3770
|
+
* @summary Fetch Logo
|
|
3771
|
+
* @request GET:/companies/{company_id}/logos
|
|
3772
|
+
* @secure
|
|
3773
|
+
*/
|
|
3774
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
3775
|
+
}
|
|
2864
3776
|
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
2865
3777
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2866
3778
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2879,7 +3791,6 @@ export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
|
2879
3791
|
*/
|
|
2880
3792
|
trading_item_id?: number;
|
|
2881
3793
|
/**
|
|
2882
|
-
* Language
|
|
2883
3794
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2884
3795
|
* @default "en-US"
|
|
2885
3796
|
*/
|
|
@@ -2904,7 +3815,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
2904
3815
|
*/
|
|
2905
3816
|
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2906
3817
|
/**
|
|
2907
|
-
* Language
|
|
2908
3818
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2909
3819
|
* @default "en-US"
|
|
2910
3820
|
*/
|
|
@@ -2930,15 +3840,11 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
2930
3840
|
*/
|
|
2931
3841
|
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
2932
3842
|
/**
|
|
2933
|
-
* Language
|
|
2934
3843
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2935
3844
|
* @default "en-US"
|
|
2936
3845
|
*/
|
|
2937
3846
|
language?: BridgeWiseLanguageEnum;
|
|
2938
|
-
/**
|
|
2939
|
-
* Type
|
|
2940
|
-
* Specify the type of earnings call recap to receive (e.g., highlights, lowlights).
|
|
2941
|
-
*/
|
|
3847
|
+
/** Specify the type of earnings call recap to receive (e.g., highlights, lowlights). */
|
|
2942
3848
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
2943
3849
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
2944
3850
|
}
|
|
@@ -2955,7 +3861,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2955
3861
|
*/
|
|
2956
3862
|
getCompanyEsgAnalysis(companyId: number, query?: {
|
|
2957
3863
|
/**
|
|
2958
|
-
* Language
|
|
2959
3864
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2960
3865
|
* @default "en-US"
|
|
2961
3866
|
*/
|
|
@@ -2976,15 +3881,11 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2976
3881
|
*/
|
|
2977
3882
|
getCompanyEsgParagraphs(companyId: number, query?: {
|
|
2978
3883
|
/**
|
|
2979
|
-
* Language
|
|
2980
3884
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2981
3885
|
* @default "en-US"
|
|
2982
3886
|
*/
|
|
2983
3887
|
language?: BridgeWiseLanguageEnum;
|
|
2984
|
-
/**
|
|
2985
|
-
* Section Type
|
|
2986
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
2987
|
-
*/
|
|
3888
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
2988
3889
|
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
2989
3890
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
2990
3891
|
/**
|
|
@@ -2997,7 +3898,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
2997
3898
|
*/
|
|
2998
3899
|
getCompanyEsgParameters(companyId: number, query?: {
|
|
2999
3900
|
/**
|
|
3000
|
-
* Language
|
|
3001
3901
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3002
3902
|
* @default "en-US"
|
|
3003
3903
|
*/
|
|
@@ -3007,10 +3907,7 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
3007
3907
|
* Get desired parameter by ID.
|
|
3008
3908
|
*/
|
|
3009
3909
|
parameter_id?: number;
|
|
3010
|
-
/**
|
|
3011
|
-
* Section Type
|
|
3012
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
3013
|
-
*/
|
|
3910
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
3014
3911
|
section_type?: BridgeWiseSectionTypeEnum;
|
|
3015
3912
|
/**
|
|
3016
3913
|
* Show All
|
|
@@ -3028,15 +3925,11 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
3028
3925
|
*/
|
|
3029
3926
|
getCompanyEsgSections(companyId: number, query?: {
|
|
3030
3927
|
/**
|
|
3031
|
-
* Language
|
|
3032
3928
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3033
3929
|
* @default "en-US"
|
|
3034
3930
|
*/
|
|
3035
3931
|
language?: BridgeWiseLanguageEnum;
|
|
3036
|
-
/**
|
|
3037
|
-
* Section Type
|
|
3038
|
-
* Specify the component of the analysis to retrieve (e.g., `environmental`, `social`).
|
|
3039
|
-
*/
|
|
3932
|
+
/** Specify the component of the analysis to retrieve (e.g., `environmental`, `social`). */
|
|
3040
3933
|
section_type?: BridgeWiseESGSectionTypeEnum;
|
|
3041
3934
|
/**
|
|
3042
3935
|
* Show All
|
|
@@ -3054,7 +3947,6 @@ export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
|
3054
3947
|
*/
|
|
3055
3948
|
getCompanyForecastsMsa(companyId: number, query?: {
|
|
3056
3949
|
/**
|
|
3057
|
-
* Language
|
|
3058
3950
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3059
3951
|
* @default "en-US"
|
|
3060
3952
|
*/
|
|
@@ -3074,29 +3966,94 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
3074
3966
|
*/
|
|
3075
3967
|
getCompanyForecasts(companyId: number, query?: {
|
|
3076
3968
|
/**
|
|
3077
|
-
* Language
|
|
3078
3969
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3079
3970
|
* @default "en-US"
|
|
3080
3971
|
*/
|
|
3081
3972
|
language?: BridgeWiseLanguageEnum;
|
|
3973
|
+
/** Desired forecast type. */
|
|
3974
|
+
forecast_type?: BridgeWiseForecastType;
|
|
3082
3975
|
/**
|
|
3083
|
-
*
|
|
3084
|
-
*
|
|
3976
|
+
* Page
|
|
3977
|
+
* Define the page number for pagination.
|
|
3978
|
+
* @exclusiveMin 0
|
|
3085
3979
|
*/
|
|
3086
|
-
|
|
3980
|
+
page?: number;
|
|
3981
|
+
/**
|
|
3982
|
+
* Page Size
|
|
3983
|
+
* Define the number of records per page for pagination purposes.
|
|
3984
|
+
* @exclusiveMin 0
|
|
3985
|
+
*/
|
|
3986
|
+
page_size?: number;
|
|
3987
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
3988
|
+
}
|
|
3989
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3990
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3991
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3992
|
+
/**
|
|
3993
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3994
|
+
* @tags Company Market Data
|
|
3995
|
+
* @name GetCompanyMarketData
|
|
3996
|
+
* @summary Get Company Market Data
|
|
3997
|
+
* @request GET:/companies/{company_id}/market
|
|
3998
|
+
* @secure
|
|
3999
|
+
*/
|
|
4000
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
4001
|
+
/**
|
|
4002
|
+
* Trading Item Id
|
|
4003
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4004
|
+
*/
|
|
4005
|
+
trading_item_id?: number | null;
|
|
4006
|
+
/**
|
|
4007
|
+
* Date Ge
|
|
4008
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4009
|
+
*/
|
|
4010
|
+
date__ge?: string | null;
|
|
4011
|
+
/**
|
|
4012
|
+
* Date Le
|
|
4013
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4014
|
+
*/
|
|
4015
|
+
date__le?: string | null;
|
|
4016
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4017
|
+
/**
|
|
4018
|
+
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4019
|
+
* @tags Company Market Data
|
|
4020
|
+
* @name GetCompanyMarketStatistics
|
|
4021
|
+
* @summary Get Company Market Statistics
|
|
4022
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
4023
|
+
* @secure
|
|
4024
|
+
*/
|
|
4025
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4026
|
+
/**
|
|
4027
|
+
* Trading Item Id
|
|
4028
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4029
|
+
*/
|
|
4030
|
+
trading_item_id?: number | null;
|
|
4031
|
+
/**
|
|
4032
|
+
* Identifier In
|
|
4033
|
+
* Specify a list of external identifiers.
|
|
4034
|
+
*/
|
|
4035
|
+
identifier__in?: string | null;
|
|
4036
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4037
|
+
/**
|
|
4038
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4039
|
+
* @tags Company Market Data
|
|
4040
|
+
* @name GetTradingItems
|
|
4041
|
+
* @summary Get Trading Items
|
|
4042
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
4043
|
+
* @secure
|
|
4044
|
+
*/
|
|
4045
|
+
getTradingItems(companyId: number, query?: {
|
|
3087
4046
|
/**
|
|
3088
|
-
*
|
|
3089
|
-
*
|
|
3090
|
-
* @exclusiveMin 0
|
|
4047
|
+
* Primary Flag
|
|
4048
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3091
4049
|
*/
|
|
3092
|
-
|
|
4050
|
+
primary_flag?: boolean;
|
|
3093
4051
|
/**
|
|
3094
|
-
*
|
|
3095
|
-
*
|
|
3096
|
-
* @exclusiveMin 0
|
|
4052
|
+
* Security Primary Flag
|
|
4053
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3097
4054
|
*/
|
|
3098
|
-
|
|
3099
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4055
|
+
security_primary_flag?: boolean;
|
|
4056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3100
4057
|
}
|
|
3101
4058
|
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
3102
4059
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3111,7 +4068,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3111
4068
|
*/
|
|
3112
4069
|
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
3113
4070
|
/**
|
|
3114
|
-
* Language
|
|
3115
4071
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3116
4072
|
* @default "en-US"
|
|
3117
4073
|
*/
|
|
@@ -3132,15 +4088,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3132
4088
|
*/
|
|
3133
4089
|
getCompanyFundamentalParagraphs(companyId: number, query?: {
|
|
3134
4090
|
/**
|
|
3135
|
-
* Language
|
|
3136
4091
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3137
4092
|
* @default "en-US"
|
|
3138
4093
|
*/
|
|
3139
4094
|
language?: BridgeWiseLanguageEnum;
|
|
3140
|
-
/**
|
|
3141
|
-
* Section Type
|
|
3142
|
-
* Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
|
|
3143
|
-
*/
|
|
4095
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
3144
4096
|
section_type?: BridgeWiseFundamentalParagraphSectionTypeEnum;
|
|
3145
4097
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
3146
4098
|
/**
|
|
@@ -3153,15 +4105,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3153
4105
|
*/
|
|
3154
4106
|
getCompanyFundamentalParameters(companyId: number, query?: {
|
|
3155
4107
|
/**
|
|
3156
|
-
* Language
|
|
3157
4108
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3158
4109
|
* @default "en-US"
|
|
3159
4110
|
*/
|
|
3160
4111
|
language?: BridgeWiseLanguageEnum;
|
|
3161
|
-
/**
|
|
3162
|
-
* Section Type
|
|
3163
|
-
* Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
|
|
3164
|
-
*/
|
|
4112
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
3165
4113
|
section_type?: BridgeWiseFundamentalSectionTypeEnum;
|
|
3166
4114
|
/**
|
|
3167
4115
|
* Has Score
|
|
@@ -3180,7 +4128,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3180
4128
|
*/
|
|
3181
4129
|
quarter?: number;
|
|
3182
4130
|
/**
|
|
3183
|
-
* Period Type
|
|
3184
4131
|
* Define the data period format (e.g., TTM, Quarterly, Annual).
|
|
3185
4132
|
* @default "last_12_month"
|
|
3186
4133
|
*/
|
|
@@ -3211,15 +4158,11 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3211
4158
|
*/
|
|
3212
4159
|
getCompanyFundamentalSections(companyId: number, query?: {
|
|
3213
4160
|
/**
|
|
3214
|
-
* Language
|
|
3215
4161
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3216
4162
|
* @default "en-US"
|
|
3217
4163
|
*/
|
|
3218
4164
|
language?: BridgeWiseLanguageEnum;
|
|
3219
|
-
/**
|
|
3220
|
-
* Section Type
|
|
3221
|
-
* Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`).
|
|
3222
|
-
*/
|
|
4165
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
3223
4166
|
section_type?: BridgeWiseFundamentalSectionTypeEnum;
|
|
3224
4167
|
/**
|
|
3225
4168
|
* Show All
|
|
@@ -3253,75 +4196,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3253
4196
|
date__lte?: string;
|
|
3254
4197
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3255
4198
|
}
|
|
3256
|
-
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3257
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3258
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3259
|
-
/**
|
|
3260
|
-
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3261
|
-
* @tags Company Market Data
|
|
3262
|
-
* @name GetCompanyMarketData
|
|
3263
|
-
* @summary Get Company Market Data
|
|
3264
|
-
* @request GET:/companies/{company_id}/market
|
|
3265
|
-
* @secure
|
|
3266
|
-
*/
|
|
3267
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
3268
|
-
/**
|
|
3269
|
-
* Trading Item Id
|
|
3270
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3271
|
-
*/
|
|
3272
|
-
trading_item_id?: number | null;
|
|
3273
|
-
/**
|
|
3274
|
-
* Date Ge
|
|
3275
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3276
|
-
*/
|
|
3277
|
-
date__ge?: string | null;
|
|
3278
|
-
/**
|
|
3279
|
-
* Date Le
|
|
3280
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3281
|
-
*/
|
|
3282
|
-
date__le?: string | null;
|
|
3283
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3284
|
-
/**
|
|
3285
|
-
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
3286
|
-
* @tags Company Market Data
|
|
3287
|
-
* @name GetCompanyMarketStatistics
|
|
3288
|
-
* @summary Get Company Market Statistics
|
|
3289
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
3290
|
-
* @secure
|
|
3291
|
-
*/
|
|
3292
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3293
|
-
/**
|
|
3294
|
-
* Trading Item Id
|
|
3295
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3296
|
-
*/
|
|
3297
|
-
trading_item_id?: number | null;
|
|
3298
|
-
/**
|
|
3299
|
-
* Identifier In
|
|
3300
|
-
* Specify a list of external identifiers.
|
|
3301
|
-
*/
|
|
3302
|
-
identifier__in?: string | null;
|
|
3303
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
3304
|
-
/**
|
|
3305
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3306
|
-
* @tags Company Market Data
|
|
3307
|
-
* @name GetTradingItems
|
|
3308
|
-
* @summary Get Trading Items
|
|
3309
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
3310
|
-
* @secure
|
|
3311
|
-
*/
|
|
3312
|
-
getTradingItems(companyId: number, query?: {
|
|
3313
|
-
/**
|
|
3314
|
-
* Primary Flag
|
|
3315
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3316
|
-
*/
|
|
3317
|
-
primary_flag?: BridgeWiseStringBooleanEnum;
|
|
3318
|
-
/**
|
|
3319
|
-
* Security Primary Flag
|
|
3320
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3321
|
-
*/
|
|
3322
|
-
security_primary_flag?: BridgeWiseStringBooleanEnum;
|
|
3323
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3324
|
-
}
|
|
3325
4199
|
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
3326
4200
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3327
4201
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3345,18 +4219,17 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3345
4219
|
* Published Date Gte
|
|
3346
4220
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3347
4221
|
* @format date
|
|
3348
|
-
* @default "2025-
|
|
4222
|
+
* @default "2025-06-02"
|
|
3349
4223
|
*/
|
|
3350
4224
|
published_date__gte?: string;
|
|
3351
4225
|
/**
|
|
3352
4226
|
* Published Date Lte
|
|
3353
4227
|
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3354
4228
|
* @format date
|
|
3355
|
-
* @default "2025-
|
|
4229
|
+
* @default "2025-06-02"
|
|
3356
4230
|
*/
|
|
3357
4231
|
published_date__lte?: string;
|
|
3358
4232
|
/**
|
|
3359
|
-
* Sort By
|
|
3360
4233
|
* Specify the field by which to sort the results.
|
|
3361
4234
|
* @default "publication_date"
|
|
3362
4235
|
*/
|
|
@@ -3389,14 +4262,14 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
3389
4262
|
* Published Date Gte
|
|
3390
4263
|
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3391
4264
|
* @format date
|
|
3392
|
-
* @default "2025-
|
|
4265
|
+
* @default "2025-06-02"
|
|
3393
4266
|
*/
|
|
3394
4267
|
published_date__gte?: string;
|
|
3395
4268
|
/**
|
|
3396
4269
|
* Published Date Lte
|
|
3397
4270
|
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3398
4271
|
* @format date
|
|
3399
|
-
* @default "2025-
|
|
4272
|
+
* @default "2025-06-02"
|
|
3400
4273
|
*/
|
|
3401
4274
|
published_date__lte?: string;
|
|
3402
4275
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
@@ -3414,7 +4287,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3414
4287
|
*/
|
|
3415
4288
|
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
3416
4289
|
/**
|
|
3417
|
-
* Language
|
|
3418
4290
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3419
4291
|
* @default "en-US"
|
|
3420
4292
|
*/
|
|
@@ -3435,7 +4307,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3435
4307
|
*/
|
|
3436
4308
|
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3437
4309
|
/**
|
|
3438
|
-
* Language
|
|
3439
4310
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3440
4311
|
* @default "en-US"
|
|
3441
4312
|
*/
|
|
@@ -3456,7 +4327,6 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3456
4327
|
*/
|
|
3457
4328
|
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
3458
4329
|
/**
|
|
3459
|
-
* Language
|
|
3460
4330
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3461
4331
|
* @default "en-US"
|
|
3462
4332
|
*/
|
|
@@ -3485,13 +4355,9 @@ export class Metadata<HandleError extends boolean = boolean> {
|
|
|
3485
4355
|
* @secure
|
|
3486
4356
|
*/
|
|
3487
4357
|
getCompanyFilters(query: {
|
|
3488
|
-
/**
|
|
3489
|
-
* Type
|
|
3490
|
-
* Desired filter type.
|
|
3491
|
-
*/
|
|
4358
|
+
/** Desired filter type. */
|
|
3492
4359
|
type: BridgeWiseCompanyFilterType;
|
|
3493
4360
|
/**
|
|
3494
|
-
* Language
|
|
3495
4361
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3496
4362
|
* @default "en-US"
|
|
3497
4363
|
*/
|
|
@@ -3526,7 +4392,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3526
4392
|
*/
|
|
3527
4393
|
sort_by?: string;
|
|
3528
4394
|
/**
|
|
3529
|
-
* Language
|
|
3530
4395
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3531
4396
|
* @default "en-US"
|
|
3532
4397
|
*/
|
|
@@ -3882,7 +4747,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3882
4747
|
*/
|
|
3883
4748
|
getFund(fundId: number, query?: {
|
|
3884
4749
|
/**
|
|
3885
|
-
* Language
|
|
3886
4750
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3887
4751
|
* @default "en-US"
|
|
3888
4752
|
*/
|
|
@@ -3902,7 +4766,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3902
4766
|
*/
|
|
3903
4767
|
getFundAnalysis(fundId: number, query?: {
|
|
3904
4768
|
/**
|
|
3905
|
-
* Language
|
|
3906
4769
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3907
4770
|
* @default "en-US"
|
|
3908
4771
|
*/
|
|
@@ -3933,7 +4796,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3933
4796
|
*/
|
|
3934
4797
|
getFundsParagraphs(fundId: number, query?: {
|
|
3935
4798
|
/**
|
|
3936
|
-
* Language
|
|
3937
4799
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3938
4800
|
* @default "en-US"
|
|
3939
4801
|
*/
|
|
@@ -3959,7 +4821,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3959
4821
|
*/
|
|
3960
4822
|
getFundParameters(fundId: number, query?: {
|
|
3961
4823
|
/**
|
|
3962
|
-
* Language
|
|
3963
4824
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3964
4825
|
* @default "en-US"
|
|
3965
4826
|
*/
|
|
@@ -3990,7 +4851,6 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
3990
4851
|
*/
|
|
3991
4852
|
quarter?: number;
|
|
3992
4853
|
/**
|
|
3993
|
-
* Language
|
|
3994
4854
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3995
4855
|
* @default "en-US"
|
|
3996
4856
|
*/
|
|
@@ -4015,15 +4875,11 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4015
4875
|
*/
|
|
4016
4876
|
getCompositions(fundId: number, query?: {
|
|
4017
4877
|
/**
|
|
4018
|
-
* Language
|
|
4019
4878
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4020
4879
|
* @default "en-US"
|
|
4021
4880
|
*/
|
|
4022
4881
|
language?: BridgeWiseLanguageEnum;
|
|
4023
|
-
/**
|
|
4024
|
-
* Composition Type
|
|
4025
|
-
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4026
|
-
*/
|
|
4882
|
+
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
4027
4883
|
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
4028
4884
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
4029
4885
|
/**
|
|
@@ -4036,13 +4892,11 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4036
4892
|
*/
|
|
4037
4893
|
getHoldingStatistics(fundId: number, query?: {
|
|
4038
4894
|
/**
|
|
4039
|
-
* Language
|
|
4040
4895
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4041
4896
|
* @default "en-US"
|
|
4042
4897
|
*/
|
|
4043
4898
|
language?: BridgeWiseLanguageEnum;
|
|
4044
4899
|
/**
|
|
4045
|
-
* Composition Type
|
|
4046
4900
|
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4047
4901
|
* @default "stocks"
|
|
4048
4902
|
*/
|
|
@@ -4070,13 +4924,11 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4070
4924
|
*/
|
|
4071
4925
|
getHoldings(fundId: number, query?: {
|
|
4072
4926
|
/**
|
|
4073
|
-
* Language
|
|
4074
4927
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4075
4928
|
* @default "en-US"
|
|
4076
4929
|
*/
|
|
4077
4930
|
language?: BridgeWiseLanguageEnum;
|
|
4078
4931
|
/**
|
|
4079
|
-
* Composition Type
|
|
4080
4932
|
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4081
4933
|
* @default "stocks"
|
|
4082
4934
|
*/
|
|
@@ -4095,30 +4947,39 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4095
4947
|
page_size?: number;
|
|
4096
4948
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4097
4949
|
}
|
|
4098
|
-
export class
|
|
4950
|
+
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
4099
4951
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4100
4952
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4101
4953
|
/**
|
|
4102
|
-
* @description
|
|
4103
|
-
* @tags
|
|
4104
|
-
* @name
|
|
4105
|
-
* @summary Get
|
|
4106
|
-
* @request GET:/
|
|
4954
|
+
* @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
|
|
4955
|
+
* @tags Sector Analysis
|
|
4956
|
+
* @name GetSectorAnalysis
|
|
4957
|
+
* @summary Get Sector Analysis
|
|
4958
|
+
* @request GET:/sectors/{sector_id}/analysis
|
|
4107
4959
|
* @secure
|
|
4108
4960
|
*/
|
|
4109
|
-
|
|
4961
|
+
getSectorAnalysis(sectorId: number, query?: {
|
|
4110
4962
|
/**
|
|
4111
|
-
*
|
|
4112
|
-
*
|
|
4963
|
+
* Year
|
|
4964
|
+
* Specify the year for which the analysis is requested.
|
|
4113
4965
|
*/
|
|
4114
|
-
|
|
4966
|
+
year?: number;
|
|
4967
|
+
/**
|
|
4968
|
+
* Quarter
|
|
4969
|
+
* Specify the quarter for which the analysis is requested.
|
|
4970
|
+
*/
|
|
4971
|
+
quarter?: number;
|
|
4115
4972
|
/**
|
|
4116
|
-
* Language
|
|
4117
4973
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4118
4974
|
* @default "en-US"
|
|
4119
4975
|
*/
|
|
4120
4976
|
language?: BridgeWiseLanguageEnum;
|
|
4121
|
-
|
|
4977
|
+
/**
|
|
4978
|
+
* Limit
|
|
4979
|
+
* Number of sector strength periods to be returned (default is 1).
|
|
4980
|
+
*/
|
|
4981
|
+
limit?: number;
|
|
4982
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
4122
4983
|
}
|
|
4123
4984
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
4124
4985
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4163,10 +5024,7 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4163
5024
|
* Specify the current value reflecting the policy change
|
|
4164
5025
|
*/
|
|
4165
5026
|
current_value?: number | boolean;
|
|
4166
|
-
/**
|
|
4167
|
-
* Event Type
|
|
4168
|
-
* Type of event that is being requested.
|
|
4169
|
-
*/
|
|
5027
|
+
/** Type of event that is being requested. */
|
|
4170
5028
|
event_type?: BridgeWiseEventTypeEnum;
|
|
4171
5029
|
/**
|
|
4172
5030
|
* Size
|
|
@@ -4296,6 +5154,110 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4296
5154
|
*/
|
|
4297
5155
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4298
5156
|
}
|
|
5157
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5158
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5159
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5160
|
+
/**
|
|
5161
|
+
* @description Get list of tenant identifiers
|
|
5162
|
+
* @tags Tenant Identifiers
|
|
5163
|
+
* @name GetTenantIdentifiers
|
|
5164
|
+
* @summary Get Tenant Identifiers
|
|
5165
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5166
|
+
* @secure
|
|
5167
|
+
*/
|
|
5168
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
5169
|
+
/** Tenant custom identifier status. */
|
|
5170
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5171
|
+
/**
|
|
5172
|
+
* Page
|
|
5173
|
+
* Define the page number for the results.
|
|
5174
|
+
* @default 1
|
|
5175
|
+
* @example 1
|
|
5176
|
+
*/
|
|
5177
|
+
page?: number;
|
|
5178
|
+
/**
|
|
5179
|
+
* Page Size
|
|
5180
|
+
* Define the maximum number of results to retrieve.
|
|
5181
|
+
* @default 20
|
|
5182
|
+
* @example 10
|
|
5183
|
+
*/
|
|
5184
|
+
page_size?: number;
|
|
5185
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5186
|
+
/**
|
|
5187
|
+
* @description Create a new identifier for a tenant
|
|
5188
|
+
* @tags Tenant Identifiers
|
|
5189
|
+
* @name CreateTenantIdentifier
|
|
5190
|
+
* @summary Create Tenant Identifier
|
|
5191
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5192
|
+
* @secure
|
|
5193
|
+
*/
|
|
5194
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5195
|
+
/**
|
|
5196
|
+
* @description Update an existing identifier for a tenant
|
|
5197
|
+
* @tags Tenant Identifiers
|
|
5198
|
+
* @name UpdateTenantIdentifier
|
|
5199
|
+
* @summary Update Tenant Identifier
|
|
5200
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5201
|
+
* @secure
|
|
5202
|
+
*/
|
|
5203
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5204
|
+
/**
|
|
5205
|
+
* @description Delete identifier for a tenant
|
|
5206
|
+
* @tags Tenant Identifiers
|
|
5207
|
+
* @name DeleteTenantIdentifier
|
|
5208
|
+
* @summary Delete Tenant Identifier
|
|
5209
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5210
|
+
* @secure
|
|
5211
|
+
*/
|
|
5212
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5213
|
+
}
|
|
5214
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5215
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5216
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5217
|
+
/**
|
|
5218
|
+
* @tags Users
|
|
5219
|
+
* @name Authenticate
|
|
5220
|
+
* @summary Authenticate
|
|
5221
|
+
* @request POST:/users/authenticate
|
|
5222
|
+
* @secure
|
|
5223
|
+
*/
|
|
5224
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5225
|
+
/**
|
|
5226
|
+
* @tags Users
|
|
5227
|
+
* @name FetchClientDetails
|
|
5228
|
+
* @summary Fetch Client Details
|
|
5229
|
+
* @request GET:/users/machine
|
|
5230
|
+
* @secure
|
|
5231
|
+
*/
|
|
5232
|
+
fetchClientDetails(headers: {
|
|
5233
|
+
/** Authorization */
|
|
5234
|
+
authorization: string;
|
|
5235
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5236
|
+
}
|
|
5237
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5238
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5239
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5240
|
+
/**
|
|
5241
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5242
|
+
* @tags Fund ESG Analysis
|
|
5243
|
+
* @name GetFundEsgAnalysis
|
|
5244
|
+
* @summary Get Fund Esg Analysis
|
|
5245
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5246
|
+
* @secure
|
|
5247
|
+
*/
|
|
5248
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5249
|
+
/**
|
|
5250
|
+
* Limit
|
|
5251
|
+
* Number of historical periods to be returned (default is 1).
|
|
5252
|
+
*/
|
|
5253
|
+
limit?: number;
|
|
5254
|
+
/**
|
|
5255
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5256
|
+
* @default "en-US"
|
|
5257
|
+
*/
|
|
5258
|
+
language?: BridgeWiseLanguageEnum;
|
|
5259
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5260
|
+
}
|
|
4299
5261
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
4300
5262
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4301
5263
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4309,7 +5271,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4309
5271
|
*/
|
|
4310
5272
|
getSegmentParameters(fundId: number, query?: {
|
|
4311
5273
|
/**
|
|
4312
|
-
* Language
|
|
4313
5274
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4314
5275
|
* @default "en-US"
|
|
4315
5276
|
*/
|
|
@@ -4324,10 +5285,7 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4324
5285
|
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
4325
5286
|
*/
|
|
4326
5287
|
segment_type?: string;
|
|
4327
|
-
/**
|
|
4328
|
-
* Parameter Type
|
|
4329
|
-
* Desired segment parameter type.
|
|
4330
|
-
*/
|
|
5288
|
+
/** Desired segment parameter type. */
|
|
4331
5289
|
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
4332
5290
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
4333
5291
|
/**
|
|
@@ -4340,7 +5298,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4340
5298
|
*/
|
|
4341
5299
|
getSegment(fundId: number, query?: {
|
|
4342
5300
|
/**
|
|
4343
|
-
* Language
|
|
4344
5301
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4345
5302
|
* @default "en-US"
|
|
4346
5303
|
*/
|
|
@@ -4352,29 +5309,6 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4352
5309
|
segment?: string;
|
|
4353
5310
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4354
5311
|
}
|
|
4355
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
4356
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4357
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4358
|
-
/**
|
|
4359
|
-
* @tags Users
|
|
4360
|
-
* @name Authenticate
|
|
4361
|
-
* @summary Authenticate
|
|
4362
|
-
* @request POST:/users/authenticate
|
|
4363
|
-
* @secure
|
|
4364
|
-
*/
|
|
4365
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4366
|
-
/**
|
|
4367
|
-
* @tags Users
|
|
4368
|
-
* @name FetchClientDetails
|
|
4369
|
-
* @summary Fetch Client Details
|
|
4370
|
-
* @request GET:/users/machine
|
|
4371
|
-
* @secure
|
|
4372
|
-
*/
|
|
4373
|
-
fetchClientDetails(headers: {
|
|
4374
|
-
/** Authorization */
|
|
4375
|
-
authorization: string;
|
|
4376
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4377
|
-
}
|
|
4378
5312
|
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
4379
5313
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4380
5314
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4423,16 +5357,39 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
4423
5357
|
*/
|
|
4424
5358
|
identifier__in?: string | null;
|
|
4425
5359
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5360
|
+
/**
|
|
5361
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5362
|
+
* @tags Fund Market Data
|
|
5363
|
+
* @name GetFundTradingItems
|
|
5364
|
+
* @summary Get Fund Trading Items
|
|
5365
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
5366
|
+
* @secure
|
|
5367
|
+
*/
|
|
5368
|
+
getFundTradingItems(fundId: number, query?: {
|
|
5369
|
+
/**
|
|
5370
|
+
* Primary Flag
|
|
5371
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5372
|
+
*/
|
|
5373
|
+
primary_flag?: boolean;
|
|
5374
|
+
/**
|
|
5375
|
+
* Security Primary Flag
|
|
5376
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
5377
|
+
*/
|
|
5378
|
+
security_primary_flag?: boolean;
|
|
5379
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
4426
5380
|
}
|
|
4427
5381
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4428
5382
|
readonly config: JwtClientConfig<HandleError>;
|
|
4429
5383
|
activities: Activities<HandleError>;
|
|
5384
|
+
bridget: Bridget<HandleError>;
|
|
5385
|
+
bwc: Bwc<HandleError>;
|
|
4430
5386
|
companyMarketData: CompanyMarketData<HandleError>;
|
|
4431
5387
|
companyMetadata: CompanyMetadata<HandleError>;
|
|
4432
5388
|
companyNews: CompanyNews<HandleError>;
|
|
4433
5389
|
consensusAnalysts: ConsensusAnalysts<HandleError>;
|
|
4434
5390
|
earningCalls: EarningCalls<HandleError>;
|
|
4435
5391
|
esgAnalysis: EsgAnalysis<HandleError>;
|
|
5392
|
+
forecasts: Forecasts<HandleError>;
|
|
4436
5393
|
fundamentalAnalysis: FundamentalAnalysis<HandleError>;
|
|
4437
5394
|
fundAnalysis: FundAnalysis<HandleError>;
|
|
4438
5395
|
fundEsgAnalysis: FundEsgAnalysis<HandleError>;
|
|
@@ -4441,8 +5398,12 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
4441
5398
|
holdings: Holdings<HandleError>;
|
|
4442
5399
|
logos: Logos<HandleError>;
|
|
4443
5400
|
metadata: Metadata<HandleError>;
|
|
5401
|
+
sectorAnalysis: SectorAnalysis<HandleError>;
|
|
4444
5402
|
segmentations: Segmentations<HandleError>;
|
|
4445
5403
|
technicalAnalysis: TechnicalAnalysis<HandleError>;
|
|
5404
|
+
tenantIdentifiers: TenantIdentifiers<HandleError>;
|
|
5405
|
+
tenants: Tenants<HandleError>;
|
|
5406
|
+
users: Users<HandleError>;
|
|
4446
5407
|
constructor(config: JwtClientConfig<HandleError>);
|
|
4447
5408
|
}
|
|
4448
5409
|
|