@orbis-systems/orbis-api-clients 0.8.9 → 0.8.10
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 +504 -486
- 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 +1169 -742
- 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 +127 -127
- 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 +83 -83
- 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 +1718 -1689
- 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 +781 -659
- 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/package.json +1 -1
|
@@ -183,6 +183,12 @@ export enum BridgeWisePDFReportType {
|
|
|
183
183
|
Stock = "stock",
|
|
184
184
|
Fund = "fund"
|
|
185
185
|
}
|
|
186
|
+
/** TechnicalAnalysisTypeEnum */
|
|
187
|
+
export enum BridgeWiseTechnicalAnalysisTypeEnum {
|
|
188
|
+
Technical = "technical",
|
|
189
|
+
TechnicalShortTerm = "technical_short_term",
|
|
190
|
+
TechnicalLongTerm = "technical_long_term"
|
|
191
|
+
}
|
|
186
192
|
/** PeriodTypeEnum */
|
|
187
193
|
export enum BridgeWisePeriodTypeEnum {
|
|
188
194
|
Quarterly = "quarterly",
|
|
@@ -572,6 +578,46 @@ export enum BridgeWiseStringBooleanEnum {
|
|
|
572
578
|
True = "true",
|
|
573
579
|
False = "false"
|
|
574
580
|
}
|
|
581
|
+
/**
|
|
582
|
+
* * `ticker` - ticker
|
|
583
|
+
* * `company` - company
|
|
584
|
+
* * `sectors` - sectors
|
|
585
|
+
* * `industries` - industries
|
|
586
|
+
* * `locations` - locations
|
|
587
|
+
*/
|
|
588
|
+
export enum BridgeWiseTypeEnum {
|
|
589
|
+
Ticker = "ticker",
|
|
590
|
+
Company = "company",
|
|
591
|
+
Sectors = "sectors",
|
|
592
|
+
Industries = "industries",
|
|
593
|
+
Locations = "locations"
|
|
594
|
+
}
|
|
595
|
+
/**
|
|
596
|
+
* * `fund` - fund
|
|
597
|
+
* * `company` - company
|
|
598
|
+
*/
|
|
599
|
+
export enum BridgeWiseInstrumentTypeEnum {
|
|
600
|
+
Fund = "fund",
|
|
601
|
+
Company = "company"
|
|
602
|
+
}
|
|
603
|
+
/**
|
|
604
|
+
* * `fund` - fund
|
|
605
|
+
* * `tickerfund` - tickerfund
|
|
606
|
+
* * `ticker` - ticker
|
|
607
|
+
* * `company` - company
|
|
608
|
+
* * `sectors` - sectors
|
|
609
|
+
* * `industries` - industries
|
|
610
|
+
* * `locations` - locations
|
|
611
|
+
*/
|
|
612
|
+
export enum BridgeWiseInstrumentIdentifierTypeEnum {
|
|
613
|
+
Fund = "fund",
|
|
614
|
+
Tickerfund = "tickerfund",
|
|
615
|
+
Ticker = "ticker",
|
|
616
|
+
Company = "company",
|
|
617
|
+
Sectors = "sectors",
|
|
618
|
+
Industries = "industries",
|
|
619
|
+
Locations = "locations"
|
|
620
|
+
}
|
|
575
621
|
/** UniverseEnum */
|
|
576
622
|
export enum BridgeWiseUniverseEnum {
|
|
577
623
|
Industry = "industry",
|
|
@@ -979,6 +1025,54 @@ export interface BridgeWiseSectionItem {
|
|
|
979
1025
|
/** Section Params */
|
|
980
1026
|
section_params?: Record<string, any> | null;
|
|
981
1027
|
}
|
|
1028
|
+
export type BridgeWiseData = BridgeWiseDataFieldSerializerLegacy | BridgeWiseDataField;
|
|
1029
|
+
export interface BridgeWiseDataField {
|
|
1030
|
+
/**
|
|
1031
|
+
* Type of instrument, 'fund' or 'company' allowed.
|
|
1032
|
+
*
|
|
1033
|
+
* * `fund` - fund
|
|
1034
|
+
* * `company` - company
|
|
1035
|
+
*/
|
|
1036
|
+
instrument_type: BridgeWiseInstrumentTypeEnum;
|
|
1037
|
+
/** Instrument ID. */
|
|
1038
|
+
instrument_id: number;
|
|
1039
|
+
/**
|
|
1040
|
+
* Type of identifier.
|
|
1041
|
+
*
|
|
1042
|
+
* * `fund` - fund
|
|
1043
|
+
* * `tickerfund` - tickerfund
|
|
1044
|
+
* * `ticker` - ticker
|
|
1045
|
+
* * `company` - company
|
|
1046
|
+
* * `sectors` - sectors
|
|
1047
|
+
* * `industries` - industries
|
|
1048
|
+
* * `locations` - locations
|
|
1049
|
+
*/
|
|
1050
|
+
instrument_identifier_type: BridgeWiseInstrumentIdentifierTypeEnum;
|
|
1051
|
+
/**
|
|
1052
|
+
* Value of identifier itself.
|
|
1053
|
+
* @minLength 1
|
|
1054
|
+
*/
|
|
1055
|
+
instrument_identifier_value: string;
|
|
1056
|
+
}
|
|
1057
|
+
export interface BridgeWiseDataFieldSerializerLegacy {
|
|
1058
|
+
/** Company ID */
|
|
1059
|
+
company_id?: number;
|
|
1060
|
+
/**
|
|
1061
|
+
* Type of identifier.
|
|
1062
|
+
*
|
|
1063
|
+
* * `ticker` - ticker
|
|
1064
|
+
* * `company` - company
|
|
1065
|
+
* * `sectors` - sectors
|
|
1066
|
+
* * `industries` - industries
|
|
1067
|
+
* * `locations` - locations
|
|
1068
|
+
*/
|
|
1069
|
+
type: BridgeWiseTypeEnum;
|
|
1070
|
+
/**
|
|
1071
|
+
* Value of the identifier itself.
|
|
1072
|
+
* @minLength 1
|
|
1073
|
+
*/
|
|
1074
|
+
value: string;
|
|
1075
|
+
}
|
|
982
1076
|
export interface BridgeWiseExportResponse {
|
|
983
1077
|
results: BridgeWiseExportRow[];
|
|
984
1078
|
}
|
|
@@ -995,22 +1089,19 @@ export interface BridgeWiseExportRow {
|
|
|
995
1089
|
feedback_type: string;
|
|
996
1090
|
feedback_reason: string;
|
|
997
1091
|
answer_requested_by_user: boolean;
|
|
1092
|
+
companies_mentioned: any[];
|
|
1093
|
+
funds_mentioned: any[];
|
|
1094
|
+
alternative_assets_mentioned: any[];
|
|
998
1095
|
}
|
|
999
1096
|
export interface BridgeWiseExternalQuestionResponse {
|
|
1000
1097
|
message: string;
|
|
1001
1098
|
message_id: string;
|
|
1002
1099
|
}
|
|
1003
|
-
export interface
|
|
1004
|
-
/**
|
|
1005
|
-
|
|
1006
|
-
|
|
1007
|
-
|
|
1008
|
-
message: string;
|
|
1009
|
-
/**
|
|
1010
|
-
* Single chat session ID like: 9d932c94-a51e-429d-8a31-b51e31001eae
|
|
1011
|
-
* @maxLength 256
|
|
1012
|
-
*/
|
|
1013
|
-
session_id: string;
|
|
1100
|
+
export interface BridgeWiseSubmitQuestion {
|
|
1101
|
+
/** Additional data about a financial entity which is used as a part of predefined label. */
|
|
1102
|
+
data?: BridgeWiseData[];
|
|
1103
|
+
/** Dict containing arbitrary, client-defined key-value pairs */
|
|
1104
|
+
custom_data?: Record<string, any>;
|
|
1014
1105
|
/**
|
|
1015
1106
|
* Language type like 'en-US', 'he-IL', 'ja-JP'
|
|
1016
1107
|
*
|
|
@@ -1046,8 +1137,32 @@ export interface BridgeWiseQuestionsRequest {
|
|
|
1046
1137
|
* * `ru-RU` - ru
|
|
1047
1138
|
*/
|
|
1048
1139
|
language?: BridgeWiseLanguageEnum;
|
|
1049
|
-
/**
|
|
1050
|
-
|
|
1140
|
+
/**
|
|
1141
|
+
* Question to ask, for example: 'What are the latest news about Nvidia'?
|
|
1142
|
+
* @maxLength 2000
|
|
1143
|
+
*/
|
|
1144
|
+
message: string;
|
|
1145
|
+
/** @maxLength 256 */
|
|
1146
|
+
qa_model?: string | null;
|
|
1147
|
+
/**
|
|
1148
|
+
* @maxLength 256
|
|
1149
|
+
* @default "API"
|
|
1150
|
+
*/
|
|
1151
|
+
source?: string;
|
|
1152
|
+
/** @maxLength 256 */
|
|
1153
|
+
user_id?: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* Single chat session ID in the form of UUID like: '7c403155-ac49-4537-b324-f8eb531497c4'
|
|
1156
|
+
* @maxLength 256
|
|
1157
|
+
*/
|
|
1158
|
+
session_id: string;
|
|
1159
|
+
/** @default false */
|
|
1160
|
+
translate_answer?: boolean | null;
|
|
1161
|
+
/** @default false */
|
|
1162
|
+
disable_llms?: boolean | null;
|
|
1163
|
+
instrument_group_id?: number | null;
|
|
1164
|
+
/** @maxLength 256 */
|
|
1165
|
+
regulation_type?: string | null;
|
|
1051
1166
|
}
|
|
1052
1167
|
/**
|
|
1053
1168
|
* AnalysisResultV2
|
|
@@ -2697,7 +2812,7 @@ export interface BridgeWiseCompanyTechParameter {
|
|
|
2697
2812
|
/** Parameter Value */
|
|
2698
2813
|
parameter_value: number | null;
|
|
2699
2814
|
/** Score Group */
|
|
2700
|
-
score_group:
|
|
2815
|
+
score_group: number | null;
|
|
2701
2816
|
/** Score Group Text */
|
|
2702
2817
|
score_group_text: string | number | null;
|
|
2703
2818
|
/** Parameter Currency Iso3 */
|
|
@@ -2880,6 +2995,80 @@ export interface BridgeWiseDownloadPDFReportResponse {
|
|
|
2880
2995
|
*/
|
|
2881
2996
|
pdf_presigned_url: string;
|
|
2882
2997
|
}
|
|
2998
|
+
/** PortfolioAsset */
|
|
2999
|
+
export interface BridgeWisePortfolioAsset {
|
|
3000
|
+
/** Instrument Id */
|
|
3001
|
+
instrument_id: string;
|
|
3002
|
+
/** Asset Type */
|
|
3003
|
+
asset_type: string;
|
|
3004
|
+
/** Units */
|
|
3005
|
+
units?: number | null;
|
|
3006
|
+
/** Close Price Usd */
|
|
3007
|
+
close_price_usd?: number | null;
|
|
3008
|
+
/** Execution Price */
|
|
3009
|
+
execution_price?: number | null;
|
|
3010
|
+
/** Total Value Usd */
|
|
3011
|
+
total_value_usd?: number | null;
|
|
3012
|
+
/** Normalized Weight */
|
|
3013
|
+
normalized_weight?: number | null;
|
|
3014
|
+
/** Instrument Score */
|
|
3015
|
+
instrument_score?: number | null;
|
|
3016
|
+
/** Currency */
|
|
3017
|
+
currency?: string | null;
|
|
3018
|
+
}
|
|
3019
|
+
/** PortfolioItem */
|
|
3020
|
+
export interface BridgeWisePortfolioItem {
|
|
3021
|
+
/** Portfolio Id */
|
|
3022
|
+
portfolio_id: string;
|
|
3023
|
+
/** Account Id */
|
|
3024
|
+
account_id: string;
|
|
3025
|
+
/** Tenant Id */
|
|
3026
|
+
tenant_id: string;
|
|
3027
|
+
/** User Id */
|
|
3028
|
+
user_id: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* Business Date
|
|
3031
|
+
* @format date
|
|
3032
|
+
*/
|
|
3033
|
+
business_date: string;
|
|
3034
|
+
/** Base Currency */
|
|
3035
|
+
base_currency: string;
|
|
3036
|
+
metrics?: BridgeWisePortfolioScoreMetrics | null;
|
|
3037
|
+
/** Assets */
|
|
3038
|
+
assets?: BridgeWisePortfolioAsset[] | null;
|
|
3039
|
+
}
|
|
3040
|
+
/** PortfolioScoreItem */
|
|
3041
|
+
export interface BridgeWisePortfolioScoreItem {
|
|
3042
|
+
/** Tenant Id */
|
|
3043
|
+
tenant_id: string;
|
|
3044
|
+
/** User Id */
|
|
3045
|
+
user_id: string;
|
|
3046
|
+
/** Portfolio Id */
|
|
3047
|
+
portfolio_id: string;
|
|
3048
|
+
/**
|
|
3049
|
+
* Business Date
|
|
3050
|
+
* @format date
|
|
3051
|
+
*/
|
|
3052
|
+
business_date: string;
|
|
3053
|
+
metrics: BridgeWisePortfolioScoreMetrics;
|
|
3054
|
+
}
|
|
3055
|
+
/** PortfolioScoreMetrics */
|
|
3056
|
+
export interface BridgeWisePortfolioScoreMetrics {
|
|
3057
|
+
/** Analysis Score */
|
|
3058
|
+
analysis_score?: number | null;
|
|
3059
|
+
/** Decile */
|
|
3060
|
+
decile?: number | null;
|
|
3061
|
+
/** Tenant Median Score */
|
|
3062
|
+
tenant_median_score?: number | null;
|
|
3063
|
+
/** Tenant Average Score */
|
|
3064
|
+
tenant_average_score?: number | null;
|
|
3065
|
+
/** Tenant Portfolio Count */
|
|
3066
|
+
tenant_portfolio_count?: number | null;
|
|
3067
|
+
/** One Year Min Score */
|
|
3068
|
+
one_year_min_score?: number | null;
|
|
3069
|
+
/** One Year Max Score */
|
|
3070
|
+
one_year_max_score?: number | null;
|
|
3071
|
+
}
|
|
2883
3072
|
/** BondFlags */
|
|
2884
3073
|
export interface BridgeWiseBondFlags {
|
|
2885
3074
|
/** Is Active */
|
|
@@ -3607,6 +3796,42 @@ export interface BridgeWiseTargetPriceResponse {
|
|
|
3607
3796
|
/** Currency Iso3 */
|
|
3608
3797
|
currency_iso3: string;
|
|
3609
3798
|
}
|
|
3799
|
+
/**
|
|
3800
|
+
* TechAnalysisSectionItem
|
|
3801
|
+
* Individual section score in technical analysis.
|
|
3802
|
+
*/
|
|
3803
|
+
export interface BridgeWiseTechAnalysisSectionItem {
|
|
3804
|
+
/** Section Id */
|
|
3805
|
+
section_id: string;
|
|
3806
|
+
/** Section Name */
|
|
3807
|
+
section_name: string;
|
|
3808
|
+
/** Section Score */
|
|
3809
|
+
section_score: number;
|
|
3810
|
+
/** Section Score Group */
|
|
3811
|
+
section_score_group: number;
|
|
3812
|
+
/** Section Score Group Text */
|
|
3813
|
+
section_score_group_text: string;
|
|
3814
|
+
/** Section Sum */
|
|
3815
|
+
section_sum: number;
|
|
3816
|
+
/** Total Indicators */
|
|
3817
|
+
total_indicators: number;
|
|
3818
|
+
}
|
|
3819
|
+
/**
|
|
3820
|
+
* TechAnalysisSectionsResponse
|
|
3821
|
+
* Response model for technical analysis sections endpoint.
|
|
3822
|
+
*/
|
|
3823
|
+
export interface BridgeWiseTechAnalysisSectionsResponse {
|
|
3824
|
+
/** Language */
|
|
3825
|
+
language: string;
|
|
3826
|
+
/** Updated At */
|
|
3827
|
+
updated_at: string | null;
|
|
3828
|
+
/** Analysis Type */
|
|
3829
|
+
analysis_type: string;
|
|
3830
|
+
/** Analysis Type Name */
|
|
3831
|
+
analysis_type_name: string;
|
|
3832
|
+
/** Sections */
|
|
3833
|
+
sections: BridgeWiseTechAnalysisSectionItem[];
|
|
3834
|
+
}
|
|
3610
3835
|
/** TechAnalysisItem */
|
|
3611
3836
|
export interface BridgeWisepreparationSdkAlterModelsTechAnalysisItem {
|
|
3612
3837
|
/** Language */
|
|
@@ -4114,107 +4339,354 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
4114
4339
|
Iso = "iso",
|
|
4115
4340
|
Epoch = "epoch"
|
|
4116
4341
|
}
|
|
4117
|
-
export class
|
|
4342
|
+
export class Alerts<HandleError extends boolean = boolean> {
|
|
4118
4343
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4119
4344
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4120
4345
|
/**
|
|
4121
|
-
* @
|
|
4122
|
-
* @
|
|
4123
|
-
* @
|
|
4124
|
-
* @
|
|
4346
|
+
* @description Get alerts with optional inclusion of related resources
|
|
4347
|
+
* @tags Alerts
|
|
4348
|
+
* @name GetAlerts
|
|
4349
|
+
* @summary Get Alerts
|
|
4350
|
+
* @request GET:/alerts
|
|
4125
4351
|
* @secure
|
|
4126
4352
|
*/
|
|
4127
|
-
|
|
4128
|
-
/**
|
|
4129
|
-
|
|
4130
|
-
|
|
4131
|
-
|
|
4132
|
-
|
|
4353
|
+
getAlerts(query?: {
|
|
4354
|
+
/** @default "en-US" */
|
|
4355
|
+
language?: BridgeWiseAlertLanguagesEnum;
|
|
4356
|
+
/** Date Gte */
|
|
4357
|
+
date__gte?: string | null;
|
|
4358
|
+
/** Date Lte */
|
|
4359
|
+
date__lte?: string | null;
|
|
4360
|
+
/** Sentiment */
|
|
4361
|
+
sentiment?: BridgeWiseEventSentimentEnum | null;
|
|
4362
|
+
/** Importance Level */
|
|
4363
|
+
importance_level?: number | null;
|
|
4364
|
+
/** Alert Type */
|
|
4365
|
+
alert_type?: BridgeWiseAlertTypeEnum | null;
|
|
4133
4366
|
/**
|
|
4134
4367
|
* Limit
|
|
4135
|
-
* @
|
|
4136
|
-
* @max 20
|
|
4137
|
-
* @default 1
|
|
4368
|
+
* @default 10
|
|
4138
4369
|
*/
|
|
4139
4370
|
limit?: number;
|
|
4140
4371
|
/**
|
|
4141
|
-
*
|
|
4142
|
-
* @default
|
|
4372
|
+
* Offset
|
|
4373
|
+
* @default 0
|
|
4143
4374
|
*/
|
|
4144
|
-
|
|
4145
|
-
|
|
4375
|
+
offset?: number;
|
|
4376
|
+
/** Asset Type */
|
|
4377
|
+
asset_type?: BridgeWiseAssetTypeEnum | null;
|
|
4378
|
+
/** Ticker Exchange */
|
|
4379
|
+
ticker_exchange?: string | null;
|
|
4380
|
+
/** Ticker Symbol */
|
|
4381
|
+
ticker_symbol?: string | null;
|
|
4382
|
+
/** Include */
|
|
4383
|
+
include?: string | null;
|
|
4384
|
+
/** Company Id */
|
|
4385
|
+
company_id?: string | null;
|
|
4386
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlert[], HandleError>>;
|
|
4146
4387
|
/**
|
|
4147
|
-
* @description
|
|
4148
|
-
* @tags
|
|
4149
|
-
* @name
|
|
4150
|
-
* @summary Get
|
|
4151
|
-
* @request GET:/
|
|
4388
|
+
* @description Get reasons for a specific alert by alert ID.
|
|
4389
|
+
* @tags Alerts
|
|
4390
|
+
* @name GetAlertReasons
|
|
4391
|
+
* @summary Get Alert Reasons
|
|
4392
|
+
* @request GET:/alerts/{alert_id}/reasons
|
|
4152
4393
|
* @secure
|
|
4153
4394
|
*/
|
|
4154
|
-
|
|
4395
|
+
getAlertReasons(alertId: string, query?: {
|
|
4396
|
+
/** @default "en-US" */
|
|
4397
|
+
language?: BridgeWiseAlertLanguagesEnum;
|
|
4398
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlertReason[], HandleError>>;
|
|
4399
|
+
}
|
|
4400
|
+
export class AlternativeAssets<HandleError extends boolean = boolean> {
|
|
4401
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4402
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4403
|
+
/**
|
|
4404
|
+
* @description Returns a asset profile data for a supported asset.
|
|
4405
|
+
* @tags Alternative Assets
|
|
4406
|
+
* @name GetAlternative
|
|
4407
|
+
* @summary Get Alternative
|
|
4408
|
+
* @request GET:/alternative-assets/{asset_id}
|
|
4409
|
+
* @secure
|
|
4410
|
+
*/
|
|
4411
|
+
getAlternative(assetId: number, query?: {
|
|
4155
4412
|
/**
|
|
4156
|
-
*
|
|
4157
|
-
*
|
|
4413
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4414
|
+
* @default "en-US"
|
|
4158
4415
|
*/
|
|
4159
|
-
|
|
4416
|
+
language?: BridgeWiseLanguageEnum;
|
|
4417
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMetadata, HandleError>>;
|
|
4418
|
+
/**
|
|
4419
|
+
* @description Offers key market data for the specified alternative asset, including daily high, open, low, close prices, and market capitalization.
|
|
4420
|
+
* @tags Alternative Assets
|
|
4421
|
+
* @name GetAlternativesMarketData
|
|
4422
|
+
* @summary Get Alternatives Market Data
|
|
4423
|
+
* @request GET:/alternative-assets/{asset_id}/market
|
|
4424
|
+
* @secure
|
|
4425
|
+
*/
|
|
4426
|
+
getAlternativesMarketData(assetId: number, query?: {
|
|
4160
4427
|
/**
|
|
4161
|
-
* Date
|
|
4162
|
-
* Specify the
|
|
4428
|
+
* Date Ge
|
|
4429
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4163
4430
|
*/
|
|
4164
|
-
|
|
4431
|
+
date__ge?: string | null;
|
|
4165
4432
|
/**
|
|
4166
|
-
*
|
|
4167
|
-
* Specify
|
|
4433
|
+
* Date Le
|
|
4434
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4168
4435
|
*/
|
|
4169
|
-
|
|
4170
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4436
|
+
date__le?: string | null;
|
|
4437
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketDataList, HandleError>>;
|
|
4171
4438
|
/**
|
|
4172
|
-
* @description
|
|
4173
|
-
* @tags
|
|
4174
|
-
* @name
|
|
4175
|
-
* @summary Get
|
|
4176
|
-
* @request GET:/
|
|
4439
|
+
* @description Provides detailed market statistics for the specified alternative asset, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4440
|
+
* @tags Alternative Assets
|
|
4441
|
+
* @name GetAlternativesMarketStatistics
|
|
4442
|
+
* @summary Get Alternatives Market Statistics
|
|
4443
|
+
* @request GET:/alternative-assets/{asset_id}/market-statistics
|
|
4177
4444
|
* @secure
|
|
4178
4445
|
*/
|
|
4179
|
-
|
|
4446
|
+
getAlternativesMarketStatistics(assetId: number, query?: {
|
|
4180
4447
|
/**
|
|
4181
4448
|
* Trading Item Id
|
|
4182
4449
|
* Specify a BW trading asset identifier for a targeted query.
|
|
4183
4450
|
*/
|
|
4184
|
-
trading_item_id?:
|
|
4185
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4451
|
+
trading_item_id?: number | null;
|
|
4452
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketStatisticsList, HandleError>>;
|
|
4186
4453
|
/**
|
|
4187
|
-
* @description
|
|
4188
|
-
* @tags
|
|
4189
|
-
* @name
|
|
4190
|
-
* @summary Get
|
|
4191
|
-
* @request GET:/
|
|
4454
|
+
* @description Return aggregated news articles for a supported alternative asset (crypto, forex, commodity), using the same data pipeline and response schema as the existing companies news endpoint (NewsAPI-backed).
|
|
4455
|
+
* @tags Alternative Assets
|
|
4456
|
+
* @name GetAlternativeNews
|
|
4457
|
+
* @summary Get Alternative News
|
|
4458
|
+
* @request GET:/alternative-assets/{asset_id}/news
|
|
4192
4459
|
* @secure
|
|
4193
4460
|
*/
|
|
4194
|
-
|
|
4461
|
+
getAlternativeNews(assetId: number, query?: {
|
|
4195
4462
|
/**
|
|
4196
|
-
*
|
|
4463
|
+
* Languages
|
|
4464
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4197
4465
|
* @default "en-US"
|
|
4466
|
+
* @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
|
|
4198
4467
|
*/
|
|
4199
|
-
|
|
4468
|
+
languages?: string;
|
|
4200
4469
|
/**
|
|
4201
|
-
*
|
|
4202
|
-
*
|
|
4470
|
+
* Published Date Gte
|
|
4471
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4472
|
+
* @format date
|
|
4473
|
+
* @default "2025-12-07"
|
|
4203
4474
|
*/
|
|
4204
|
-
|
|
4205
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondsParagraphItem[], HandleError>>;
|
|
4206
|
-
/**
|
|
4207
|
-
* @description Get parameters for a bond. Query Parameters: - language: Define the language code (e.g., 'en-US') for the textual data output. Default: 'en-US'. - section_type: Specify the pillar to retrieve. One of: size_and_market_position, leverage_and_solvency, profitability, financial_policy. - year: Specify the year for which the analysis is requested. - quarter: Specify the quarter for which the analysis is requested. - parameter_id: Get desired parameter by ID. - limit: Number of objects available for retrieval (based on period_type) starting from the most recent entry. - show_all: Boolean flag. Indicate whether to return historical data (true/false).
|
|
4208
|
-
* @tags Bonds
|
|
4209
|
-
* @name GetBondParameters
|
|
4210
|
-
* @summary Get Bond Parameters
|
|
4211
|
-
* @request GET:/bonds/{bond_id}/parameters
|
|
4212
|
-
* @secure
|
|
4213
|
-
*/
|
|
4214
|
-
getBondParameters(bondId: number, query?: {
|
|
4475
|
+
published_date__gte?: string;
|
|
4215
4476
|
/**
|
|
4216
|
-
*
|
|
4217
|
-
*
|
|
4477
|
+
* Published Date Lte
|
|
4478
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4479
|
+
* @format date
|
|
4480
|
+
* @default "2025-12-07"
|
|
4481
|
+
*/
|
|
4482
|
+
published_date__lte?: string;
|
|
4483
|
+
/**
|
|
4484
|
+
* Specify the field by which to sort the results.
|
|
4485
|
+
* @default "publication_date"
|
|
4486
|
+
*/
|
|
4487
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4488
|
+
/**
|
|
4489
|
+
* Size
|
|
4490
|
+
* Define the number of records per page for pagination purposes.
|
|
4491
|
+
* @default 10
|
|
4492
|
+
* @example 10
|
|
4493
|
+
*/
|
|
4494
|
+
size?: number;
|
|
4495
|
+
/**
|
|
4496
|
+
* Page
|
|
4497
|
+
* Define the page number for pagination.
|
|
4498
|
+
* @default 1
|
|
4499
|
+
* @example 1
|
|
4500
|
+
*/
|
|
4501
|
+
page?: number;
|
|
4502
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4503
|
+
/**
|
|
4504
|
+
* @description Return a daily-updated sentiment score for a supported alternative asset (crypto, forex, commodity) based on news from the past 7 days.
|
|
4505
|
+
* @tags Alternative Assets
|
|
4506
|
+
* @name GetAverageAlternativeNewsSentiment
|
|
4507
|
+
* @summary Get Average Alternative News Sentiment
|
|
4508
|
+
* @request GET:/alternative-assets/{asset_id}/news-sentiment
|
|
4509
|
+
* @secure
|
|
4510
|
+
*/
|
|
4511
|
+
getAverageAlternativeNewsSentiment(assetId: number, query?: {
|
|
4512
|
+
/**
|
|
4513
|
+
* Published Date Gte
|
|
4514
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4515
|
+
* @format date
|
|
4516
|
+
* @default "2025-12-07"
|
|
4517
|
+
*/
|
|
4518
|
+
published_date__gte?: string;
|
|
4519
|
+
/**
|
|
4520
|
+
* Published Date Lte
|
|
4521
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4522
|
+
* @format date
|
|
4523
|
+
* @default "2025-12-07"
|
|
4524
|
+
*/
|
|
4525
|
+
published_date__lte?: string;
|
|
4526
|
+
/**
|
|
4527
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4528
|
+
* @default "en-US"
|
|
4529
|
+
*/
|
|
4530
|
+
language?: BridgeWiseLanguageEnum;
|
|
4531
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4532
|
+
/**
|
|
4533
|
+
* @description `section_type='description' ->` Returns a static asset description (as ordered paragraphs) for a supported asset. `section_type='news-summary' ->` Returns an LLM-generated news summary for a supported alternative asset (crypto, forex, commodity) over a recent window (default: past 7 days), including 100–300 word overview, 3–5 highlights (positives), 3–5 lowlights (negatives), and metadata. Output is refreshed daily.`section_type='technical' ->` Paragraph reflects the most recent technical analysis rating and the relevant parameter sentiments.
|
|
4534
|
+
* @tags Alternative Assets
|
|
4535
|
+
* @name GetAlternativesParagraphs
|
|
4536
|
+
* @summary Get Alternatives Paragraphs
|
|
4537
|
+
* @request GET:/alternative-assets/{asset_id}/paragraphs
|
|
4538
|
+
* @secure
|
|
4539
|
+
*/
|
|
4540
|
+
getAlternativesParagraphs(assetId: number, query?: {
|
|
4541
|
+
/**
|
|
4542
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4543
|
+
* @default "en-US"
|
|
4544
|
+
*/
|
|
4545
|
+
language?: BridgeWiseLanguageEnum;
|
|
4546
|
+
/**
|
|
4547
|
+
* Section Type
|
|
4548
|
+
* Specify the component of the text paragraph (e.g., `description`, `technical`, `news_summary`).
|
|
4549
|
+
* @default "description"
|
|
4550
|
+
*/
|
|
4551
|
+
section_type?: BridgeWiseParagraphTextEnum | null;
|
|
4552
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetParagraph | BridgeWiseAssetLLMNewsParagraph | BridgeWiseAssetLLMTechnicalParagraph, HandleError>>;
|
|
4553
|
+
/**
|
|
4554
|
+
* @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
|
|
4555
|
+
* @tags Alternative Assets
|
|
4556
|
+
* @name GetAltTechnicalAnalysis
|
|
4557
|
+
* @summary Get Alt Technical Analysis
|
|
4558
|
+
* @request GET:/alternative-assets/{asset_id}/technical-analysis
|
|
4559
|
+
* @secure
|
|
4560
|
+
*/
|
|
4561
|
+
getAltTechnicalAnalysis(assetId: number, query?: {
|
|
4562
|
+
/**
|
|
4563
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4564
|
+
* @default "en-US"
|
|
4565
|
+
*/
|
|
4566
|
+
language?: BridgeWiseLanguageEnum;
|
|
4567
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkAlterModelsTechAnalysisItem, HandleError>>;
|
|
4568
|
+
/**
|
|
4569
|
+
* @description This endpoint retrieves detailed technical indicator values including short-term indicators (`5DMA`, `RSI`, `STOCH`, `CCI`, `ROC`, `MFI`, `ATR`, `BBANDS`, `ULTOSC`) and long-term indicators (`50DMA`, `200DMA`, `SMA`, `EMA`, `MACD`, `support`, `resistance`, `OBV`, `ADX`, `SAR`), as well as `low` and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
4570
|
+
* @tags Alternative Assets
|
|
4571
|
+
* @name GetAltTechnicalParameters
|
|
4572
|
+
* @summary Get Alt Technical Parameters
|
|
4573
|
+
* @request GET:/alternative-assets/{asset_id}/technical-parameters
|
|
4574
|
+
* @secure
|
|
4575
|
+
*/
|
|
4576
|
+
getAltTechnicalParameters(assetId: number, query?: {
|
|
4577
|
+
/**
|
|
4578
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4579
|
+
* @default "en-US"
|
|
4580
|
+
*/
|
|
4581
|
+
language?: BridgeWiseLanguageEnum;
|
|
4582
|
+
/**
|
|
4583
|
+
* Parameter Id
|
|
4584
|
+
* Get desired parameter by ID.
|
|
4585
|
+
*/
|
|
4586
|
+
parameter_id?: number;
|
|
4587
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetTechParameterItemList, HandleError>>;
|
|
4588
|
+
}
|
|
4589
|
+
export class Bonds<HandleError extends boolean = boolean> {
|
|
4590
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4591
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4592
|
+
/**
|
|
4593
|
+
* @tags Bonds
|
|
4594
|
+
* @name GetBondAnalysis
|
|
4595
|
+
* @summary Get Bond Analysis
|
|
4596
|
+
* @request GET:/bonds/{bond_id}/analysis
|
|
4597
|
+
* @secure
|
|
4598
|
+
*/
|
|
4599
|
+
getBondAnalysis(bondId: number, query?: {
|
|
4600
|
+
/**
|
|
4601
|
+
* Language
|
|
4602
|
+
* @default "en-US"
|
|
4603
|
+
*/
|
|
4604
|
+
language?: BridgeWiseLanguageEnum | null;
|
|
4605
|
+
/**
|
|
4606
|
+
* Limit
|
|
4607
|
+
* @min 1
|
|
4608
|
+
* @max 20
|
|
4609
|
+
* @default 1
|
|
4610
|
+
*/
|
|
4611
|
+
limit?: number;
|
|
4612
|
+
/**
|
|
4613
|
+
* Universe type: industry or country
|
|
4614
|
+
* @default "industry"
|
|
4615
|
+
*/
|
|
4616
|
+
universe?: BridgeWiseUniverseEnum;
|
|
4617
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondAnalysisResponse[], HandleError>>;
|
|
4618
|
+
/**
|
|
4619
|
+
* @description Retrieves a bond's market data by its ID from the database. The data returned is determined by the provided query parameters. This function utilizes a service layer to process the request and return the required information efficiently. :param db: The database instance used to query company data. :type db: DB :param bond_id: The unique identifier of the company whose details are to be fetched. :type bond_id: str :param params: Query parameters for customizing the response such as language preference and field configurations. :type params: BondMarketDataQueryParams :return: The market data corresponding to the given bond ID. :rtype: JSON
|
|
4620
|
+
* @tags Bonds
|
|
4621
|
+
* @name GetBondMarketData
|
|
4622
|
+
* @summary Get Bond Market Data
|
|
4623
|
+
* @request GET:/bonds/{bond_id}/market
|
|
4624
|
+
* @secure
|
|
4625
|
+
*/
|
|
4626
|
+
getBondMarketData(bondId: string, query?: {
|
|
4627
|
+
/**
|
|
4628
|
+
* Date Gte
|
|
4629
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4630
|
+
*/
|
|
4631
|
+
date__gte?: string;
|
|
4632
|
+
/**
|
|
4633
|
+
* Date Lte
|
|
4634
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4635
|
+
*/
|
|
4636
|
+
date__lte?: string;
|
|
4637
|
+
/**
|
|
4638
|
+
* Trading Item Id
|
|
4639
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4640
|
+
*/
|
|
4641
|
+
trading_item_id?: string | null;
|
|
4642
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4643
|
+
/**
|
|
4644
|
+
* @description Returns calculated, cumulative returns over various historical periods.
|
|
4645
|
+
* @tags Bonds
|
|
4646
|
+
* @name GetBondMarketStatistics
|
|
4647
|
+
* @summary Get Bond Market Statistics
|
|
4648
|
+
* @request GET:/bonds/{bond_id}/market-statistics
|
|
4649
|
+
* @secure
|
|
4650
|
+
*/
|
|
4651
|
+
getBondMarketStatistics(bondId: string, query?: {
|
|
4652
|
+
/**
|
|
4653
|
+
* Trading Item Id
|
|
4654
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4655
|
+
*/
|
|
4656
|
+
trading_item_id?: string | null;
|
|
4657
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4658
|
+
/**
|
|
4659
|
+
* @description Get paragraphs for a bond from DynamoDB table gold_credit_analysis_text.
|
|
4660
|
+
* @tags Bonds
|
|
4661
|
+
* @name GetBondParagraphs
|
|
4662
|
+
* @summary Get Bond Paragraphs
|
|
4663
|
+
* @request GET:/bonds/{bond_id}/paragraphs
|
|
4664
|
+
* @secure
|
|
4665
|
+
*/
|
|
4666
|
+
getBondParagraphs(bondId: number, query?: {
|
|
4667
|
+
/**
|
|
4668
|
+
* Language
|
|
4669
|
+
* @default "en-US"
|
|
4670
|
+
*/
|
|
4671
|
+
language?: BridgeWiseLanguageEnum | null;
|
|
4672
|
+
/**
|
|
4673
|
+
* Section Type
|
|
4674
|
+
* Filter output section objects by this parameter
|
|
4675
|
+
*/
|
|
4676
|
+
section_type?: BridgeWiseBondsSectionTypeEnum | null;
|
|
4677
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseBondsParagraphItem[], HandleError>>;
|
|
4678
|
+
/**
|
|
4679
|
+
* @description Get parameters for a bond. Query Parameters: - language: Define the language code (e.g., 'en-US') for the textual data output. Default: 'en-US'. - section_type: Specify the pillar to retrieve. One of: size_and_market_position, leverage_and_solvency, profitability, financial_policy. - year: Specify the year for which the analysis is requested. - quarter: Specify the quarter for which the analysis is requested. - parameter_id: Get desired parameter by ID. - limit: Number of objects available for retrieval (based on period_type) starting from the most recent entry. - show_all: Boolean flag. Indicate whether to return historical data (true/false).
|
|
4680
|
+
* @tags Bonds
|
|
4681
|
+
* @name GetBondParameters
|
|
4682
|
+
* @summary Get Bond Parameters
|
|
4683
|
+
* @request GET:/bonds/{bond_id}/parameters
|
|
4684
|
+
* @secure
|
|
4685
|
+
*/
|
|
4686
|
+
getBondParameters(bondId: number, query?: {
|
|
4687
|
+
/**
|
|
4688
|
+
* Language
|
|
4689
|
+
* Define the language code (e.g., 'en-US') for the textual data output. Default: 'en-US'.
|
|
4218
4690
|
* @default "en-US"
|
|
4219
4691
|
*/
|
|
4220
4692
|
language?: BridgeWiseLanguageEnum | null;
|
|
@@ -4604,221 +5076,32 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
4604
5076
|
identifier: string;
|
|
4605
5077
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
4606
5078
|
}
|
|
4607
|
-
export class
|
|
5079
|
+
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
4608
5080
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4609
5081
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4610
5082
|
/**
|
|
4611
|
-
* @description
|
|
4612
|
-
* @tags
|
|
4613
|
-
* @name
|
|
4614
|
-
* @summary Get
|
|
4615
|
-
* @request GET:/
|
|
5083
|
+
* @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.
|
|
5084
|
+
* @tags Company Metadata, Themes
|
|
5085
|
+
* @name GetCompanies
|
|
5086
|
+
* @summary Get Companies
|
|
5087
|
+
* @request GET:/companies
|
|
4616
5088
|
* @secure
|
|
4617
5089
|
*/
|
|
4618
|
-
|
|
5090
|
+
getCompanies(query?: {
|
|
4619
5091
|
/**
|
|
4620
5092
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4621
5093
|
* @default "en-US"
|
|
4622
5094
|
*/
|
|
4623
5095
|
language?: BridgeWiseLanguageEnum;
|
|
4624
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMetadata, HandleError>>;
|
|
4625
|
-
/**
|
|
4626
|
-
* @description Offers key market data for the specified alternative asset, including daily high, open, low, close prices, and market capitalization.
|
|
4627
|
-
* @tags Alternative Assets
|
|
4628
|
-
* @name GetAlternativesMarketData
|
|
4629
|
-
* @summary Get Alternatives Market Data
|
|
4630
|
-
* @request GET:/alternative-assets/{asset_id}/market
|
|
4631
|
-
* @secure
|
|
4632
|
-
*/
|
|
4633
|
-
getAlternativesMarketData(assetId: number, query?: {
|
|
4634
5096
|
/**
|
|
4635
|
-
*
|
|
4636
|
-
*
|
|
5097
|
+
* Peers Of
|
|
5098
|
+
* Peers companies of a specific company.
|
|
4637
5099
|
*/
|
|
4638
|
-
|
|
5100
|
+
peers_of?: number;
|
|
4639
5101
|
/**
|
|
4640
|
-
*
|
|
4641
|
-
*
|
|
4642
|
-
|
|
4643
|
-
date__le?: string | null;
|
|
4644
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketDataList, HandleError>>;
|
|
4645
|
-
/**
|
|
4646
|
-
* @description Provides detailed market statistics for the specified alternative asset, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4647
|
-
* @tags Alternative Assets
|
|
4648
|
-
* @name GetAlternativesMarketStatistics
|
|
4649
|
-
* @summary Get Alternatives Market Statistics
|
|
4650
|
-
* @request GET:/alternative-assets/{asset_id}/market-statistics
|
|
4651
|
-
* @secure
|
|
4652
|
-
*/
|
|
4653
|
-
getAlternativesMarketStatistics(assetId: number, query?: {
|
|
4654
|
-
/**
|
|
4655
|
-
* Trading Item Id
|
|
4656
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4657
|
-
*/
|
|
4658
|
-
trading_item_id?: number | null;
|
|
4659
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetMarketStatisticsList, HandleError>>;
|
|
4660
|
-
/**
|
|
4661
|
-
* @description Return aggregated news articles for a supported alternative asset (crypto, forex, commodity), using the same data pipeline and response schema as the existing companies news endpoint (NewsAPI-backed).
|
|
4662
|
-
* @tags Alternative Assets
|
|
4663
|
-
* @name GetAlternativeNews
|
|
4664
|
-
* @summary Get Alternative News
|
|
4665
|
-
* @request GET:/alternative-assets/{asset_id}/news
|
|
4666
|
-
* @secure
|
|
4667
|
-
*/
|
|
4668
|
-
getAlternativeNews(assetId: number, query?: {
|
|
4669
|
-
/**
|
|
4670
|
-
* Languages
|
|
4671
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4672
|
-
* @default "en-US"
|
|
4673
|
-
* @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
|
|
4674
|
-
*/
|
|
4675
|
-
languages?: string;
|
|
4676
|
-
/**
|
|
4677
|
-
* Published Date Gte
|
|
4678
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4679
|
-
* @format date
|
|
4680
|
-
* @default "2025-12-07"
|
|
4681
|
-
*/
|
|
4682
|
-
published_date__gte?: string;
|
|
4683
|
-
/**
|
|
4684
|
-
* Published Date Lte
|
|
4685
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4686
|
-
* @format date
|
|
4687
|
-
* @default "2025-12-07"
|
|
4688
|
-
*/
|
|
4689
|
-
published_date__lte?: string;
|
|
4690
|
-
/**
|
|
4691
|
-
* Specify the field by which to sort the results.
|
|
4692
|
-
* @default "publication_date"
|
|
4693
|
-
*/
|
|
4694
|
-
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4695
|
-
/**
|
|
4696
|
-
* Size
|
|
4697
|
-
* Define the number of records per page for pagination purposes.
|
|
4698
|
-
* @default 10
|
|
4699
|
-
* @example 10
|
|
4700
|
-
*/
|
|
4701
|
-
size?: number;
|
|
4702
|
-
/**
|
|
4703
|
-
* Page
|
|
4704
|
-
* Define the page number for pagination.
|
|
4705
|
-
* @default 1
|
|
4706
|
-
* @example 1
|
|
4707
|
-
*/
|
|
4708
|
-
page?: number;
|
|
4709
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4710
|
-
/**
|
|
4711
|
-
* @description Return a daily-updated sentiment score for a supported alternative asset (crypto, forex, commodity) based on news from the past 7 days.
|
|
4712
|
-
* @tags Alternative Assets
|
|
4713
|
-
* @name GetAverageAlternativeNewsSentiment
|
|
4714
|
-
* @summary Get Average Alternative News Sentiment
|
|
4715
|
-
* @request GET:/alternative-assets/{asset_id}/news-sentiment
|
|
4716
|
-
* @secure
|
|
4717
|
-
*/
|
|
4718
|
-
getAverageAlternativeNewsSentiment(assetId: number, query?: {
|
|
4719
|
-
/**
|
|
4720
|
-
* Published Date Gte
|
|
4721
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4722
|
-
* @format date
|
|
4723
|
-
* @default "2025-12-07"
|
|
4724
|
-
*/
|
|
4725
|
-
published_date__gte?: string;
|
|
4726
|
-
/**
|
|
4727
|
-
* Published Date Lte
|
|
4728
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4729
|
-
* @format date
|
|
4730
|
-
* @default "2025-12-07"
|
|
4731
|
-
*/
|
|
4732
|
-
published_date__lte?: string;
|
|
4733
|
-
/**
|
|
4734
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4735
|
-
* @default "en-US"
|
|
4736
|
-
*/
|
|
4737
|
-
language?: BridgeWiseLanguageEnum;
|
|
4738
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4739
|
-
/**
|
|
4740
|
-
* @description `section_type='description' ->` Returns a static asset description (as ordered paragraphs) for a supported asset. `section_type='news-summary' ->` Returns an LLM-generated news summary for a supported alternative asset (crypto, forex, commodity) over a recent window (default: past 7 days), including 100–300 word overview, 3–5 highlights (positives), 3–5 lowlights (negatives), and metadata. Output is refreshed daily.`section_type='technical' ->` Paragraph reflects the most recent technical analysis rating and the relevant parameter sentiments.
|
|
4741
|
-
* @tags Alternative Assets
|
|
4742
|
-
* @name GetAlternativesParagraphs
|
|
4743
|
-
* @summary Get Alternatives Paragraphs
|
|
4744
|
-
* @request GET:/alternative-assets/{asset_id}/paragraphs
|
|
4745
|
-
* @secure
|
|
4746
|
-
*/
|
|
4747
|
-
getAlternativesParagraphs(assetId: number, query?: {
|
|
4748
|
-
/**
|
|
4749
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4750
|
-
* @default "en-US"
|
|
4751
|
-
*/
|
|
4752
|
-
language?: BridgeWiseLanguageEnum;
|
|
4753
|
-
/**
|
|
4754
|
-
* Section Type
|
|
4755
|
-
* Specify the component of the text paragraph (e.g., `description`, `technical`, `news_summary`).
|
|
4756
|
-
* @default "description"
|
|
4757
|
-
*/
|
|
4758
|
-
section_type?: BridgeWiseParagraphTextEnum | null;
|
|
4759
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetParagraph | BridgeWiseAssetLLMNewsParagraph | BridgeWiseAssetLLMTechnicalParagraph, HandleError>>;
|
|
4760
|
-
/**
|
|
4761
|
-
* @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
|
|
4762
|
-
* @tags Alternative Assets
|
|
4763
|
-
* @name GetAltTechnicalAnalysis
|
|
4764
|
-
* @summary Get Alt Technical Analysis
|
|
4765
|
-
* @request GET:/alternative-assets/{asset_id}/technical-analysis
|
|
4766
|
-
* @secure
|
|
4767
|
-
*/
|
|
4768
|
-
getAltTechnicalAnalysis(assetId: number, query?: {
|
|
4769
|
-
/**
|
|
4770
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4771
|
-
* @default "en-US"
|
|
4772
|
-
*/
|
|
4773
|
-
language?: BridgeWiseLanguageEnum;
|
|
4774
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkAlterModelsTechAnalysisItem, HandleError>>;
|
|
4775
|
-
/**
|
|
4776
|
-
* @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
4777
|
-
* @tags Alternative Assets
|
|
4778
|
-
* @name GetAltTechnicalParameters
|
|
4779
|
-
* @summary Get Alt Technical Parameters
|
|
4780
|
-
* @request GET:/alternative-assets/{asset_id}/technical-parameters
|
|
4781
|
-
* @secure
|
|
4782
|
-
*/
|
|
4783
|
-
getAltTechnicalParameters(assetId: number, query?: {
|
|
4784
|
-
/**
|
|
4785
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4786
|
-
* @default "en-US"
|
|
4787
|
-
*/
|
|
4788
|
-
language?: BridgeWiseLanguageEnum;
|
|
4789
|
-
/**
|
|
4790
|
-
* Parameter Id
|
|
4791
|
-
* Get desired parameter by ID.
|
|
4792
|
-
*/
|
|
4793
|
-
parameter_id?: number;
|
|
4794
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAssetTechParameterItemList, HandleError>>;
|
|
4795
|
-
}
|
|
4796
|
-
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
4797
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4798
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4799
|
-
/**
|
|
4800
|
-
* @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.
|
|
4801
|
-
* @tags Company Metadata, Themes
|
|
4802
|
-
* @name GetCompanies
|
|
4803
|
-
* @summary Get Companies
|
|
4804
|
-
* @request GET:/companies
|
|
4805
|
-
* @secure
|
|
4806
|
-
*/
|
|
4807
|
-
getCompanies(query?: {
|
|
4808
|
-
/**
|
|
4809
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4810
|
-
* @default "en-US"
|
|
4811
|
-
*/
|
|
4812
|
-
language?: BridgeWiseLanguageEnum;
|
|
4813
|
-
/**
|
|
4814
|
-
* Peers Of
|
|
4815
|
-
* Peers companies of a specific company.
|
|
4816
|
-
*/
|
|
4817
|
-
peers_of?: number;
|
|
4818
|
-
/**
|
|
4819
|
-
* Region Id
|
|
4820
|
-
* Comma-separated unique region identifiers. <br>Example: 10120,10238</br>
|
|
4821
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5102
|
+
* Region Id
|
|
5103
|
+
* Comma-separated unique region identifiers. <br>Example: 10120,10238</br>
|
|
5104
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4822
5105
|
*/
|
|
4823
5106
|
region_id?: string;
|
|
4824
5107
|
/**
|
|
@@ -5495,75 +5778,91 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
5495
5778
|
identifier_type: string;
|
|
5496
5779
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
5497
5780
|
}
|
|
5498
|
-
export class
|
|
5781
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5499
5782
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5500
5783
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5501
5784
|
/**
|
|
5502
|
-
* @description
|
|
5503
|
-
* @tags
|
|
5504
|
-
* @name
|
|
5505
|
-
* @summary
|
|
5506
|
-
* @request GET:/
|
|
5785
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
5786
|
+
* @tags Logos
|
|
5787
|
+
* @name FetchLogos
|
|
5788
|
+
* @summary Fetch Logos
|
|
5789
|
+
* @request GET:/companies/logos
|
|
5507
5790
|
* @secure
|
|
5508
5791
|
*/
|
|
5509
|
-
|
|
5510
|
-
/** @default "en-US" */
|
|
5511
|
-
language?: BridgeWiseAlertLanguagesEnum;
|
|
5512
|
-
/** Date Gte */
|
|
5513
|
-
date__gte?: string | null;
|
|
5514
|
-
/** Date Lte */
|
|
5515
|
-
date__lte?: string | null;
|
|
5516
|
-
/** Sentiment */
|
|
5517
|
-
sentiment?: BridgeWiseEventSentimentEnum | null;
|
|
5518
|
-
/** Importance Level */
|
|
5519
|
-
importance_level?: number | null;
|
|
5520
|
-
/** Alert Type */
|
|
5521
|
-
alert_type?: BridgeWiseAlertTypeEnum | null;
|
|
5792
|
+
fetchLogos(query?: {
|
|
5522
5793
|
/**
|
|
5523
|
-
*
|
|
5524
|
-
*
|
|
5794
|
+
* Company Id In
|
|
5795
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5796
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5797
|
+
* @example "74822,83343211"
|
|
5525
5798
|
*/
|
|
5526
|
-
|
|
5799
|
+
company_id__in?: string;
|
|
5527
5800
|
/**
|
|
5528
|
-
*
|
|
5529
|
-
*
|
|
5801
|
+
* Size
|
|
5802
|
+
* Page size
|
|
5803
|
+
* @min 1
|
|
5804
|
+
* @max 100
|
|
5805
|
+
* @default 50
|
|
5530
5806
|
*/
|
|
5531
|
-
|
|
5532
|
-
/**
|
|
5533
|
-
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
|
-
/** Company Id */
|
|
5541
|
-
company_id?: string | null;
|
|
5542
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlert[], HandleError>>;
|
|
5807
|
+
size?: number;
|
|
5808
|
+
/**
|
|
5809
|
+
* Page
|
|
5810
|
+
* Page number
|
|
5811
|
+
* @min 1
|
|
5812
|
+
* @default 1
|
|
5813
|
+
*/
|
|
5814
|
+
page?: number;
|
|
5815
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
5543
5816
|
/**
|
|
5544
|
-
* @description
|
|
5545
|
-
* @tags
|
|
5546
|
-
* @name
|
|
5547
|
-
* @summary
|
|
5548
|
-
* @request GET:/
|
|
5817
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
5818
|
+
* @tags Logos
|
|
5819
|
+
* @name FetchLogo
|
|
5820
|
+
* @summary Fetch Logo
|
|
5821
|
+
* @request GET:/companies/{company_id}/logos
|
|
5549
5822
|
* @secure
|
|
5550
5823
|
*/
|
|
5551
|
-
|
|
5552
|
-
/** @default "en-US" */
|
|
5553
|
-
language?: BridgeWiseAlertLanguagesEnum;
|
|
5554
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseAlertReason[], HandleError>>;
|
|
5824
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
5555
5825
|
}
|
|
5556
|
-
export class
|
|
5826
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
5557
5827
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5558
5828
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5559
5829
|
/**
|
|
5560
|
-
* @description Provides for a
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary Get
|
|
5564
|
-
* @request GET:/companies/{company_id}/
|
|
5565
|
-
* @secure
|
|
5566
|
-
*/
|
|
5830
|
+
* @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.
|
|
5831
|
+
* @tags Consensus Analysts
|
|
5832
|
+
* @name GetConsensusRatings
|
|
5833
|
+
* @summary Get Consensus Ratings
|
|
5834
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
5835
|
+
* @secure
|
|
5836
|
+
*/
|
|
5837
|
+
getConsensusRatings(companyId: number, query?: {
|
|
5838
|
+
/**
|
|
5839
|
+
* Trading Item Id
|
|
5840
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5841
|
+
*/
|
|
5842
|
+
trading_item_id?: number;
|
|
5843
|
+
/**
|
|
5844
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5845
|
+
* @default "en-US"
|
|
5846
|
+
*/
|
|
5847
|
+
language?: BridgeWiseLanguageEnum;
|
|
5848
|
+
/**
|
|
5849
|
+
* Date Gte
|
|
5850
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5851
|
+
*/
|
|
5852
|
+
date__gte?: string | null;
|
|
5853
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
5854
|
+
}
|
|
5855
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
5856
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5857
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5858
|
+
/**
|
|
5859
|
+
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
5860
|
+
* @tags Activities
|
|
5861
|
+
* @name GetCompanyAlerts
|
|
5862
|
+
* @summary Get Company Alerts
|
|
5863
|
+
* @request GET:/companies/{company_id}/alerts
|
|
5864
|
+
* @secure
|
|
5865
|
+
*/
|
|
5567
5866
|
getCompanyAlerts(companyId: number, query?: {
|
|
5568
5867
|
/**
|
|
5569
5868
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -5603,51 +5902,6 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
5603
5902
|
importance?: string;
|
|
5604
5903
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
5605
5904
|
}
|
|
5606
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5607
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5608
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5609
|
-
/**
|
|
5610
|
-
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
5611
|
-
* @tags Logos
|
|
5612
|
-
* @name FetchLogos
|
|
5613
|
-
* @summary Fetch Logos
|
|
5614
|
-
* @request GET:/companies/logos
|
|
5615
|
-
* @secure
|
|
5616
|
-
*/
|
|
5617
|
-
fetchLogos(query?: {
|
|
5618
|
-
/**
|
|
5619
|
-
* Company Id In
|
|
5620
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
5621
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5622
|
-
* @example "74822,83343211"
|
|
5623
|
-
*/
|
|
5624
|
-
company_id__in?: string;
|
|
5625
|
-
/**
|
|
5626
|
-
* Size
|
|
5627
|
-
* Page size
|
|
5628
|
-
* @min 1
|
|
5629
|
-
* @max 100
|
|
5630
|
-
* @default 50
|
|
5631
|
-
*/
|
|
5632
|
-
size?: number;
|
|
5633
|
-
/**
|
|
5634
|
-
* Page
|
|
5635
|
-
* Page number
|
|
5636
|
-
* @min 1
|
|
5637
|
-
* @default 1
|
|
5638
|
-
*/
|
|
5639
|
-
page?: number;
|
|
5640
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
5641
|
-
/**
|
|
5642
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
5643
|
-
* @tags Logos
|
|
5644
|
-
* @name FetchLogo
|
|
5645
|
-
* @summary Fetch Logo
|
|
5646
|
-
* @request GET:/companies/{company_id}/logos
|
|
5647
|
-
* @secure
|
|
5648
|
-
*/
|
|
5649
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
5650
|
-
}
|
|
5651
5905
|
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
5652
5906
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5653
5907
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5694,35 +5948,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
5694
5948
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
5695
5949
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
5696
5950
|
}
|
|
5697
|
-
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
5698
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5699
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5700
|
-
/**
|
|
5701
|
-
* @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.
|
|
5702
|
-
* @tags Consensus Analysts
|
|
5703
|
-
* @name GetConsensusRatings
|
|
5704
|
-
* @summary Get Consensus Ratings
|
|
5705
|
-
* @request GET:/companies/{company_id}/consensus-ratings
|
|
5706
|
-
* @secure
|
|
5707
|
-
*/
|
|
5708
|
-
getConsensusRatings(companyId: number, query?: {
|
|
5709
|
-
/**
|
|
5710
|
-
* Trading Item Id
|
|
5711
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5712
|
-
*/
|
|
5713
|
-
trading_item_id?: number;
|
|
5714
|
-
/**
|
|
5715
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5716
|
-
* @default "en-US"
|
|
5717
|
-
*/
|
|
5718
|
-
language?: BridgeWiseLanguageEnum;
|
|
5719
|
-
/**
|
|
5720
|
-
* Date Gte
|
|
5721
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5722
|
-
*/
|
|
5723
|
-
date__gte?: string | null;
|
|
5724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
5725
|
-
}
|
|
5726
5951
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
5727
5952
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5728
5953
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6177,6 +6402,11 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
6177
6402
|
* Specify a BW trading asset identifier for a targeted query.
|
|
6178
6403
|
*/
|
|
6179
6404
|
trading_item_id?: number;
|
|
6405
|
+
/**
|
|
6406
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
6407
|
+
* @default "technical"
|
|
6408
|
+
*/
|
|
6409
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
6180
6410
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkModelsTechAnalysisItem, HandleError>>;
|
|
6181
6411
|
/**
|
|
6182
6412
|
* @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
|
|
@@ -6199,7 +6429,7 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
6199
6429
|
trading_item_id?: number;
|
|
6200
6430
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
6201
6431
|
/**
|
|
6202
|
-
* @description This endpoint retrieves detailed technical indicator values
|
|
6432
|
+
* @description This endpoint retrieves detailed technical indicator values including short-term indicators (`5DMA`, `RSI`, `STOCH`, `CCI`, `ROC`, `MFI`, `ATR`, `BBANDS`, `ULTOSC`) and long-term indicators (`50DMA`, `200DMA`, `SMA`, `EMA`, `MACD`, `support`, `resistance`, `OBV`, `ADX`, `SAR`), as well as `low` and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
6203
6433
|
* @tags Technical Analysis
|
|
6204
6434
|
* @name GetCompanyTechnicalParameters
|
|
6205
6435
|
* @summary Get Company Technical Parameters
|
|
@@ -6222,28 +6452,37 @@ export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
|
6222
6452
|
* Get desired parameter by ID.
|
|
6223
6453
|
*/
|
|
6224
6454
|
parameter_id?: number;
|
|
6455
|
+
/**
|
|
6456
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
6457
|
+
* @default "technical"
|
|
6458
|
+
*/
|
|
6459
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
6225
6460
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
6226
|
-
}
|
|
6227
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
6228
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6229
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6230
6461
|
/**
|
|
6231
|
-
* @description
|
|
6232
|
-
* @tags
|
|
6233
|
-
* @name
|
|
6234
|
-
* @summary Get Company
|
|
6235
|
-
* @request GET:/
|
|
6462
|
+
* @description Offers scores for the individual sections of the company's technical analysis, such as market momentum indicators and price trends.
|
|
6463
|
+
* @tags Technical Analysis
|
|
6464
|
+
* @name GetCompanyTechnicalSections
|
|
6465
|
+
* @summary Get Company Technical Sections
|
|
6466
|
+
* @request GET:/companies/{company_id}/technical-sections
|
|
6236
6467
|
* @secure
|
|
6237
6468
|
*/
|
|
6238
|
-
|
|
6239
|
-
/** Desired filter type. */
|
|
6240
|
-
type: BridgeWiseCompanyFilterType;
|
|
6469
|
+
getCompanyTechnicalSections(companyId: number, query?: {
|
|
6241
6470
|
/**
|
|
6242
6471
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6243
6472
|
* @default "en-US"
|
|
6244
6473
|
*/
|
|
6245
6474
|
language?: BridgeWiseLanguageEnum;
|
|
6246
|
-
|
|
6475
|
+
/**
|
|
6476
|
+
* Trading Item Id
|
|
6477
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
6478
|
+
*/
|
|
6479
|
+
trading_item_id?: number;
|
|
6480
|
+
/**
|
|
6481
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
6482
|
+
* @default "technical"
|
|
6483
|
+
*/
|
|
6484
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
6485
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisSectionsResponse, HandleError>>;
|
|
6247
6486
|
}
|
|
6248
6487
|
export class PdfReportGeneration<HandleError extends boolean = boolean> {
|
|
6249
6488
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6298,6 +6537,27 @@ export class PdfReportGeneration<HandleError extends boolean = boolean> {
|
|
|
6298
6537
|
recipient_email: string;
|
|
6299
6538
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6300
6539
|
}
|
|
6540
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
6541
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6542
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6543
|
+
/**
|
|
6544
|
+
* @description This endpoint provides filters
|
|
6545
|
+
* @tags Metadata
|
|
6546
|
+
* @name GetCompanyFilters
|
|
6547
|
+
* @summary Get Company Filters
|
|
6548
|
+
* @request GET:/filters
|
|
6549
|
+
* @secure
|
|
6550
|
+
*/
|
|
6551
|
+
getCompanyFilters(query: {
|
|
6552
|
+
/** Desired filter type. */
|
|
6553
|
+
type: BridgeWiseCompanyFilterType;
|
|
6554
|
+
/**
|
|
6555
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6556
|
+
* @default "en-US"
|
|
6557
|
+
*/
|
|
6558
|
+
language?: BridgeWiseLanguageEnum;
|
|
6559
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
6560
|
+
}
|
|
6301
6561
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
6302
6562
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6303
6563
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6696,89 +6956,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
6696
6956
|
include?: string;
|
|
6697
6957
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
6698
6958
|
}
|
|
6699
|
-
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
6700
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6701
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6702
|
-
/**
|
|
6703
|
-
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
6704
|
-
* @tags Fund ESG Analysis
|
|
6705
|
-
* @name GetFundEsgAnalysis
|
|
6706
|
-
* @summary Get Fund Esg Analysis
|
|
6707
|
-
* @request GET:/funds/{fund_id}/esg-analysis
|
|
6708
|
-
* @secure
|
|
6709
|
-
*/
|
|
6710
|
-
getFundEsgAnalysis(fundId: number, query?: {
|
|
6711
|
-
/**
|
|
6712
|
-
* Limit
|
|
6713
|
-
* Limit for ESG analysis results
|
|
6714
|
-
*/
|
|
6715
|
-
limit?: number;
|
|
6716
|
-
/**
|
|
6717
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6718
|
-
* @default "en-US"
|
|
6719
|
-
*/
|
|
6720
|
-
language?: BridgeWiseLanguageEnum;
|
|
6721
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
6722
|
-
}
|
|
6723
|
-
export class Holdings<HandleError extends boolean = boolean> {
|
|
6724
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6725
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6726
|
-
/**
|
|
6727
|
-
* @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
|
|
6728
|
-
* @tags Holdings
|
|
6729
|
-
* @name GetCompositions
|
|
6730
|
-
* @summary Get Compositions
|
|
6731
|
-
* @request GET:/funds/{fund_id}/compositions
|
|
6732
|
-
* @secure
|
|
6733
|
-
*/
|
|
6734
|
-
getCompositions(fundId: number, query?: {
|
|
6735
|
-
/**
|
|
6736
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6737
|
-
* @default "en-US"
|
|
6738
|
-
*/
|
|
6739
|
-
language?: BridgeWiseLanguageEnum;
|
|
6740
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
6741
|
-
/**
|
|
6742
|
-
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
6743
|
-
* @tags Holdings
|
|
6744
|
-
* @name GetHoldingStatistics
|
|
6745
|
-
* @summary Get Holding Statistics
|
|
6746
|
-
* @request GET:/funds/{fund_id}/holding-statistics
|
|
6747
|
-
* @secure
|
|
6748
|
-
*/
|
|
6749
|
-
getHoldingStatistics(fundId: number, query?: {
|
|
6750
|
-
/**
|
|
6751
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6752
|
-
* @default "en-US"
|
|
6753
|
-
*/
|
|
6754
|
-
language?: BridgeWiseLanguageEnum;
|
|
6755
|
-
/**
|
|
6756
|
-
* Composition Type
|
|
6757
|
-
* Composition type for fund holding statistics
|
|
6758
|
-
*/
|
|
6759
|
-
composition_type?: string;
|
|
6760
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
6761
|
-
/**
|
|
6762
|
-
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
6763
|
-
* @tags Holdings
|
|
6764
|
-
* @name GetHoldings
|
|
6765
|
-
* @summary Get Holdings
|
|
6766
|
-
* @request GET:/funds/{fund_id}/holdings
|
|
6767
|
-
* @secure
|
|
6768
|
-
*/
|
|
6769
|
-
getHoldings(fundId: number, query?: {
|
|
6770
|
-
/**
|
|
6771
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
6772
|
-
* @default "en-US"
|
|
6773
|
-
*/
|
|
6774
|
-
language?: BridgeWiseLanguageEnum;
|
|
6775
|
-
/**
|
|
6776
|
-
* Composition Type
|
|
6777
|
-
* Composition type for fund holdings
|
|
6778
|
-
*/
|
|
6779
|
-
composition_type?: string;
|
|
6780
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
6781
|
-
}
|
|
6782
6959
|
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
6783
6960
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6784
6961
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6887,24 +7064,187 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
6887
7064
|
*/
|
|
6888
7065
|
show_all?: boolean;
|
|
6889
7066
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
6890
|
-
}
|
|
6891
|
-
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
6892
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6893
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6894
7067
|
/**
|
|
6895
|
-
* @description
|
|
6896
|
-
* @tags Fund
|
|
6897
|
-
* @name
|
|
6898
|
-
* @summary Get
|
|
6899
|
-
* @request GET:/funds/{fund_id}/
|
|
7068
|
+
* @description This endpoint provides the cumulative technical analysis score for a fund, calculated based on multiple technical indicators. It includes the fund's ranking within its universe, percentile placement, and whether it falls into a Bullish, Neutral, or Bearish category.
|
|
7069
|
+
* @tags Fund Analysis
|
|
7070
|
+
* @name GetFundTechnicalAnalysis
|
|
7071
|
+
* @summary Get Fund Technical Analysis
|
|
7072
|
+
* @request GET:/funds/{fund_id}/technical-analysis
|
|
6900
7073
|
* @secure
|
|
6901
7074
|
*/
|
|
6902
|
-
|
|
7075
|
+
getFundTechnicalAnalysis(fundId: number, query?: {
|
|
7076
|
+
/**
|
|
7077
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7078
|
+
* @default "en-US"
|
|
7079
|
+
*/
|
|
7080
|
+
language?: BridgeWiseLanguageEnum;
|
|
6903
7081
|
/**
|
|
6904
7082
|
* Trading Item Id
|
|
6905
7083
|
* Specify a BW trading asset identifier for a targeted query.
|
|
6906
7084
|
*/
|
|
6907
|
-
trading_item_id?: number
|
|
7085
|
+
trading_item_id?: number;
|
|
7086
|
+
/**
|
|
7087
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
7088
|
+
* @default "technical"
|
|
7089
|
+
*/
|
|
7090
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
7091
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisepreparationSdkModelsTechAnalysisItem, HandleError>>;
|
|
7092
|
+
/**
|
|
7093
|
+
* @description This endpoint retrieves detailed technical indicator values for funds including short-term indicators (`RSI`, `STOCH`, `CCI`, `ROC`, `MFI`, `ATR`, `BBANDS`, `ULTOSC`) and long-term indicators (`5DMA`, `50DMA`, `200DMA`, `SMA`, `EMA`, `MACD`, `support`, `resistance`, `OBV`, `ADX`, `SAR`). Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
7094
|
+
* @tags Fund Analysis
|
|
7095
|
+
* @name GetFundTechnicalParameters
|
|
7096
|
+
* @summary Get Fund Technical Parameters
|
|
7097
|
+
* @request GET:/funds/{fund_id}/technical-parameters
|
|
7098
|
+
* @secure
|
|
7099
|
+
*/
|
|
7100
|
+
getFundTechnicalParameters(fundId: number, query?: {
|
|
7101
|
+
/**
|
|
7102
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7103
|
+
* @default "en-US"
|
|
7104
|
+
*/
|
|
7105
|
+
language?: BridgeWiseLanguageEnum;
|
|
7106
|
+
/**
|
|
7107
|
+
* Trading Item Id
|
|
7108
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
7109
|
+
*/
|
|
7110
|
+
trading_item_id?: number;
|
|
7111
|
+
/**
|
|
7112
|
+
* Parameter Id
|
|
7113
|
+
* Get desired parameter by ID.
|
|
7114
|
+
*/
|
|
7115
|
+
parameter_id?: number;
|
|
7116
|
+
/**
|
|
7117
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
7118
|
+
* @default "technical"
|
|
7119
|
+
*/
|
|
7120
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
7121
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
7122
|
+
/**
|
|
7123
|
+
* @description Offers scores for the individual sections of the fund's technical analysis, including Moving Averages, Momentum Indicators, Volatility & Price Structure, and Volume & Trend Strength.
|
|
7124
|
+
* @tags Fund Analysis
|
|
7125
|
+
* @name GetFundTechnicalSections
|
|
7126
|
+
* @summary Get Fund Technical Sections
|
|
7127
|
+
* @request GET:/funds/{fund_id}/technical-sections
|
|
7128
|
+
* @secure
|
|
7129
|
+
*/
|
|
7130
|
+
getFundTechnicalSections(fundId: number, query?: {
|
|
7131
|
+
/**
|
|
7132
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7133
|
+
* @default "en-US"
|
|
7134
|
+
*/
|
|
7135
|
+
language?: BridgeWiseLanguageEnum;
|
|
7136
|
+
/**
|
|
7137
|
+
* Trading Item Id
|
|
7138
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
7139
|
+
*/
|
|
7140
|
+
trading_item_id?: number;
|
|
7141
|
+
/**
|
|
7142
|
+
* Type of technical analysis: `technical` (all 18 indicators), `technical_short_term` (momentum/volatility), `technical_long_term` (trend/structure).
|
|
7143
|
+
* @default "technical"
|
|
7144
|
+
*/
|
|
7145
|
+
analysis_type?: BridgeWiseTechnicalAnalysisTypeEnum;
|
|
7146
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisSectionsResponse, HandleError>>;
|
|
7147
|
+
}
|
|
7148
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
7149
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7150
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7151
|
+
/**
|
|
7152
|
+
* @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
|
|
7153
|
+
* @tags Holdings
|
|
7154
|
+
* @name GetCompositions
|
|
7155
|
+
* @summary Get Compositions
|
|
7156
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
7157
|
+
* @secure
|
|
7158
|
+
*/
|
|
7159
|
+
getCompositions(fundId: number, query?: {
|
|
7160
|
+
/**
|
|
7161
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7162
|
+
* @default "en-US"
|
|
7163
|
+
*/
|
|
7164
|
+
language?: BridgeWiseLanguageEnum;
|
|
7165
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
7166
|
+
/**
|
|
7167
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
7168
|
+
* @tags Holdings
|
|
7169
|
+
* @name GetHoldingStatistics
|
|
7170
|
+
* @summary Get Holding Statistics
|
|
7171
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
7172
|
+
* @secure
|
|
7173
|
+
*/
|
|
7174
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
7175
|
+
/**
|
|
7176
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7177
|
+
* @default "en-US"
|
|
7178
|
+
*/
|
|
7179
|
+
language?: BridgeWiseLanguageEnum;
|
|
7180
|
+
/**
|
|
7181
|
+
* Composition Type
|
|
7182
|
+
* Composition type for fund holding statistics
|
|
7183
|
+
*/
|
|
7184
|
+
composition_type?: string;
|
|
7185
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
7186
|
+
/**
|
|
7187
|
+
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
7188
|
+
* @tags Holdings
|
|
7189
|
+
* @name GetHoldings
|
|
7190
|
+
* @summary Get Holdings
|
|
7191
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
7192
|
+
* @secure
|
|
7193
|
+
*/
|
|
7194
|
+
getHoldings(fundId: number, query?: {
|
|
7195
|
+
/**
|
|
7196
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7197
|
+
* @default "en-US"
|
|
7198
|
+
*/
|
|
7199
|
+
language?: BridgeWiseLanguageEnum;
|
|
7200
|
+
/**
|
|
7201
|
+
* Composition Type
|
|
7202
|
+
* Composition type for fund holdings
|
|
7203
|
+
*/
|
|
7204
|
+
composition_type?: string;
|
|
7205
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
7206
|
+
}
|
|
7207
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
7208
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7209
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7210
|
+
/**
|
|
7211
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
7212
|
+
* @tags Fund ESG Analysis
|
|
7213
|
+
* @name GetFundEsgAnalysis
|
|
7214
|
+
* @summary Get Fund Esg Analysis
|
|
7215
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
7216
|
+
* @secure
|
|
7217
|
+
*/
|
|
7218
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
7219
|
+
/**
|
|
7220
|
+
* Limit
|
|
7221
|
+
* Limit for ESG analysis results
|
|
7222
|
+
*/
|
|
7223
|
+
limit?: number;
|
|
7224
|
+
/**
|
|
7225
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7226
|
+
* @default "en-US"
|
|
7227
|
+
*/
|
|
7228
|
+
language?: BridgeWiseLanguageEnum;
|
|
7229
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
7230
|
+
}
|
|
7231
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
7232
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7233
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7234
|
+
/**
|
|
7235
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
7236
|
+
* @tags Fund Market Data
|
|
7237
|
+
* @name GetFundsMarketData
|
|
7238
|
+
* @summary Get Funds Market Data
|
|
7239
|
+
* @request GET:/funds/{fund_id}/market
|
|
7240
|
+
* @secure
|
|
7241
|
+
*/
|
|
7242
|
+
getFundsMarketData(fundId: number, query?: {
|
|
7243
|
+
/**
|
|
7244
|
+
* Trading Item Id
|
|
7245
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
7246
|
+
*/
|
|
7247
|
+
trading_item_id?: number | null;
|
|
6908
7248
|
/**
|
|
6909
7249
|
* Date Ge
|
|
6910
7250
|
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
@@ -6957,6 +7297,17 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
6957
7297
|
security_primary_flag?: boolean;
|
|
6958
7298
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
6959
7299
|
}
|
|
7300
|
+
export class Health<HandleError extends boolean = boolean> {
|
|
7301
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7302
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7303
|
+
/**
|
|
7304
|
+
* @name Health
|
|
7305
|
+
* @summary Health
|
|
7306
|
+
* @request GET:/health
|
|
7307
|
+
* @secure
|
|
7308
|
+
*/
|
|
7309
|
+
health(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
7310
|
+
}
|
|
6960
7311
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
6961
7312
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6962
7313
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -7011,16 +7362,89 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
7011
7362
|
segment?: string;
|
|
7012
7363
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
7013
7364
|
}
|
|
7014
|
-
export class
|
|
7365
|
+
export class Portfolios<HandleError extends boolean = boolean> {
|
|
7015
7366
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
7016
7367
|
constructor(apiClient: JwtClient<HandleError>);
|
|
7017
7368
|
/**
|
|
7018
|
-
* @
|
|
7019
|
-
* @
|
|
7020
|
-
* @
|
|
7369
|
+
* @description List all portfolios for a user on the latest business date. Optionally include metrics and/or assets via the include query parameter.
|
|
7370
|
+
* @tags Portfolios
|
|
7371
|
+
* @name GetPortfolios
|
|
7372
|
+
* @summary Get Portfolios
|
|
7373
|
+
* @request GET:/portfoliowise/portfolios
|
|
7021
7374
|
* @secure
|
|
7022
7375
|
*/
|
|
7023
|
-
|
|
7376
|
+
getPortfolios(query: {
|
|
7377
|
+
/**
|
|
7378
|
+
* Tenant Id
|
|
7379
|
+
* Tenant ID
|
|
7380
|
+
*/
|
|
7381
|
+
tenant_id: string;
|
|
7382
|
+
/**
|
|
7383
|
+
* User Id
|
|
7384
|
+
* User ID
|
|
7385
|
+
*/
|
|
7386
|
+
user_id: string;
|
|
7387
|
+
/**
|
|
7388
|
+
* Include
|
|
7389
|
+
* Comma-separated fields to include: metrics, assets
|
|
7390
|
+
*/
|
|
7391
|
+
include?: string | null;
|
|
7392
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePortfolioItem[], HandleError>>;
|
|
7393
|
+
/**
|
|
7394
|
+
* @description Get a single portfolio by ID for a user on the latest business date. Optionally include metrics and/or assets via the include query parameter.
|
|
7395
|
+
* @tags Portfolios
|
|
7396
|
+
* @name GetPortfolio
|
|
7397
|
+
* @summary Get Portfolio
|
|
7398
|
+
* @request GET:/portfoliowise/portfolios/{portfolio_id}
|
|
7399
|
+
* @secure
|
|
7400
|
+
*/
|
|
7401
|
+
getPortfolio(portfolioId: string, query: {
|
|
7402
|
+
/**
|
|
7403
|
+
* Tenant Id
|
|
7404
|
+
* Tenant ID
|
|
7405
|
+
*/
|
|
7406
|
+
tenant_id: string;
|
|
7407
|
+
/**
|
|
7408
|
+
* User Id
|
|
7409
|
+
* User ID
|
|
7410
|
+
*/
|
|
7411
|
+
user_id: string;
|
|
7412
|
+
/**
|
|
7413
|
+
* Include
|
|
7414
|
+
* Comma-separated fields to include: metrics, assets
|
|
7415
|
+
*/
|
|
7416
|
+
include?: string | null;
|
|
7417
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePortfolioItem, HandleError>>;
|
|
7418
|
+
/**
|
|
7419
|
+
* @description Get portfolio scores by tenant_id, user_id, and portfolio_id. Optionally filter by date range using date__ge and date__le.
|
|
7420
|
+
* @tags Portfolios
|
|
7421
|
+
* @name GetUserPortfolioScore
|
|
7422
|
+
* @summary Get User Portfolio Score
|
|
7423
|
+
* @request GET:/portfoliowise/portfolios/{portfolio_id}/score
|
|
7424
|
+
* @secure
|
|
7425
|
+
*/
|
|
7426
|
+
getUserPortfolioScore(portfolioId: string, query: {
|
|
7427
|
+
/**
|
|
7428
|
+
* Tenant Id
|
|
7429
|
+
* Tenant ID
|
|
7430
|
+
*/
|
|
7431
|
+
tenant_id: string;
|
|
7432
|
+
/**
|
|
7433
|
+
* User Id
|
|
7434
|
+
* User ID
|
|
7435
|
+
*/
|
|
7436
|
+
user_id: string;
|
|
7437
|
+
/**
|
|
7438
|
+
* Date Ge
|
|
7439
|
+
* Start date (inclusive)
|
|
7440
|
+
*/
|
|
7441
|
+
date__ge?: string | null;
|
|
7442
|
+
/**
|
|
7443
|
+
* Date Le
|
|
7444
|
+
* End date (inclusive)
|
|
7445
|
+
*/
|
|
7446
|
+
date__le?: string | null;
|
|
7447
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePortfolioScoreItem[], HandleError>>;
|
|
7024
7448
|
}
|
|
7025
7449
|
export class Bridget<HandleError extends boolean = boolean> {
|
|
7026
7450
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -7031,11 +7455,13 @@ export class Bridget<HandleError extends boolean = boolean> {
|
|
|
7031
7455
|
* @request POST:/questions
|
|
7032
7456
|
* @secure
|
|
7033
7457
|
*/
|
|
7034
|
-
questionsCreate(data:
|
|
7458
|
+
questionsCreate(data: BridgeWiseSubmitQuestion, headers: {
|
|
7035
7459
|
/** By adding this parameter, you apply an additional custom limit rule to users in your tenant */
|
|
7036
7460
|
"custom-request-limit-group"?: string;
|
|
7037
|
-
/**
|
|
7038
|
-
|
|
7461
|
+
/** Tenant ID; added automatically during real API calls; has to be provided if API is called from Swagger. */
|
|
7462
|
+
tenantid: string;
|
|
7463
|
+
/** User ID; added automatically during real API calls; has to be provided if API is called from Swagger. */
|
|
7464
|
+
"user-id": string;
|
|
7039
7465
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
7040
7466
|
/**
|
|
7041
7467
|
* @tags Bridget
|
|
@@ -7091,6 +7517,40 @@ export class Bridget<HandleError extends boolean = boolean> {
|
|
|
7091
7517
|
user_id?: string;
|
|
7092
7518
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
7093
7519
|
}
|
|
7520
|
+
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
7521
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7522
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7523
|
+
/**
|
|
7524
|
+
* @description Returns Bridgewise's sector strength analysis for a specified GICS sector.
|
|
7525
|
+
* @tags Sector Analysis
|
|
7526
|
+
* @name GetSectorAnalysis
|
|
7527
|
+
* @summary Get Sector Analysis
|
|
7528
|
+
* @request GET:/sectors/{sector_id}/analysis
|
|
7529
|
+
* @secure
|
|
7530
|
+
*/
|
|
7531
|
+
getSectorAnalysis(sectorId: number, query?: {
|
|
7532
|
+
/**
|
|
7533
|
+
* Year
|
|
7534
|
+
* Specify the year for which the analysis is requested.
|
|
7535
|
+
*/
|
|
7536
|
+
year?: number;
|
|
7537
|
+
/**
|
|
7538
|
+
* Quarter
|
|
7539
|
+
* Specify the quarter for which the analysis is requested.
|
|
7540
|
+
*/
|
|
7541
|
+
quarter?: number;
|
|
7542
|
+
/**
|
|
7543
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
7544
|
+
* @default "en-US"
|
|
7545
|
+
*/
|
|
7546
|
+
language?: BridgeWiseLanguageEnum;
|
|
7547
|
+
/**
|
|
7548
|
+
* Limit
|
|
7549
|
+
* Number of sector strength periods to be returned (default is 1).
|
|
7550
|
+
*/
|
|
7551
|
+
limit?: number;
|
|
7552
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
7553
|
+
}
|
|
7094
7554
|
export class Companies<HandleError extends boolean = boolean> {
|
|
7095
7555
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
7096
7556
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -13670,39 +14130,178 @@ export class Companies<HandleError extends boolean = boolean> {
|
|
|
13670
14130
|
*/
|
|
13671
14131
|
sanFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
13672
14132
|
}
|
|
13673
|
-
export class
|
|
14133
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
13674
14134
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
13675
14135
|
constructor(apiClient: JwtClient<HandleError>);
|
|
13676
14136
|
/**
|
|
13677
|
-
* @
|
|
13678
|
-
* @
|
|
13679
|
-
* @
|
|
13680
|
-
* @
|
|
13681
|
-
* @request GET:/sectors/{sector_id}/analysis
|
|
14137
|
+
* @tags Tenants
|
|
14138
|
+
* @name FetchTenant
|
|
14139
|
+
* @summary Fetch Tenant
|
|
14140
|
+
* @request GET:/tenants/{tenant_id}
|
|
13682
14141
|
* @secure
|
|
13683
14142
|
*/
|
|
13684
|
-
|
|
13685
|
-
|
|
13686
|
-
|
|
13687
|
-
|
|
13688
|
-
|
|
13689
|
-
|
|
14143
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
14144
|
+
/**
|
|
14145
|
+
* @tags Tenants
|
|
14146
|
+
* @name GetHistoricalPolicyChanges
|
|
14147
|
+
* @summary Get Historical Policy Changes
|
|
14148
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
14149
|
+
* @secure
|
|
14150
|
+
*/
|
|
14151
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
13690
14152
|
/**
|
|
13691
|
-
*
|
|
13692
|
-
* Specify
|
|
14153
|
+
* Company Ids
|
|
14154
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
14155
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
14156
|
+
* @example "74822,83343211"
|
|
13693
14157
|
*/
|
|
13694
|
-
|
|
14158
|
+
company_ids?: string;
|
|
13695
14159
|
/**
|
|
13696
|
-
*
|
|
13697
|
-
*
|
|
14160
|
+
* Start Date Gte
|
|
14161
|
+
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
14162
|
+
* @format date
|
|
13698
14163
|
*/
|
|
13699
|
-
|
|
14164
|
+
start_date__gte?: string;
|
|
13700
14165
|
/**
|
|
13701
|
-
*
|
|
13702
|
-
*
|
|
14166
|
+
* End Date Lte
|
|
14167
|
+
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
14168
|
+
* @format date
|
|
13703
14169
|
*/
|
|
13704
|
-
|
|
13705
|
-
|
|
14170
|
+
end_date__lte?: string;
|
|
14171
|
+
/**
|
|
14172
|
+
* Current Value
|
|
14173
|
+
* Specify the current value reflecting the policy change
|
|
14174
|
+
*/
|
|
14175
|
+
current_value?: number | boolean;
|
|
14176
|
+
/** Type of event that is being requested. */
|
|
14177
|
+
event_type?: BridgeWiseEventTypeEnum;
|
|
14178
|
+
/**
|
|
14179
|
+
* Size
|
|
14180
|
+
* Define the maximum number of results to retrieve.
|
|
14181
|
+
* @default 10
|
|
14182
|
+
* @example 10
|
|
14183
|
+
*/
|
|
14184
|
+
size?: number;
|
|
14185
|
+
/**
|
|
14186
|
+
* Page
|
|
14187
|
+
* Define the page number for the results.
|
|
14188
|
+
* @default 1
|
|
14189
|
+
* @example 1
|
|
14190
|
+
*/
|
|
14191
|
+
page?: number;
|
|
14192
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
14193
|
+
/**
|
|
14194
|
+
* @tags Tenants
|
|
14195
|
+
* @name CreateTenantInvestmentPoliciesConfig
|
|
14196
|
+
* @summary Create Tenant Investment Policies Config
|
|
14197
|
+
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
14198
|
+
* @secure
|
|
14199
|
+
*/
|
|
14200
|
+
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
14201
|
+
/**
|
|
14202
|
+
* @tags Tenants
|
|
14203
|
+
* @name ListTenantInvestmentPoliciesConfigs
|
|
14204
|
+
* @summary List Tenant Investment Policies Configs
|
|
14205
|
+
* @request GET:/tenants/{tenant_id}/investment-policies-config
|
|
14206
|
+
* @secure
|
|
14207
|
+
*/
|
|
14208
|
+
listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
14209
|
+
/**
|
|
14210
|
+
* @tags Tenants
|
|
14211
|
+
* @name CreateTenantInvestmentPoliciesConfigBulk
|
|
14212
|
+
* @summary Create Tenant Investment Policies Config Bulk
|
|
14213
|
+
* @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
|
|
14214
|
+
* @secure
|
|
14215
|
+
*/
|
|
14216
|
+
createTenantInvestmentPoliciesConfigBulk(tenantId: string, data: BridgeWiseInvestmentPolicyConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
14217
|
+
/**
|
|
14218
|
+
* @tags Tenants
|
|
14219
|
+
* @name GetTenantInvestmentPoliciesConfig
|
|
14220
|
+
* @summary Get Tenant Investment Policies Config
|
|
14221
|
+
* @request GET:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
14222
|
+
* @secure
|
|
14223
|
+
*/
|
|
14224
|
+
getTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
14225
|
+
/**
|
|
14226
|
+
* @tags Tenants
|
|
14227
|
+
* @name PatchTenantInvestmentPoliciesConfig
|
|
14228
|
+
* @summary Patch Tenant Investment Policies Config
|
|
14229
|
+
* @request PATCH:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
14230
|
+
* @secure
|
|
14231
|
+
*/
|
|
14232
|
+
patchTenantInvestmentPoliciesConfig(configId: number, tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
14233
|
+
/**
|
|
14234
|
+
* @tags Tenants
|
|
14235
|
+
* @name DeleteTenantInvestmentPoliciesConfig
|
|
14236
|
+
* @summary Delete Tenant Investment Policies Config
|
|
14237
|
+
* @request DELETE:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
14238
|
+
* @secure
|
|
14239
|
+
*/
|
|
14240
|
+
deleteTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
14241
|
+
/**
|
|
14242
|
+
* @tags Tenants
|
|
14243
|
+
* @name CreateCognitoClientApplication
|
|
14244
|
+
* @summary Create Cognito Client Application
|
|
14245
|
+
* @request POST:/tenants/{tenant_id}/machine
|
|
14246
|
+
* @secure
|
|
14247
|
+
*/
|
|
14248
|
+
createCognitoClientApplication(tenantId: string, data: BridgeWiseCreateTenantApp, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantApp, HandleError>>;
|
|
14249
|
+
/**
|
|
14250
|
+
* @tags Tenants
|
|
14251
|
+
* @name GetRecommendations
|
|
14252
|
+
* @summary Get Recommendations
|
|
14253
|
+
* @request GET:/tenants/{tenant_id}/recommendations
|
|
14254
|
+
* @secure
|
|
14255
|
+
*/
|
|
14256
|
+
getRecommendations(tenantId: string, query: {
|
|
14257
|
+
/**
|
|
14258
|
+
* Company Ids
|
|
14259
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
14260
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
14261
|
+
* @example "74822,83343211"
|
|
14262
|
+
*/
|
|
14263
|
+
company_ids: string;
|
|
14264
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendation[], HandleError>>;
|
|
14265
|
+
/**
|
|
14266
|
+
* @tags Tenants
|
|
14267
|
+
* @name CreateTenantRecommendationsConfig
|
|
14268
|
+
* @summary Create Tenant Recommendations Config
|
|
14269
|
+
* @request POST:/tenants/{tenant_id}/recommendations-config
|
|
14270
|
+
* @secure
|
|
14271
|
+
*/
|
|
14272
|
+
createTenantRecommendationsConfig(tenantId: string, data: BridgeWiseRecommendationConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14273
|
+
/**
|
|
14274
|
+
* @tags Tenants
|
|
14275
|
+
* @name CreateTenantRecommendationsConfigBulk
|
|
14276
|
+
* @summary Create Tenant Recommendations Config Bulk
|
|
14277
|
+
* @request POST:/tenants/{tenant_id}/recommendations-config/bulk
|
|
14278
|
+
* @secure
|
|
14279
|
+
*/
|
|
14280
|
+
createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
|
|
14281
|
+
/**
|
|
14282
|
+
* @tags Tenants
|
|
14283
|
+
* @name GetTenantRecommendationsConfig
|
|
14284
|
+
* @summary Get Tenant Recommendations Config
|
|
14285
|
+
* @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14286
|
+
* @secure
|
|
14287
|
+
*/
|
|
14288
|
+
getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14289
|
+
/**
|
|
14290
|
+
* @tags Tenants
|
|
14291
|
+
* @name PatchTenantRecommendationsConfig
|
|
14292
|
+
* @summary Patch Tenant Recommendations Config
|
|
14293
|
+
* @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14294
|
+
* @secure
|
|
14295
|
+
*/
|
|
14296
|
+
patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14297
|
+
/**
|
|
14298
|
+
* @tags Tenants
|
|
14299
|
+
* @name DeleteTenantRecommendationsConfig
|
|
14300
|
+
* @summary Delete Tenant Recommendations Config
|
|
14301
|
+
* @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14302
|
+
* @secure
|
|
14303
|
+
*/
|
|
14304
|
+
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
13706
14305
|
}
|
|
13707
14306
|
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
13708
14307
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -13761,6 +14360,29 @@ export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
|
13761
14360
|
*/
|
|
13762
14361
|
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
13763
14362
|
}
|
|
14363
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
14364
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
14365
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
14366
|
+
/**
|
|
14367
|
+
* @tags Users
|
|
14368
|
+
* @name Authenticate
|
|
14369
|
+
* @summary Authenticate
|
|
14370
|
+
* @request POST:/users/authenticate
|
|
14371
|
+
* @secure
|
|
14372
|
+
*/
|
|
14373
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
14374
|
+
/**
|
|
14375
|
+
* @tags Users
|
|
14376
|
+
* @name FetchClientDetails
|
|
14377
|
+
* @summary Fetch Client Details
|
|
14378
|
+
* @request GET:/users/machine
|
|
14379
|
+
* @secure
|
|
14380
|
+
*/
|
|
14381
|
+
fetchClientDetails(headers: {
|
|
14382
|
+
/** Authorization */
|
|
14383
|
+
authorization: string;
|
|
14384
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
14385
|
+
}
|
|
13764
14386
|
export class Themes<HandleError extends boolean = boolean> {
|
|
13765
14387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
13766
14388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -13852,202 +14474,6 @@ export class Themes<HandleError extends boolean = boolean> {
|
|
|
13852
14474
|
*/
|
|
13853
14475
|
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
13854
14476
|
}
|
|
13855
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
13856
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13857
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13858
|
-
/**
|
|
13859
|
-
* @tags Users
|
|
13860
|
-
* @name Authenticate
|
|
13861
|
-
* @summary Authenticate
|
|
13862
|
-
* @request POST:/users/authenticate
|
|
13863
|
-
* @secure
|
|
13864
|
-
*/
|
|
13865
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
13866
|
-
/**
|
|
13867
|
-
* @tags Users
|
|
13868
|
-
* @name FetchClientDetails
|
|
13869
|
-
* @summary Fetch Client Details
|
|
13870
|
-
* @request GET:/users/machine
|
|
13871
|
-
* @secure
|
|
13872
|
-
*/
|
|
13873
|
-
fetchClientDetails(headers: {
|
|
13874
|
-
/** Authorization */
|
|
13875
|
-
authorization: string;
|
|
13876
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
13877
|
-
}
|
|
13878
|
-
export class Tenants<HandleError extends boolean = boolean> {
|
|
13879
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
13880
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
13881
|
-
/**
|
|
13882
|
-
* @tags Tenants
|
|
13883
|
-
* @name FetchTenant
|
|
13884
|
-
* @summary Fetch Tenant
|
|
13885
|
-
* @request GET:/tenants/{tenant_id}
|
|
13886
|
-
* @secure
|
|
13887
|
-
*/
|
|
13888
|
-
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
13889
|
-
/**
|
|
13890
|
-
* @tags Tenants
|
|
13891
|
-
* @name GetHistoricalPolicyChanges
|
|
13892
|
-
* @summary Get Historical Policy Changes
|
|
13893
|
-
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
13894
|
-
* @secure
|
|
13895
|
-
*/
|
|
13896
|
-
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
13897
|
-
/**
|
|
13898
|
-
* Company Ids
|
|
13899
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
13900
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
13901
|
-
* @example "74822,83343211"
|
|
13902
|
-
*/
|
|
13903
|
-
company_ids?: string;
|
|
13904
|
-
/**
|
|
13905
|
-
* Start Date Gte
|
|
13906
|
-
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
13907
|
-
* @format date
|
|
13908
|
-
*/
|
|
13909
|
-
start_date__gte?: string;
|
|
13910
|
-
/**
|
|
13911
|
-
* End Date Lte
|
|
13912
|
-
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
13913
|
-
* @format date
|
|
13914
|
-
*/
|
|
13915
|
-
end_date__lte?: string;
|
|
13916
|
-
/**
|
|
13917
|
-
* Current Value
|
|
13918
|
-
* Specify the current value reflecting the policy change
|
|
13919
|
-
*/
|
|
13920
|
-
current_value?: number | boolean;
|
|
13921
|
-
/** Type of event that is being requested. */
|
|
13922
|
-
event_type?: BridgeWiseEventTypeEnum;
|
|
13923
|
-
/**
|
|
13924
|
-
* Size
|
|
13925
|
-
* Define the maximum number of results to retrieve.
|
|
13926
|
-
* @default 10
|
|
13927
|
-
* @example 10
|
|
13928
|
-
*/
|
|
13929
|
-
size?: number;
|
|
13930
|
-
/**
|
|
13931
|
-
* Page
|
|
13932
|
-
* Define the page number for the results.
|
|
13933
|
-
* @default 1
|
|
13934
|
-
* @example 1
|
|
13935
|
-
*/
|
|
13936
|
-
page?: number;
|
|
13937
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseHistoricalPolicyChangesModel, HandleError>>;
|
|
13938
|
-
/**
|
|
13939
|
-
* @tags Tenants
|
|
13940
|
-
* @name CreateTenantInvestmentPoliciesConfig
|
|
13941
|
-
* @summary Create Tenant Investment Policies Config
|
|
13942
|
-
* @request POST:/tenants/{tenant_id}/investment-policies-config
|
|
13943
|
-
* @secure
|
|
13944
|
-
*/
|
|
13945
|
-
createTenantInvestmentPoliciesConfig(tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
13946
|
-
/**
|
|
13947
|
-
* @tags Tenants
|
|
13948
|
-
* @name ListTenantInvestmentPoliciesConfigs
|
|
13949
|
-
* @summary List Tenant Investment Policies Configs
|
|
13950
|
-
* @request GET:/tenants/{tenant_id}/investment-policies-config
|
|
13951
|
-
* @secure
|
|
13952
|
-
*/
|
|
13953
|
-
listTenantInvestmentPoliciesConfigs(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
13954
|
-
/**
|
|
13955
|
-
* @tags Tenants
|
|
13956
|
-
* @name CreateTenantInvestmentPoliciesConfigBulk
|
|
13957
|
-
* @summary Create Tenant Investment Policies Config Bulk
|
|
13958
|
-
* @request POST:/tenants/{tenant_id}/investment-policies-config/bulk
|
|
13959
|
-
* @secure
|
|
13960
|
-
*/
|
|
13961
|
-
createTenantInvestmentPoliciesConfigBulk(tenantId: string, data: BridgeWiseInvestmentPolicyConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig[], HandleError>>;
|
|
13962
|
-
/**
|
|
13963
|
-
* @tags Tenants
|
|
13964
|
-
* @name GetTenantInvestmentPoliciesConfig
|
|
13965
|
-
* @summary Get Tenant Investment Policies Config
|
|
13966
|
-
* @request GET:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
13967
|
-
* @secure
|
|
13968
|
-
*/
|
|
13969
|
-
getTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
13970
|
-
/**
|
|
13971
|
-
* @tags Tenants
|
|
13972
|
-
* @name PatchTenantInvestmentPoliciesConfig
|
|
13973
|
-
* @summary Patch Tenant Investment Policies Config
|
|
13974
|
-
* @request PATCH:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
13975
|
-
* @secure
|
|
13976
|
-
*/
|
|
13977
|
-
patchTenantInvestmentPoliciesConfig(configId: number, tenantId: string, data: BridgeWiseInvestmentPolicyConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseInvestmentPolicyConfig, HandleError>>;
|
|
13978
|
-
/**
|
|
13979
|
-
* @tags Tenants
|
|
13980
|
-
* @name DeleteTenantInvestmentPoliciesConfig
|
|
13981
|
-
* @summary Delete Tenant Investment Policies Config
|
|
13982
|
-
* @request DELETE:/tenants/{tenant_id}/investment-policies-config/{config_id}
|
|
13983
|
-
* @secure
|
|
13984
|
-
*/
|
|
13985
|
-
deleteTenantInvestmentPoliciesConfig(configId: number, tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
13986
|
-
/**
|
|
13987
|
-
* @tags Tenants
|
|
13988
|
-
* @name CreateCognitoClientApplication
|
|
13989
|
-
* @summary Create Cognito Client Application
|
|
13990
|
-
* @request POST:/tenants/{tenant_id}/machine
|
|
13991
|
-
* @secure
|
|
13992
|
-
*/
|
|
13993
|
-
createCognitoClientApplication(tenantId: string, data: BridgeWiseCreateTenantApp, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantApp, HandleError>>;
|
|
13994
|
-
/**
|
|
13995
|
-
* @tags Tenants
|
|
13996
|
-
* @name GetRecommendations
|
|
13997
|
-
* @summary Get Recommendations
|
|
13998
|
-
* @request GET:/tenants/{tenant_id}/recommendations
|
|
13999
|
-
* @secure
|
|
14000
|
-
*/
|
|
14001
|
-
getRecommendations(tenantId: string, query: {
|
|
14002
|
-
/**
|
|
14003
|
-
* Company Ids
|
|
14004
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
14005
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
14006
|
-
* @example "74822,83343211"
|
|
14007
|
-
*/
|
|
14008
|
-
company_ids: string;
|
|
14009
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendation[], HandleError>>;
|
|
14010
|
-
/**
|
|
14011
|
-
* @tags Tenants
|
|
14012
|
-
* @name CreateTenantRecommendationsConfig
|
|
14013
|
-
* @summary Create Tenant Recommendations Config
|
|
14014
|
-
* @request POST:/tenants/{tenant_id}/recommendations-config
|
|
14015
|
-
* @secure
|
|
14016
|
-
*/
|
|
14017
|
-
createTenantRecommendationsConfig(tenantId: string, data: BridgeWiseRecommendationConfig, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14018
|
-
/**
|
|
14019
|
-
* @tags Tenants
|
|
14020
|
-
* @name CreateTenantRecommendationsConfigBulk
|
|
14021
|
-
* @summary Create Tenant Recommendations Config Bulk
|
|
14022
|
-
* @request POST:/tenants/{tenant_id}/recommendations-config/bulk
|
|
14023
|
-
* @secure
|
|
14024
|
-
*/
|
|
14025
|
-
createTenantRecommendationsConfigBulk(tenantId: string, data: BridgeWiseRecommendationConfig[], config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig[], HandleError>>;
|
|
14026
|
-
/**
|
|
14027
|
-
* @tags Tenants
|
|
14028
|
-
* @name GetTenantRecommendationsConfig
|
|
14029
|
-
* @summary Get Tenant Recommendations Config
|
|
14030
|
-
* @request GET:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14031
|
-
* @secure
|
|
14032
|
-
*/
|
|
14033
|
-
getTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14034
|
-
/**
|
|
14035
|
-
* @tags Tenants
|
|
14036
|
-
* @name PatchTenantRecommendationsConfig
|
|
14037
|
-
* @summary Patch Tenant Recommendations Config
|
|
14038
|
-
* @request PATCH:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14039
|
-
* @secure
|
|
14040
|
-
*/
|
|
14041
|
-
patchTenantRecommendationsConfig(tenantId: string, companyId: number, data: BridgeWiseRecommendationConfigPatch, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecommendationConfig, HandleError>>;
|
|
14042
|
-
/**
|
|
14043
|
-
* @tags Tenants
|
|
14044
|
-
* @name DeleteTenantRecommendationsConfig
|
|
14045
|
-
* @summary Delete Tenant Recommendations Config
|
|
14046
|
-
* @request DELETE:/tenants/{tenant_id}/recommendations-config/{company_id}
|
|
14047
|
-
* @secure
|
|
14048
|
-
*/
|
|
14049
|
-
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
14050
|
-
}
|
|
14051
14477
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
14052
14478
|
readonly config: JwtClientConfig<HandleError>;
|
|
14053
14479
|
activities: Activities<HandleError>;
|
|
@@ -14073,6 +14499,7 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
14073
14499
|
logos: Logos<HandleError>;
|
|
14074
14500
|
metadata: Metadata<HandleError>;
|
|
14075
14501
|
pdfReportGeneration: PdfReportGeneration<HandleError>;
|
|
14502
|
+
portfolios: Portfolios<HandleError>;
|
|
14076
14503
|
sectorAnalysis: SectorAnalysis<HandleError>;
|
|
14077
14504
|
segmentations: Segmentations<HandleError>;
|
|
14078
14505
|
technicalAnalysis: TechnicalAnalysis<HandleError>;
|