@orbis-systems/orbis-api-clients 0.7.7 → 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 +65 -48
- 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 +1348 -406
- 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 +252 -227
- 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 +154 -154
- 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 +261 -259
- 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.map +1 -1
- package/dist/zerohash/index.esm.js.map +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 */
|
|
@@ -1699,7 +2137,8 @@ export enum BridgeWiseScoreMethodology {
|
|
|
1699
2137
|
Global = "global",
|
|
1700
2138
|
Industry = "industry",
|
|
1701
2139
|
Country = "country",
|
|
1702
|
-
Sector = "sector"
|
|
2140
|
+
Sector = "sector",
|
|
2141
|
+
Specific = "specific"
|
|
1703
2142
|
}
|
|
1704
2143
|
/** SectionsResponse */
|
|
1705
2144
|
export type BridgeWiseSectionsResponse = BridgeWiseSectionsResponseItem[];
|
|
@@ -1835,6 +2274,15 @@ export interface BridgeWiseCreateTenantApp {
|
|
|
1835
2274
|
/** Scopes */
|
|
1836
2275
|
scopes: string[];
|
|
1837
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
|
+
}
|
|
1838
2286
|
/** EventTypeEnum */
|
|
1839
2287
|
export enum BridgeWiseEventTypeEnum {
|
|
1840
2288
|
PolicyThreshold = "policy_threshold",
|
|
@@ -2018,6 +2466,25 @@ export interface BridgeWiseTenantApp {
|
|
|
2018
2466
|
*/
|
|
2019
2467
|
tenant_id: string;
|
|
2020
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
|
+
}
|
|
2021
2488
|
/**
|
|
2022
2489
|
* TenantResponse
|
|
2023
2490
|
* Model for tenant response.
|
|
@@ -2047,6 +2514,12 @@ export interface BridgeWiseTenantResponse {
|
|
|
2047
2514
|
*/
|
|
2048
2515
|
updated_at: string;
|
|
2049
2516
|
}
|
|
2517
|
+
/** UpdateTenantIdentifier */
|
|
2518
|
+
export interface BridgeWiseUpdateTenantIdentifier {
|
|
2519
|
+
/** Identifier */
|
|
2520
|
+
identifier?: string | null;
|
|
2521
|
+
status?: BridgeWiseTenantIdentifierStatusEnum | null;
|
|
2522
|
+
}
|
|
2050
2523
|
/** InvalidCredentials */
|
|
2051
2524
|
export interface BridgeWiseInvalidCredentials {
|
|
2052
2525
|
/**
|
|
@@ -2158,65 +2631,425 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
2158
2631
|
Gt = "gt",
|
|
2159
2632
|
Lt = "lt"
|
|
2160
2633
|
}
|
|
2161
|
-
|
|
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> {
|
|
2162
2671
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2163
2672
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2164
2673
|
/**
|
|
2165
|
-
* @
|
|
2166
|
-
* @
|
|
2167
|
-
* @
|
|
2168
|
-
* @summary Fetch Logos
|
|
2169
|
-
* @request GET:/companies/logos
|
|
2674
|
+
* @tags Bridget
|
|
2675
|
+
* @name QuestionCreate
|
|
2676
|
+
* @request POST:/bridget/v2/external/question
|
|
2170
2677
|
* @secure
|
|
2171
2678
|
*/
|
|
2172
|
-
|
|
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;
|
|
2173
2689
|
/**
|
|
2174
|
-
*
|
|
2175
|
-
*
|
|
2176
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2177
|
-
* @example "74822,83343211"
|
|
2690
|
+
* Date for filtering logs
|
|
2691
|
+
* @format date
|
|
2178
2692
|
*/
|
|
2179
|
-
|
|
2693
|
+
date: string;
|
|
2180
2694
|
/**
|
|
2181
|
-
*
|
|
2182
|
-
*
|
|
2183
|
-
* @min 1
|
|
2184
|
-
* @max 100
|
|
2185
|
-
* @default 50
|
|
2695
|
+
* End date for filtering logs
|
|
2696
|
+
* @format date
|
|
2186
2697
|
*/
|
|
2187
|
-
|
|
2698
|
+
end_date: string;
|
|
2699
|
+
/** Feedback type for filtering logs */
|
|
2700
|
+
feedback_type?: string;
|
|
2701
|
+
/** Session ID for filtering logs */
|
|
2702
|
+
session_id?: string;
|
|
2188
2703
|
/**
|
|
2189
|
-
*
|
|
2190
|
-
*
|
|
2191
|
-
* @min 1
|
|
2192
|
-
* @default 1
|
|
2704
|
+
* Start date for filtering logs
|
|
2705
|
+
* @format date
|
|
2193
2706
|
*/
|
|
2194
|
-
|
|
2195
|
-
|
|
2196
|
-
|
|
2197
|
-
|
|
2198
|
-
* @tags Logos
|
|
2199
|
-
* @name FetchLogo
|
|
2200
|
-
* @summary Fetch Logo
|
|
2201
|
-
* @request GET:/companies/{company_id}/logos
|
|
2202
|
-
* @secure
|
|
2203
|
-
*/
|
|
2204
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2707
|
+
start_date: string;
|
|
2708
|
+
/** User ID for filtering logs */
|
|
2709
|
+
user_id?: string;
|
|
2710
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
2205
2711
|
}
|
|
2206
|
-
export class
|
|
2712
|
+
export class Bwc<HandleError extends boolean = boolean> {
|
|
2207
2713
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2208
2714
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2209
2715
|
/**
|
|
2210
|
-
* @description
|
|
2211
|
-
* @tags
|
|
2212
|
-
* @name
|
|
2213
|
-
* @summary
|
|
2214
|
-
* @request GET:/
|
|
2716
|
+
* @description Get bulk data for a company
|
|
2717
|
+
* @tags bwc
|
|
2718
|
+
* @name Bulkdata
|
|
2719
|
+
* @summary Bulkdata
|
|
2720
|
+
* @request GET:/bulkdata/{name}
|
|
2215
2721
|
* @secure
|
|
2216
2722
|
*/
|
|
2217
|
-
|
|
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: {
|
|
2218
2742
|
/**
|
|
2219
|
-
*
|
|
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>>;
|
|
3038
|
+
}
|
|
3039
|
+
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3040
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3041
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3042
|
+
/**
|
|
3043
|
+
* @description Enables users to search and filter companies based on a range of financial and non-financial criteria, returning a detailed list of companies that match the specified parameters.
|
|
3044
|
+
* @tags Company Metadata
|
|
3045
|
+
* @name GetCompanies
|
|
3046
|
+
* @summary Get Companies
|
|
3047
|
+
* @request GET:/companies
|
|
3048
|
+
* @secure
|
|
3049
|
+
*/
|
|
3050
|
+
getCompanies(query?: {
|
|
3051
|
+
/**
|
|
3052
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2220
3053
|
* @default "en-US"
|
|
2221
3054
|
*/
|
|
2222
3055
|
language?: BridgeWiseLanguageEnum;
|
|
@@ -2895,6 +3728,80 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2895
3728
|
importance?: string;
|
|
2896
3729
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2897
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
|
+
}
|
|
3776
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
3777
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3778
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3779
|
+
/**
|
|
3780
|
+
* @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.
|
|
3781
|
+
* @tags Consensus Analysts
|
|
3782
|
+
* @name GetConsensusRatings
|
|
3783
|
+
* @summary Get Consensus Ratings
|
|
3784
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
3785
|
+
* @secure
|
|
3786
|
+
*/
|
|
3787
|
+
getConsensusRatings(companyId: number, query?: {
|
|
3788
|
+
/**
|
|
3789
|
+
* Trading Item Id
|
|
3790
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3791
|
+
*/
|
|
3792
|
+
trading_item_id?: number;
|
|
3793
|
+
/**
|
|
3794
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3795
|
+
* @default "en-US"
|
|
3796
|
+
*/
|
|
3797
|
+
language?: BridgeWiseLanguageEnum;
|
|
3798
|
+
/**
|
|
3799
|
+
* Date Gte
|
|
3800
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3801
|
+
*/
|
|
3802
|
+
date__gte?: string | null;
|
|
3803
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
3804
|
+
}
|
|
2898
3805
|
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2899
3806
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2900
3807
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3079,48 +3986,117 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
3079
3986
|
page_size?: number;
|
|
3080
3987
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
3081
3988
|
}
|
|
3082
|
-
export class
|
|
3989
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3083
3990
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3084
3991
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3085
3992
|
/**
|
|
3086
|
-
* @description
|
|
3087
|
-
* @tags
|
|
3088
|
-
* @name
|
|
3089
|
-
* @summary Get Company
|
|
3090
|
-
* @request GET:/companies/{company_id}/
|
|
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
|
|
3091
3998
|
* @secure
|
|
3092
3999
|
*/
|
|
3093
|
-
|
|
4000
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
3094
4001
|
/**
|
|
3095
|
-
*
|
|
3096
|
-
*
|
|
4002
|
+
* Trading Item Id
|
|
4003
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3097
4004
|
*/
|
|
3098
|
-
|
|
4005
|
+
trading_item_id?: number | null;
|
|
3099
4006
|
/**
|
|
3100
|
-
*
|
|
3101
|
-
*
|
|
4007
|
+
* Date Ge
|
|
4008
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3102
4009
|
*/
|
|
3103
|
-
|
|
3104
|
-
|
|
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>>;
|
|
3105
4017
|
/**
|
|
3106
|
-
* @description
|
|
3107
|
-
* @tags
|
|
3108
|
-
* @name
|
|
3109
|
-
* @summary Get Company
|
|
3110
|
-
* @request GET:/companies/{company_id}/
|
|
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
|
|
3111
4023
|
* @secure
|
|
3112
4024
|
*/
|
|
3113
|
-
|
|
4025
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3114
4026
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
*
|
|
4027
|
+
* Trading Item Id
|
|
4028
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3117
4029
|
*/
|
|
3118
|
-
|
|
3119
|
-
/**
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
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?: {
|
|
4046
|
+
/**
|
|
4047
|
+
* Primary Flag
|
|
4048
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4049
|
+
*/
|
|
4050
|
+
primary_flag?: boolean;
|
|
4051
|
+
/**
|
|
4052
|
+
* Security Primary Flag
|
|
4053
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4054
|
+
*/
|
|
4055
|
+
security_primary_flag?: boolean;
|
|
4056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4057
|
+
}
|
|
4058
|
+
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4059
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4060
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4061
|
+
/**
|
|
4062
|
+
* @description Returns Bridgewise's final fundamental analysis for a specified company, evaluating its fundamental strength.
|
|
4063
|
+
* @tags Fundamental Analysis
|
|
4064
|
+
* @name GetCompanyFundamentalAnalysis
|
|
4065
|
+
* @summary Get Company Fundamental Analysis
|
|
4066
|
+
* @request GET:/companies/{company_id}/fundamental-analysis
|
|
4067
|
+
* @secure
|
|
4068
|
+
*/
|
|
4069
|
+
getCompanyFundamentalAnalysis(companyId: number, query?: {
|
|
4070
|
+
/**
|
|
4071
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4072
|
+
* @default "en-US"
|
|
4073
|
+
*/
|
|
4074
|
+
language?: BridgeWiseLanguageEnum;
|
|
4075
|
+
/**
|
|
4076
|
+
* Show All
|
|
4077
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4078
|
+
*/
|
|
4079
|
+
show_all?: boolean;
|
|
4080
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundamentalAnalysisResponse, HandleError>>;
|
|
4081
|
+
/**
|
|
4082
|
+
* @description This endpoint provides detailed textual analyses focused on a company's financial health, including its profitability, balance sheet, cash flow and income statement.
|
|
4083
|
+
* @tags Fundamental Analysis
|
|
4084
|
+
* @name GetCompanyFundamentalParagraphs
|
|
4085
|
+
* @summary Get Company Fundamental Paragraphs
|
|
4086
|
+
* @request GET:/companies/{company_id}/fundamental-paragraphs
|
|
4087
|
+
* @secure
|
|
4088
|
+
*/
|
|
4089
|
+
getCompanyFundamentalParagraphs(companyId: number, query?: {
|
|
4090
|
+
/**
|
|
4091
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4092
|
+
* @default "en-US"
|
|
4093
|
+
*/
|
|
4094
|
+
language?: BridgeWiseLanguageEnum;
|
|
4095
|
+
/** Specify the component of the analysis to retrieve (e.g., `balance_sheet`, `cash_flow`). */
|
|
4096
|
+
section_type?: BridgeWiseFundamentalParagraphSectionTypeEnum;
|
|
4097
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseParagraph[], HandleError>>;
|
|
4098
|
+
/**
|
|
4099
|
+
* @description Offers an in-depth breakdown of the parameters used in the fundamental analysis, detailing more than 100 key metrics within the income statement, balance sheet and cash flow financial statements.
|
|
3124
4100
|
* @tags Fundamental Analysis
|
|
3125
4101
|
* @name GetCompanyFundamentalParameters
|
|
3126
4102
|
* @summary Get Company Fundamental Parameters
|
|
@@ -3220,104 +4196,6 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3220
4196
|
date__lte?: string;
|
|
3221
4197
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3222
4198
|
}
|
|
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
|
-
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3253
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3254
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3255
|
-
/**
|
|
3256
|
-
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3257
|
-
* @tags Company Market Data
|
|
3258
|
-
* @name GetCompanyMarketData
|
|
3259
|
-
* @summary Get Company Market Data
|
|
3260
|
-
* @request GET:/companies/{company_id}/market
|
|
3261
|
-
* @secure
|
|
3262
|
-
*/
|
|
3263
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
3264
|
-
/**
|
|
3265
|
-
* Trading Item Id
|
|
3266
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3267
|
-
*/
|
|
3268
|
-
trading_item_id?: number | null;
|
|
3269
|
-
/**
|
|
3270
|
-
* Date Ge
|
|
3271
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3272
|
-
*/
|
|
3273
|
-
date__ge?: string | null;
|
|
3274
|
-
/**
|
|
3275
|
-
* Date Le
|
|
3276
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3277
|
-
*/
|
|
3278
|
-
date__le?: string | null;
|
|
3279
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3280
|
-
/**
|
|
3281
|
-
* @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.
|
|
3282
|
-
* @tags Company Market Data
|
|
3283
|
-
* @name GetCompanyMarketStatistics
|
|
3284
|
-
* @summary Get Company Market Statistics
|
|
3285
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
3286
|
-
* @secure
|
|
3287
|
-
*/
|
|
3288
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3289
|
-
/**
|
|
3290
|
-
* Trading Item Id
|
|
3291
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3292
|
-
*/
|
|
3293
|
-
trading_item_id?: number | null;
|
|
3294
|
-
/**
|
|
3295
|
-
* Identifier In
|
|
3296
|
-
* Specify a list of external identifiers.
|
|
3297
|
-
*/
|
|
3298
|
-
identifier__in?: string | null;
|
|
3299
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
3300
|
-
/**
|
|
3301
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3302
|
-
* @tags Company Market Data
|
|
3303
|
-
* @name GetTradingItems
|
|
3304
|
-
* @summary Get Trading Items
|
|
3305
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
3306
|
-
* @secure
|
|
3307
|
-
*/
|
|
3308
|
-
getTradingItems(companyId: number, query?: {
|
|
3309
|
-
/**
|
|
3310
|
-
* Primary Flag
|
|
3311
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3312
|
-
*/
|
|
3313
|
-
primary_flag?: boolean;
|
|
3314
|
-
/**
|
|
3315
|
-
* Security Primary Flag
|
|
3316
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3317
|
-
*/
|
|
3318
|
-
security_primary_flag?: boolean;
|
|
3319
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3320
|
-
}
|
|
3321
4199
|
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
3322
4200
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3323
4201
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4069,237 +4947,70 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4069
4947
|
page_size?: number;
|
|
4070
4948
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4071
4949
|
}
|
|
4072
|
-
export class
|
|
4950
|
+
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
4073
4951
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4074
4952
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4075
4953
|
/**
|
|
4076
|
-
* @description
|
|
4077
|
-
* @tags
|
|
4078
|
-
* @name
|
|
4079
|
-
* @summary Get
|
|
4080
|
-
* @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
|
|
4081
4959
|
* @secure
|
|
4082
4960
|
*/
|
|
4083
|
-
|
|
4961
|
+
getSectorAnalysis(sectorId: number, query?: {
|
|
4084
4962
|
/**
|
|
4085
|
-
*
|
|
4086
|
-
*
|
|
4963
|
+
* Year
|
|
4964
|
+
* Specify the year for which the analysis is requested.
|
|
4087
4965
|
*/
|
|
4088
|
-
|
|
4966
|
+
year?: number;
|
|
4967
|
+
/**
|
|
4968
|
+
* Quarter
|
|
4969
|
+
* Specify the quarter for which the analysis is requested.
|
|
4970
|
+
*/
|
|
4971
|
+
quarter?: number;
|
|
4089
4972
|
/**
|
|
4090
4973
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4091
4974
|
* @default "en-US"
|
|
4092
4975
|
*/
|
|
4093
4976
|
language?: BridgeWiseLanguageEnum;
|
|
4094
|
-
|
|
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>>;
|
|
4095
4983
|
}
|
|
4096
|
-
export class
|
|
4984
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
4097
4985
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4098
4986
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4099
4987
|
/**
|
|
4100
|
-
* @
|
|
4101
|
-
* @
|
|
4102
|
-
* @
|
|
4103
|
-
* @
|
|
4104
|
-
* @request GET:/funds/{fund_id}/market
|
|
4988
|
+
* @tags Tenants
|
|
4989
|
+
* @name FetchTenant
|
|
4990
|
+
* @summary Fetch Tenant
|
|
4991
|
+
* @request GET:/tenants/{tenant_id}
|
|
4105
4992
|
* @secure
|
|
4106
4993
|
*/
|
|
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>>;
|
|
4994
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
4124
4995
|
/**
|
|
4125
|
-
* @
|
|
4126
|
-
* @
|
|
4127
|
-
* @
|
|
4128
|
-
* @
|
|
4129
|
-
* @request GET:/funds/{fund_id}/market-statistics
|
|
4996
|
+
* @tags Tenants
|
|
4997
|
+
* @name GetHistoricalPolicyChanges
|
|
4998
|
+
* @summary Get Historical Policy Changes
|
|
4999
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
4130
5000
|
* @secure
|
|
4131
5001
|
*/
|
|
4132
|
-
|
|
5002
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
4133
5003
|
/**
|
|
4134
|
-
*
|
|
4135
|
-
* Specify a
|
|
5004
|
+
* Company Ids
|
|
5005
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5006
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5007
|
+
* @example "74822,83343211"
|
|
4136
5008
|
*/
|
|
4137
|
-
|
|
5009
|
+
company_ids?: string;
|
|
4138
5010
|
/**
|
|
4139
|
-
*
|
|
4140
|
-
* Specify
|
|
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;
|
|
4299
|
-
/**
|
|
4300
|
-
* Start Date Gte
|
|
4301
|
-
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
4302
|
-
* @format date
|
|
5011
|
+
* Start Date Gte
|
|
5012
|
+
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5013
|
+
* @format date
|
|
4303
5014
|
*/
|
|
4304
5015
|
start_date__gte?: string;
|
|
4305
5016
|
/**
|
|
@@ -4443,15 +5154,242 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4443
5154
|
*/
|
|
4444
5155
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4445
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
|
+
}
|
|
5261
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5262
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5263
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5264
|
+
/**
|
|
5265
|
+
* @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.
|
|
5266
|
+
* @tags Segmentations
|
|
5267
|
+
* @name GetSegmentParameters
|
|
5268
|
+
* @summary Get Segment Parameters
|
|
5269
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5270
|
+
* @secure
|
|
5271
|
+
*/
|
|
5272
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5273
|
+
/**
|
|
5274
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5275
|
+
* @default "en-US"
|
|
5276
|
+
*/
|
|
5277
|
+
language?: BridgeWiseLanguageEnum;
|
|
5278
|
+
/**
|
|
5279
|
+
* Segment
|
|
5280
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5281
|
+
*/
|
|
5282
|
+
segment?: string;
|
|
5283
|
+
/**
|
|
5284
|
+
* Segment Type
|
|
5285
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5286
|
+
*/
|
|
5287
|
+
segment_type?: string;
|
|
5288
|
+
/** Desired segment parameter type. */
|
|
5289
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5290
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5291
|
+
/**
|
|
5292
|
+
* @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.
|
|
5293
|
+
* @tags Segmentations
|
|
5294
|
+
* @name GetSegment
|
|
5295
|
+
* @summary Get Segment
|
|
5296
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5297
|
+
* @secure
|
|
5298
|
+
*/
|
|
5299
|
+
getSegment(fundId: number, query?: {
|
|
5300
|
+
/**
|
|
5301
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5302
|
+
* @default "en-US"
|
|
5303
|
+
*/
|
|
5304
|
+
language?: BridgeWiseLanguageEnum;
|
|
5305
|
+
/**
|
|
5306
|
+
* Segment
|
|
5307
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5308
|
+
*/
|
|
5309
|
+
segment?: string;
|
|
5310
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5311
|
+
}
|
|
5312
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5313
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5314
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5315
|
+
/**
|
|
5316
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5317
|
+
* @tags Fund Market Data
|
|
5318
|
+
* @name GetFundsMarketData
|
|
5319
|
+
* @summary Get Funds Market Data
|
|
5320
|
+
* @request GET:/funds/{fund_id}/market
|
|
5321
|
+
* @secure
|
|
5322
|
+
*/
|
|
5323
|
+
getFundsMarketData(fundId: number, query?: {
|
|
5324
|
+
/**
|
|
5325
|
+
* Trading Item Id
|
|
5326
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5327
|
+
*/
|
|
5328
|
+
trading_item_id?: number | null;
|
|
5329
|
+
/**
|
|
5330
|
+
* Date Ge
|
|
5331
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5332
|
+
*/
|
|
5333
|
+
date__ge?: string | null;
|
|
5334
|
+
/**
|
|
5335
|
+
* Date Le
|
|
5336
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5337
|
+
*/
|
|
5338
|
+
date__le?: string | null;
|
|
5339
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5340
|
+
/**
|
|
5341
|
+
* @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.
|
|
5342
|
+
* @tags Fund Market Data
|
|
5343
|
+
* @name GetFundsMarketStatistics
|
|
5344
|
+
* @summary Get Funds Market Statistics
|
|
5345
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
5346
|
+
* @secure
|
|
5347
|
+
*/
|
|
5348
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
5349
|
+
/**
|
|
5350
|
+
* Trading Item Id
|
|
5351
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5352
|
+
*/
|
|
5353
|
+
trading_item_id?: number | null;
|
|
5354
|
+
/**
|
|
5355
|
+
* Identifier In
|
|
5356
|
+
* Specify a list of external identifiers.
|
|
5357
|
+
*/
|
|
5358
|
+
identifier__in?: string | null;
|
|
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>>;
|
|
5380
|
+
}
|
|
4446
5381
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4447
5382
|
readonly config: JwtClientConfig<HandleError>;
|
|
4448
5383
|
activities: Activities<HandleError>;
|
|
5384
|
+
bridget: Bridget<HandleError>;
|
|
5385
|
+
bwc: Bwc<HandleError>;
|
|
4449
5386
|
companyMarketData: CompanyMarketData<HandleError>;
|
|
4450
5387
|
companyMetadata: CompanyMetadata<HandleError>;
|
|
4451
5388
|
companyNews: CompanyNews<HandleError>;
|
|
4452
5389
|
consensusAnalysts: ConsensusAnalysts<HandleError>;
|
|
4453
5390
|
earningCalls: EarningCalls<HandleError>;
|
|
4454
5391
|
esgAnalysis: EsgAnalysis<HandleError>;
|
|
5392
|
+
forecasts: Forecasts<HandleError>;
|
|
4455
5393
|
fundamentalAnalysis: FundamentalAnalysis<HandleError>;
|
|
4456
5394
|
fundAnalysis: FundAnalysis<HandleError>;
|
|
4457
5395
|
fundEsgAnalysis: FundEsgAnalysis<HandleError>;
|
|
@@ -4460,8 +5398,12 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
4460
5398
|
holdings: Holdings<HandleError>;
|
|
4461
5399
|
logos: Logos<HandleError>;
|
|
4462
5400
|
metadata: Metadata<HandleError>;
|
|
5401
|
+
sectorAnalysis: SectorAnalysis<HandleError>;
|
|
4463
5402
|
segmentations: Segmentations<HandleError>;
|
|
4464
5403
|
technicalAnalysis: TechnicalAnalysis<HandleError>;
|
|
5404
|
+
tenantIdentifiers: TenantIdentifiers<HandleError>;
|
|
5405
|
+
tenants: Tenants<HandleError>;
|
|
5406
|
+
users: Users<HandleError>;
|
|
4465
5407
|
constructor(config: JwtClientConfig<HandleError>);
|
|
4466
5408
|
}
|
|
4467
5409
|
|