@orbis-systems/orbis-api-clients 0.7.11 → 0.7.13
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 +119 -119
- 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 +608 -608
- 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 +1349 -1174
- 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 +73 -73
- 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 +3947 -3947
- 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 +616 -616
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +660 -660
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -101,7 +101,7 @@ export interface BridgeWiseExternalQuestionRequest {
|
|
|
101
101
|
*/
|
|
102
102
|
message: string;
|
|
103
103
|
/**
|
|
104
|
-
* Single chat session ID like:
|
|
104
|
+
* Single chat session ID like: 7f6ea4ed-1702-454a-9ee7-0c49efcb014b
|
|
105
105
|
* @maxLength 256
|
|
106
106
|
*/
|
|
107
107
|
session_id: string;
|
|
@@ -3031,6 +3031,98 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
3031
3031
|
Iso = "iso",
|
|
3032
3032
|
Epoch = "epoch"
|
|
3033
3033
|
}
|
|
3034
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
3035
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3037
|
+
/**
|
|
3038
|
+
* @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.
|
|
3039
|
+
* @tags Activities
|
|
3040
|
+
* @name GetCompanyAlerts
|
|
3041
|
+
* @summary Get Company Alerts
|
|
3042
|
+
* @request GET:/companies/{company_id}/alerts
|
|
3043
|
+
* @secure
|
|
3044
|
+
*/
|
|
3045
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
3046
|
+
/**
|
|
3047
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3048
|
+
* @default "en-US"
|
|
3049
|
+
*/
|
|
3050
|
+
language?: BridgeWiseLanguageEnum;
|
|
3051
|
+
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
3052
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
3053
|
+
/** Filter alerts by their sentiment. */
|
|
3054
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
3055
|
+
/**
|
|
3056
|
+
* Importance
|
|
3057
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3058
|
+
*/
|
|
3059
|
+
importance?: string | null;
|
|
3060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
3061
|
+
/**
|
|
3062
|
+
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
3063
|
+
* @tags Activities
|
|
3064
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
3065
|
+
* @summary Get Company Forecasts Key Development
|
|
3066
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
3067
|
+
* @secure
|
|
3068
|
+
*/
|
|
3069
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
3070
|
+
/**
|
|
3071
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3072
|
+
* @default "en-US"
|
|
3073
|
+
*/
|
|
3074
|
+
language?: BridgeWiseLanguageEnum;
|
|
3075
|
+
/**
|
|
3076
|
+
* Importance
|
|
3077
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
3078
|
+
* @default "0,1"
|
|
3079
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3080
|
+
*/
|
|
3081
|
+
importance?: string;
|
|
3082
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
3083
|
+
}
|
|
3084
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
3085
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3086
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3087
|
+
/**
|
|
3088
|
+
* @tags Bridget
|
|
3089
|
+
* @name QuestionCreate
|
|
3090
|
+
* @request POST:/bridget/question
|
|
3091
|
+
* @secure
|
|
3092
|
+
*/
|
|
3093
|
+
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3094
|
+
/**
|
|
3095
|
+
* @tags Bridget
|
|
3096
|
+
* @name TenantsExportRetrieve
|
|
3097
|
+
* @request GET:/bridget/tenants/{tenant_id}/export
|
|
3098
|
+
* @secure
|
|
3099
|
+
*/
|
|
3100
|
+
tenantsExportRetrieve(tenantId: string, query?: {
|
|
3101
|
+
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3102
|
+
client_id?: string;
|
|
3103
|
+
/**
|
|
3104
|
+
* Returns logs only for the specified calendar day (00:00–23:59 tenant time zone). Use either this field or the start_date + end_date pair — never both in the same request.
|
|
3105
|
+
* @format date
|
|
3106
|
+
*/
|
|
3107
|
+
date?: string;
|
|
3108
|
+
/**
|
|
3109
|
+
* Inclusive end of a date range (must be ≥ start_date). Use either the date field or this start_date + end_date pair — never both in the same request.
|
|
3110
|
+
* @format date
|
|
3111
|
+
*/
|
|
3112
|
+
end_date?: string;
|
|
3113
|
+
/** Filters by user feedback on each answer. Allowed values: like | dislike */
|
|
3114
|
+
feedback_type?: string;
|
|
3115
|
+
/** Filters to a single chat session ID. */
|
|
3116
|
+
session_id?: string;
|
|
3117
|
+
/**
|
|
3118
|
+
* Inclusive start of a date range. Use either the date field or this start_date + end_date pair — never both in the same request. Required when end_date is provided.
|
|
3119
|
+
* @format date
|
|
3120
|
+
*/
|
|
3121
|
+
start_date?: string;
|
|
3122
|
+
/** Filters logs to a single end-user within the tenant. */
|
|
3123
|
+
user_id?: string;
|
|
3124
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3125
|
+
}
|
|
3034
3126
|
export class Bwc<HandleError extends boolean = boolean> {
|
|
3035
3127
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
3128
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3358,47 +3450,74 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
3358
3450
|
identifier: string;
|
|
3359
3451
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3360
3452
|
}
|
|
3361
|
-
export class
|
|
3453
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3362
3454
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3363
3455
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3364
3456
|
/**
|
|
3365
|
-
* @
|
|
3366
|
-
* @
|
|
3367
|
-
* @
|
|
3457
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3458
|
+
* @tags Company Market Data
|
|
3459
|
+
* @name GetCompanyMarketData
|
|
3460
|
+
* @summary Get Company Market Data
|
|
3461
|
+
* @request GET:/companies/{company_id}/market
|
|
3368
3462
|
* @secure
|
|
3369
3463
|
*/
|
|
3370
|
-
|
|
3464
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
3465
|
+
/**
|
|
3466
|
+
* Trading Item Id
|
|
3467
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3468
|
+
*/
|
|
3469
|
+
trading_item_id?: number | null;
|
|
3470
|
+
/**
|
|
3471
|
+
* Date Ge
|
|
3472
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3473
|
+
*/
|
|
3474
|
+
date__ge?: string | null;
|
|
3475
|
+
/**
|
|
3476
|
+
* Date Le
|
|
3477
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3478
|
+
*/
|
|
3479
|
+
date__le?: string | null;
|
|
3480
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3371
3481
|
/**
|
|
3372
|
-
* @
|
|
3373
|
-
* @
|
|
3374
|
-
* @
|
|
3482
|
+
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
3483
|
+
* @tags Company Market Data
|
|
3484
|
+
* @name GetCompanyMarketStatistics
|
|
3485
|
+
* @summary Get Company Market Statistics
|
|
3486
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
3375
3487
|
* @secure
|
|
3376
3488
|
*/
|
|
3377
|
-
|
|
3378
|
-
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3379
|
-
client_id?: string;
|
|
3489
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3380
3490
|
/**
|
|
3381
|
-
*
|
|
3382
|
-
*
|
|
3491
|
+
* Trading Item Id
|
|
3492
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3383
3493
|
*/
|
|
3384
|
-
|
|
3494
|
+
trading_item_id?: number | null;
|
|
3385
3495
|
/**
|
|
3386
|
-
*
|
|
3387
|
-
*
|
|
3496
|
+
* Identifier In
|
|
3497
|
+
* Specify a list of external identifiers.
|
|
3388
3498
|
*/
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3393
|
-
|
|
3499
|
+
identifier__in?: string | null;
|
|
3500
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
3501
|
+
/**
|
|
3502
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3503
|
+
* @tags Company Market Data
|
|
3504
|
+
* @name GetTradingItems
|
|
3505
|
+
* @summary Get Trading Items
|
|
3506
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
3507
|
+
* @secure
|
|
3508
|
+
*/
|
|
3509
|
+
getTradingItems(companyId: number, query?: {
|
|
3394
3510
|
/**
|
|
3395
|
-
*
|
|
3396
|
-
*
|
|
3511
|
+
* Primary Flag
|
|
3512
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3397
3513
|
*/
|
|
3398
|
-
|
|
3399
|
-
/**
|
|
3400
|
-
|
|
3401
|
-
|
|
3514
|
+
primary_flag?: boolean;
|
|
3515
|
+
/**
|
|
3516
|
+
* Security Primary Flag
|
|
3517
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3518
|
+
*/
|
|
3519
|
+
security_primary_flag?: boolean;
|
|
3520
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3402
3521
|
}
|
|
3403
3522
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3404
3523
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4039,78 +4158,106 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4039
4158
|
identifier_type: string;
|
|
4040
4159
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4041
4160
|
}
|
|
4042
|
-
export class
|
|
4161
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4043
4162
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4044
4163
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4045
4164
|
/**
|
|
4046
|
-
* @description
|
|
4047
|
-
* @tags
|
|
4048
|
-
* @name
|
|
4049
|
-
* @summary Get Company
|
|
4050
|
-
* @request GET:/companies/{company_id}/
|
|
4165
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
4166
|
+
* @tags Company News
|
|
4167
|
+
* @name GetCompanyNews
|
|
4168
|
+
* @summary Get Company News
|
|
4169
|
+
* @request GET:/companies/{company_id}/news
|
|
4051
4170
|
* @secure
|
|
4052
4171
|
*/
|
|
4053
|
-
|
|
4172
|
+
getCompanyNews(companyId: number, query?: {
|
|
4054
4173
|
/**
|
|
4174
|
+
* Languages
|
|
4055
4175
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4056
4176
|
* @default "en-US"
|
|
4177
|
+
* @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))*$
|
|
4057
4178
|
*/
|
|
4058
|
-
|
|
4059
|
-
/** Specify the group of the alert type that will be presented (fundamental or market). */
|
|
4060
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
4061
|
-
/** Filter alerts by their sentiment. */
|
|
4062
|
-
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
4063
|
-
/**
|
|
4064
|
-
* Importance
|
|
4065
|
-
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
4066
|
-
*/
|
|
4067
|
-
importance?: string | null;
|
|
4068
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
4069
|
-
/**
|
|
4070
|
-
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
4071
|
-
* @tags Activities
|
|
4072
|
-
* @name GetCompanyForecastsKeyDevelopment
|
|
4073
|
-
* @summary Get Company Forecasts Key Development
|
|
4074
|
-
* @request GET:/companies/{company_id}/key-developments
|
|
4075
|
-
* @secure
|
|
4076
|
-
*/
|
|
4077
|
-
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
4179
|
+
languages?: string;
|
|
4078
4180
|
/**
|
|
4079
|
-
*
|
|
4080
|
-
*
|
|
4181
|
+
* Published Date Gte
|
|
4182
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4183
|
+
* @format date
|
|
4184
|
+
* @default "2025-07-22"
|
|
4081
4185
|
*/
|
|
4082
|
-
|
|
4186
|
+
published_date__gte?: string;
|
|
4083
4187
|
/**
|
|
4084
|
-
*
|
|
4085
|
-
*
|
|
4086
|
-
* @
|
|
4087
|
-
* @
|
|
4188
|
+
* Published Date Lte
|
|
4189
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4190
|
+
* @format date
|
|
4191
|
+
* @default "2025-07-22"
|
|
4088
4192
|
*/
|
|
4089
|
-
|
|
4090
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
4091
|
-
}
|
|
4092
|
-
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
4093
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4094
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4095
|
-
/**
|
|
4096
|
-
* @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.
|
|
4097
|
-
* @tags Consensus Analysts
|
|
4098
|
-
* @name GetConsensusRatings
|
|
4099
|
-
* @summary Get Consensus Ratings
|
|
4100
|
-
* @request GET:/companies/{company_id}/consensus-ratings
|
|
4101
|
-
* @secure
|
|
4102
|
-
*/
|
|
4103
|
-
getConsensusRatings(companyId: number, query?: {
|
|
4193
|
+
published_date__lte?: string;
|
|
4104
4194
|
/**
|
|
4105
|
-
*
|
|
4106
|
-
*
|
|
4195
|
+
* Specify the field by which to sort the results.
|
|
4196
|
+
* @default "publication_date"
|
|
4107
4197
|
*/
|
|
4108
|
-
|
|
4198
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
4109
4199
|
/**
|
|
4110
|
-
*
|
|
4111
|
-
*
|
|
4200
|
+
* Size
|
|
4201
|
+
* Define the number of records per page for pagination purposes.
|
|
4202
|
+
* @default 10
|
|
4203
|
+
* @example 10
|
|
4112
4204
|
*/
|
|
4113
|
-
|
|
4205
|
+
size?: number;
|
|
4206
|
+
/**
|
|
4207
|
+
* Page
|
|
4208
|
+
* Define the page number for pagination.
|
|
4209
|
+
* @default 1
|
|
4210
|
+
* @example 1
|
|
4211
|
+
*/
|
|
4212
|
+
page?: number;
|
|
4213
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
4214
|
+
/**
|
|
4215
|
+
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
4216
|
+
* @tags Company News
|
|
4217
|
+
* @name GetAverageCompanyNewsSentiment
|
|
4218
|
+
* @summary Get Average Company News Sentiment
|
|
4219
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
4220
|
+
* @secure
|
|
4221
|
+
*/
|
|
4222
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4223
|
+
/**
|
|
4224
|
+
* Published Date Gte
|
|
4225
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4226
|
+
* @format date
|
|
4227
|
+
* @default "2025-07-22"
|
|
4228
|
+
*/
|
|
4229
|
+
published_date__gte?: string;
|
|
4230
|
+
/**
|
|
4231
|
+
* Published Date Lte
|
|
4232
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4233
|
+
* @format date
|
|
4234
|
+
* @default "2025-07-22"
|
|
4235
|
+
*/
|
|
4236
|
+
published_date__lte?: string;
|
|
4237
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4238
|
+
}
|
|
4239
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
4240
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4241
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4242
|
+
/**
|
|
4243
|
+
* @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.
|
|
4244
|
+
* @tags Consensus Analysts
|
|
4245
|
+
* @name GetConsensusRatings
|
|
4246
|
+
* @summary Get Consensus Ratings
|
|
4247
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
4248
|
+
* @secure
|
|
4249
|
+
*/
|
|
4250
|
+
getConsensusRatings(companyId: number, query?: {
|
|
4251
|
+
/**
|
|
4252
|
+
* Trading Item Id
|
|
4253
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4254
|
+
*/
|
|
4255
|
+
trading_item_id?: number;
|
|
4256
|
+
/**
|
|
4257
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4258
|
+
* @default "en-US"
|
|
4259
|
+
*/
|
|
4260
|
+
language?: BridgeWiseLanguageEnum;
|
|
4114
4261
|
/**
|
|
4115
4262
|
* Date Gte
|
|
4116
4263
|
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
@@ -4164,51 +4311,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4164
4311
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4165
4312
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
4166
4313
|
}
|
|
4167
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
4168
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4169
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4170
|
-
/**
|
|
4171
|
-
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4172
|
-
* @tags Logos
|
|
4173
|
-
* @name FetchLogos
|
|
4174
|
-
* @summary Fetch Logos
|
|
4175
|
-
* @request GET:/companies/logos
|
|
4176
|
-
* @secure
|
|
4177
|
-
*/
|
|
4178
|
-
fetchLogos(query?: {
|
|
4179
|
-
/**
|
|
4180
|
-
* Company Id In
|
|
4181
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
4182
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4183
|
-
* @example "74822,83343211"
|
|
4184
|
-
*/
|
|
4185
|
-
company_id__in?: string;
|
|
4186
|
-
/**
|
|
4187
|
-
* Size
|
|
4188
|
-
* Page size
|
|
4189
|
-
* @min 1
|
|
4190
|
-
* @max 100
|
|
4191
|
-
* @default 50
|
|
4192
|
-
*/
|
|
4193
|
-
size?: number;
|
|
4194
|
-
/**
|
|
4195
|
-
* Page
|
|
4196
|
-
* Page number
|
|
4197
|
-
* @min 1
|
|
4198
|
-
* @default 1
|
|
4199
|
-
*/
|
|
4200
|
-
page?: number;
|
|
4201
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4202
|
-
/**
|
|
4203
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4204
|
-
* @tags Logos
|
|
4205
|
-
* @name FetchLogo
|
|
4206
|
-
* @summary Fetch Logo
|
|
4207
|
-
* @request GET:/companies/{company_id}/logos
|
|
4208
|
-
* @secure
|
|
4209
|
-
*/
|
|
4210
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4211
|
-
}
|
|
4212
4314
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4213
4315
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4214
4316
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4488,360 +4590,207 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4488
4590
|
date__lte?: string;
|
|
4489
4591
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4490
4592
|
}
|
|
4491
|
-
export class
|
|
4593
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
4492
4594
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4493
4595
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4494
4596
|
/**
|
|
4495
|
-
* @description
|
|
4496
|
-
* @tags
|
|
4497
|
-
* @name
|
|
4498
|
-
* @summary Get
|
|
4499
|
-
* @request GET:/
|
|
4597
|
+
* @description Returns Bridgewise final analysis for a specified fund.
|
|
4598
|
+
* @tags Fund Analysis
|
|
4599
|
+
* @name GetFundAnalysis
|
|
4600
|
+
* @summary Get Fund Analysis
|
|
4601
|
+
* @request GET:/funds/{fund_id}/analysis
|
|
4500
4602
|
* @secure
|
|
4501
4603
|
*/
|
|
4502
|
-
|
|
4503
|
-
/**
|
|
4504
|
-
* Trading Item Id
|
|
4505
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4506
|
-
*/
|
|
4507
|
-
trading_item_id?: number | null;
|
|
4604
|
+
getFundAnalysis(fundId: number, query?: {
|
|
4508
4605
|
/**
|
|
4509
|
-
*
|
|
4510
|
-
*
|
|
4606
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4607
|
+
* @default "en-US"
|
|
4511
4608
|
*/
|
|
4512
|
-
|
|
4609
|
+
language?: BridgeWiseLanguageEnum;
|
|
4513
4610
|
/**
|
|
4514
|
-
*
|
|
4515
|
-
* Specify the
|
|
4611
|
+
* Year
|
|
4612
|
+
* Specify the year for which the analysis is requested.
|
|
4516
4613
|
*/
|
|
4517
|
-
|
|
4518
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4519
|
-
/**
|
|
4520
|
-
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4521
|
-
* @tags Company Market Data
|
|
4522
|
-
* @name GetCompanyMarketStatistics
|
|
4523
|
-
* @summary Get Company Market Statistics
|
|
4524
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
4525
|
-
* @secure
|
|
4526
|
-
*/
|
|
4527
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4614
|
+
year?: number;
|
|
4528
4615
|
/**
|
|
4529
|
-
*
|
|
4530
|
-
* Specify
|
|
4616
|
+
* Quarter
|
|
4617
|
+
* Specify the quarter for which the analysis is requested.
|
|
4531
4618
|
*/
|
|
4532
|
-
|
|
4619
|
+
quarter?: number;
|
|
4533
4620
|
/**
|
|
4534
|
-
*
|
|
4535
|
-
*
|
|
4621
|
+
* Show All
|
|
4622
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4536
4623
|
*/
|
|
4537
|
-
|
|
4538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4624
|
+
show_all?: boolean;
|
|
4625
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
4539
4626
|
/**
|
|
4540
|
-
* @description Returns
|
|
4541
|
-
* @tags
|
|
4542
|
-
* @name
|
|
4543
|
-
* @summary Get
|
|
4544
|
-
* @request GET:/
|
|
4627
|
+
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
4628
|
+
* @tags Fund Analysis
|
|
4629
|
+
* @name GetFundsParagraphs
|
|
4630
|
+
* @summary Get Funds Paragraphs
|
|
4631
|
+
* @request GET:/funds/{fund_id}/paragraphs
|
|
4545
4632
|
* @secure
|
|
4546
4633
|
*/
|
|
4547
|
-
|
|
4634
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
4548
4635
|
/**
|
|
4549
|
-
*
|
|
4550
|
-
*
|
|
4636
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4637
|
+
* @default "en-US"
|
|
4551
4638
|
*/
|
|
4552
|
-
|
|
4639
|
+
language?: BridgeWiseLanguageEnum;
|
|
4553
4640
|
/**
|
|
4554
|
-
*
|
|
4555
|
-
*
|
|
4641
|
+
* Year
|
|
4642
|
+
* Specify the year for which the analysis is requested.
|
|
4556
4643
|
*/
|
|
4557
|
-
|
|
4558
|
-
|
|
4559
|
-
|
|
4560
|
-
|
|
4561
|
-
|
|
4562
|
-
|
|
4644
|
+
year?: number | null;
|
|
4645
|
+
/**
|
|
4646
|
+
* Quarter
|
|
4647
|
+
* Specify the quarter for which the analysis is requested.
|
|
4648
|
+
*/
|
|
4649
|
+
quarter?: number | null;
|
|
4650
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
4563
4651
|
/**
|
|
4564
|
-
* @description
|
|
4565
|
-
* @tags
|
|
4566
|
-
* @name
|
|
4567
|
-
* @summary Get
|
|
4568
|
-
* @request GET:/
|
|
4652
|
+
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
4653
|
+
* @tags Fund Analysis
|
|
4654
|
+
* @name GetFundParameters
|
|
4655
|
+
* @summary Get Fund Parameters
|
|
4656
|
+
* @request GET:/funds/{fund_id}/parameters
|
|
4569
4657
|
* @secure
|
|
4570
4658
|
*/
|
|
4571
|
-
|
|
4659
|
+
getFundParameters(fundId: number, query?: {
|
|
4572
4660
|
/**
|
|
4573
|
-
* Languages
|
|
4574
4661
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4575
4662
|
* @default "en-US"
|
|
4576
|
-
* @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))*$
|
|
4577
4663
|
*/
|
|
4578
|
-
|
|
4664
|
+
language?: BridgeWiseLanguageEnum;
|
|
4579
4665
|
/**
|
|
4580
|
-
*
|
|
4581
|
-
*
|
|
4582
|
-
* @format date
|
|
4583
|
-
* @default "2025-07-22"
|
|
4666
|
+
* Parameter Id
|
|
4667
|
+
* ID of the parameter for analysis.
|
|
4584
4668
|
*/
|
|
4585
|
-
|
|
4669
|
+
parameter_id?: number;
|
|
4670
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
4671
|
+
/**
|
|
4672
|
+
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
4673
|
+
* @tags Fund Analysis
|
|
4674
|
+
* @name GetFundSections
|
|
4675
|
+
* @summary Get Fund Sections
|
|
4676
|
+
* @request GET:/funds/{fund_id}/sections
|
|
4677
|
+
* @secure
|
|
4678
|
+
*/
|
|
4679
|
+
getFundSections(fundId: number, query?: {
|
|
4586
4680
|
/**
|
|
4587
|
-
*
|
|
4588
|
-
*
|
|
4589
|
-
* @format date
|
|
4590
|
-
* @default "2025-07-22"
|
|
4681
|
+
* Year
|
|
4682
|
+
* Specify the year for which the analysis is requested.
|
|
4591
4683
|
*/
|
|
4592
|
-
|
|
4684
|
+
year?: number;
|
|
4593
4685
|
/**
|
|
4594
|
-
*
|
|
4595
|
-
*
|
|
4686
|
+
* Quarter
|
|
4687
|
+
* Specify the quarter for which the analysis is requested.
|
|
4596
4688
|
*/
|
|
4597
|
-
|
|
4689
|
+
quarter?: number;
|
|
4598
4690
|
/**
|
|
4599
|
-
*
|
|
4600
|
-
*
|
|
4601
|
-
* @default 10
|
|
4602
|
-
* @example 10
|
|
4691
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4692
|
+
* @default "en-US"
|
|
4603
4693
|
*/
|
|
4604
|
-
|
|
4694
|
+
language?: BridgeWiseLanguageEnum;
|
|
4605
4695
|
/**
|
|
4606
|
-
*
|
|
4607
|
-
*
|
|
4608
|
-
* @default 1
|
|
4609
|
-
* @example 1
|
|
4696
|
+
* Show All
|
|
4697
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4610
4698
|
*/
|
|
4611
|
-
|
|
4612
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4613
|
-
/**
|
|
4614
|
-
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
4615
|
-
* @tags Company News
|
|
4616
|
-
* @name GetAverageCompanyNewsSentiment
|
|
4617
|
-
* @summary Get Average Company News Sentiment
|
|
4618
|
-
* @request GET:/companies/{company_id}/news-sentiment
|
|
4619
|
-
* @secure
|
|
4620
|
-
*/
|
|
4621
|
-
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
4622
|
-
/**
|
|
4623
|
-
* Published Date Gte
|
|
4624
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
4625
|
-
* @format date
|
|
4626
|
-
* @default "2025-07-22"
|
|
4627
|
-
*/
|
|
4628
|
-
published_date__gte?: string;
|
|
4629
|
-
/**
|
|
4630
|
-
* Published Date Lte
|
|
4631
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
4632
|
-
* @format date
|
|
4633
|
-
* @default "2025-07-22"
|
|
4634
|
-
*/
|
|
4635
|
-
published_date__lte?: string;
|
|
4636
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4699
|
+
show_all?: boolean;
|
|
4700
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
4637
4701
|
}
|
|
4638
|
-
export class
|
|
4702
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
4639
4703
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4640
4704
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4641
4705
|
/**
|
|
4642
|
-
* @description
|
|
4643
|
-
* @tags
|
|
4644
|
-
* @name
|
|
4645
|
-
* @summary Get
|
|
4646
|
-
* @request GET:/
|
|
4647
|
-
* @secure
|
|
4648
|
-
*/
|
|
4649
|
-
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
4650
|
-
/**
|
|
4651
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4652
|
-
* @default "en-US"
|
|
4653
|
-
*/
|
|
4654
|
-
language?: BridgeWiseLanguageEnum;
|
|
4655
|
-
/**
|
|
4656
|
-
* Trading Item Id
|
|
4657
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4658
|
-
*/
|
|
4659
|
-
trading_item_id?: number;
|
|
4660
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
4661
|
-
/**
|
|
4662
|
-
* @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.
|
|
4663
|
-
* @tags Technical Analysis
|
|
4664
|
-
* @name GetCompanyTechnicalParagraphs
|
|
4665
|
-
* @summary Get Company Technical Paragraphs
|
|
4666
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
4706
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
4707
|
+
* @tags Fund ESG Analysis
|
|
4708
|
+
* @name GetFundEsgAnalysis
|
|
4709
|
+
* @summary Get Fund Esg Analysis
|
|
4710
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
4667
4711
|
* @secure
|
|
4668
4712
|
*/
|
|
4669
|
-
|
|
4670
|
-
/**
|
|
4671
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4672
|
-
* @default "en-US"
|
|
4673
|
-
*/
|
|
4674
|
-
language?: BridgeWiseLanguageEnum;
|
|
4713
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
4675
4714
|
/**
|
|
4676
|
-
*
|
|
4677
|
-
*
|
|
4715
|
+
* Limit
|
|
4716
|
+
* Number of historical periods to be returned (default is 1).
|
|
4678
4717
|
*/
|
|
4679
|
-
|
|
4680
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
4681
|
-
/**
|
|
4682
|
-
* @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.
|
|
4683
|
-
* @tags Technical Analysis
|
|
4684
|
-
* @name GetCompanyTechnicalParameters
|
|
4685
|
-
* @summary Get Company Technical Parameters
|
|
4686
|
-
* @request GET:/companies/{company_id}/technical-parameters
|
|
4687
|
-
* @secure
|
|
4688
|
-
*/
|
|
4689
|
-
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
4718
|
+
limit?: number;
|
|
4690
4719
|
/**
|
|
4691
4720
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4692
4721
|
* @default "en-US"
|
|
4693
4722
|
*/
|
|
4694
4723
|
language?: BridgeWiseLanguageEnum;
|
|
4695
|
-
|
|
4696
|
-
* Trading Item Id
|
|
4697
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4698
|
-
*/
|
|
4699
|
-
trading_item_id?: number;
|
|
4700
|
-
/**
|
|
4701
|
-
* Parameter Id
|
|
4702
|
-
* Get desired parameter by ID.
|
|
4703
|
-
*/
|
|
4704
|
-
parameter_id?: number;
|
|
4705
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
4724
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
4706
4725
|
}
|
|
4707
|
-
export class
|
|
4726
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
4708
4727
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4709
4728
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4710
4729
|
/**
|
|
4711
|
-
* @description
|
|
4712
|
-
* @tags
|
|
4713
|
-
* @name
|
|
4714
|
-
* @summary Get
|
|
4715
|
-
* @request GET:/
|
|
4730
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
4731
|
+
* @tags Fund Market Data
|
|
4732
|
+
* @name GetFundsMarketData
|
|
4733
|
+
* @summary Get Funds Market Data
|
|
4734
|
+
* @request GET:/funds/{fund_id}/market
|
|
4716
4735
|
* @secure
|
|
4717
4736
|
*/
|
|
4718
|
-
|
|
4719
|
-
/**
|
|
4720
|
-
* Sort By
|
|
4721
|
-
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4722
|
-
* @default "group,rank"
|
|
4723
|
-
*/
|
|
4724
|
-
sort_by?: string | null;
|
|
4737
|
+
getFundsMarketData(fundId: number, query?: {
|
|
4725
4738
|
/**
|
|
4726
|
-
*
|
|
4727
|
-
*
|
|
4739
|
+
* Trading Item Id
|
|
4740
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4728
4741
|
*/
|
|
4729
|
-
|
|
4730
|
-
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
4731
|
-
group?: BridgeWiseThemeGroupEnum;
|
|
4732
|
-
/** Filter basic and advanced theme packages. */
|
|
4733
|
-
package?: BridgeWiseThemePackageEnum;
|
|
4734
|
-
/** The type of the theme. */
|
|
4735
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
4742
|
+
trading_item_id?: number | null;
|
|
4736
4743
|
/**
|
|
4737
|
-
*
|
|
4738
|
-
*
|
|
4739
|
-
* @min 1
|
|
4740
|
-
* @default 1
|
|
4744
|
+
* Date Ge
|
|
4745
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4741
4746
|
*/
|
|
4742
|
-
|
|
4747
|
+
date__ge?: string | null;
|
|
4743
4748
|
/**
|
|
4744
|
-
*
|
|
4745
|
-
*
|
|
4746
|
-
* @min 1
|
|
4747
|
-
* @default 10
|
|
4749
|
+
* Date Le
|
|
4750
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4748
4751
|
*/
|
|
4749
|
-
|
|
4750
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4752
|
+
date__le?: string | null;
|
|
4753
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
4751
4754
|
/**
|
|
4752
|
-
* @description
|
|
4753
|
-
* @tags
|
|
4754
|
-
* @name
|
|
4755
|
-
* @summary Get
|
|
4756
|
-
* @request GET:/
|
|
4755
|
+
* @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
4756
|
+
* @tags Fund Market Data
|
|
4757
|
+
* @name GetFundsMarketStatistics
|
|
4758
|
+
* @summary Get Funds Market Statistics
|
|
4759
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
4757
4760
|
* @secure
|
|
4758
4761
|
*/
|
|
4759
|
-
|
|
4760
|
-
/**
|
|
4761
|
-
* Search
|
|
4762
|
-
* Search string to filter themes by name or description.
|
|
4763
|
-
*/
|
|
4764
|
-
search?: string | null;
|
|
4765
|
-
/**
|
|
4766
|
-
* Sort By
|
|
4767
|
-
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
4768
|
-
* @default "rank"
|
|
4769
|
-
*/
|
|
4770
|
-
sort_by?: string;
|
|
4771
|
-
/**
|
|
4772
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4773
|
-
* @default "en-US"
|
|
4774
|
-
*/
|
|
4775
|
-
language?: BridgeWiseThemeLanguageEnum;
|
|
4776
|
-
/** Filter basic and advanced theme packages. */
|
|
4777
|
-
package?: BridgeWiseThemePackageEnum;
|
|
4778
|
-
/** The type of the theme. */
|
|
4779
|
-
type?: BridgeWiseThemeTypeEnum;
|
|
4762
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
4780
4763
|
/**
|
|
4781
|
-
*
|
|
4782
|
-
*
|
|
4783
|
-
* @min 1
|
|
4784
|
-
* @default 1
|
|
4764
|
+
* Trading Item Id
|
|
4765
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4785
4766
|
*/
|
|
4786
|
-
|
|
4767
|
+
trading_item_id?: number | null;
|
|
4787
4768
|
/**
|
|
4788
|
-
*
|
|
4789
|
-
*
|
|
4790
|
-
* @min 1
|
|
4791
|
-
* @default 10
|
|
4769
|
+
* Identifier In
|
|
4770
|
+
* Specify a list of external identifiers.
|
|
4792
4771
|
*/
|
|
4793
|
-
|
|
4794
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4772
|
+
identifier__in?: string | null;
|
|
4773
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
4795
4774
|
/**
|
|
4796
|
-
* @description
|
|
4797
|
-
* @tags
|
|
4798
|
-
* @name
|
|
4799
|
-
* @summary Get
|
|
4800
|
-
* @request GET:/
|
|
4775
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
4776
|
+
* @tags Fund Market Data
|
|
4777
|
+
* @name GetFundTradingItems
|
|
4778
|
+
* @summary Get Fund Trading Items
|
|
4779
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
4801
4780
|
* @secure
|
|
4802
4781
|
*/
|
|
4803
|
-
|
|
4804
|
-
/**
|
|
4805
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4806
|
-
* @default "en-US"
|
|
4807
|
-
*/
|
|
4808
|
-
language?: BridgeWiseThemeLanguageEnum;
|
|
4782
|
+
getFundTradingItems(fundId: number, query?: {
|
|
4809
4783
|
/**
|
|
4810
|
-
*
|
|
4811
|
-
*
|
|
4812
|
-
* @default false
|
|
4784
|
+
* Primary Flag
|
|
4785
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4813
4786
|
*/
|
|
4814
|
-
|
|
4815
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
4816
|
-
/**
|
|
4817
|
-
* @tags Themes
|
|
4818
|
-
* @name GetThemeFilters
|
|
4819
|
-
* @summary Get Theme Filters
|
|
4820
|
-
* @request GET:/themes/{theme_id}/filters
|
|
4821
|
-
* @secure
|
|
4822
|
-
*/
|
|
4823
|
-
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4824
|
-
}
|
|
4825
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
4826
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4827
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4828
|
-
/**
|
|
4829
|
-
* @description This endpoint provides filters
|
|
4830
|
-
* @tags Metadata
|
|
4831
|
-
* @name GetCompanyFilters
|
|
4832
|
-
* @summary Get Company Filters
|
|
4833
|
-
* @request GET:/filters
|
|
4834
|
-
* @secure
|
|
4835
|
-
*/
|
|
4836
|
-
getCompanyFilters(query: {
|
|
4837
|
-
/** Desired filter type. */
|
|
4838
|
-
type: BridgeWiseCompanyFilterType;
|
|
4787
|
+
primary_flag?: boolean;
|
|
4839
4788
|
/**
|
|
4840
|
-
*
|
|
4841
|
-
*
|
|
4789
|
+
* Security Primary Flag
|
|
4790
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4842
4791
|
*/
|
|
4843
|
-
|
|
4844
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4792
|
+
security_primary_flag?: boolean;
|
|
4793
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
4845
4794
|
}
|
|
4846
4795
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4847
4796
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5229,116 +5178,7 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
5229
5178
|
language?: BridgeWiseLanguageEnum;
|
|
5230
5179
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
5231
5180
|
}
|
|
5232
|
-
export class
|
|
5233
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5234
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5235
|
-
/**
|
|
5236
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
5237
|
-
* @tags Fund Analysis
|
|
5238
|
-
* @name GetFundAnalysis
|
|
5239
|
-
* @summary Get Fund Analysis
|
|
5240
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
5241
|
-
* @secure
|
|
5242
|
-
*/
|
|
5243
|
-
getFundAnalysis(fundId: number, query?: {
|
|
5244
|
-
/**
|
|
5245
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5246
|
-
* @default "en-US"
|
|
5247
|
-
*/
|
|
5248
|
-
language?: BridgeWiseLanguageEnum;
|
|
5249
|
-
/**
|
|
5250
|
-
* Year
|
|
5251
|
-
* Specify the year for which the analysis is requested.
|
|
5252
|
-
*/
|
|
5253
|
-
year?: number;
|
|
5254
|
-
/**
|
|
5255
|
-
* Quarter
|
|
5256
|
-
* Specify the quarter for which the analysis is requested.
|
|
5257
|
-
*/
|
|
5258
|
-
quarter?: number;
|
|
5259
|
-
/**
|
|
5260
|
-
* Show All
|
|
5261
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5262
|
-
*/
|
|
5263
|
-
show_all?: boolean;
|
|
5264
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
5265
|
-
/**
|
|
5266
|
-
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
5267
|
-
* @tags Fund Analysis
|
|
5268
|
-
* @name GetFundsParagraphs
|
|
5269
|
-
* @summary Get Funds Paragraphs
|
|
5270
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
5271
|
-
* @secure
|
|
5272
|
-
*/
|
|
5273
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
5274
|
-
/**
|
|
5275
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5276
|
-
* @default "en-US"
|
|
5277
|
-
*/
|
|
5278
|
-
language?: BridgeWiseLanguageEnum;
|
|
5279
|
-
/**
|
|
5280
|
-
* Year
|
|
5281
|
-
* Specify the year for which the analysis is requested.
|
|
5282
|
-
*/
|
|
5283
|
-
year?: number | null;
|
|
5284
|
-
/**
|
|
5285
|
-
* Quarter
|
|
5286
|
-
* Specify the quarter for which the analysis is requested.
|
|
5287
|
-
*/
|
|
5288
|
-
quarter?: number | null;
|
|
5289
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
5290
|
-
/**
|
|
5291
|
-
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
5292
|
-
* @tags Fund Analysis
|
|
5293
|
-
* @name GetFundParameters
|
|
5294
|
-
* @summary Get Fund Parameters
|
|
5295
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
5296
|
-
* @secure
|
|
5297
|
-
*/
|
|
5298
|
-
getFundParameters(fundId: number, query?: {
|
|
5299
|
-
/**
|
|
5300
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5301
|
-
* @default "en-US"
|
|
5302
|
-
*/
|
|
5303
|
-
language?: BridgeWiseLanguageEnum;
|
|
5304
|
-
/**
|
|
5305
|
-
* Parameter Id
|
|
5306
|
-
* ID of the parameter for analysis.
|
|
5307
|
-
*/
|
|
5308
|
-
parameter_id?: number;
|
|
5309
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
5310
|
-
/**
|
|
5311
|
-
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
5312
|
-
* @tags Fund Analysis
|
|
5313
|
-
* @name GetFundSections
|
|
5314
|
-
* @summary Get Fund Sections
|
|
5315
|
-
* @request GET:/funds/{fund_id}/sections
|
|
5316
|
-
* @secure
|
|
5317
|
-
*/
|
|
5318
|
-
getFundSections(fundId: number, query?: {
|
|
5319
|
-
/**
|
|
5320
|
-
* Year
|
|
5321
|
-
* Specify the year for which the analysis is requested.
|
|
5322
|
-
*/
|
|
5323
|
-
year?: number;
|
|
5324
|
-
/**
|
|
5325
|
-
* Quarter
|
|
5326
|
-
* Specify the quarter for which the analysis is requested.
|
|
5327
|
-
*/
|
|
5328
|
-
quarter?: number;
|
|
5329
|
-
/**
|
|
5330
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5331
|
-
* @default "en-US"
|
|
5332
|
-
*/
|
|
5333
|
-
language?: BridgeWiseLanguageEnum;
|
|
5334
|
-
/**
|
|
5335
|
-
* Show All
|
|
5336
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
5337
|
-
*/
|
|
5338
|
-
show_all?: boolean;
|
|
5339
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
5340
|
-
}
|
|
5341
|
-
export class Holdings<HandleError extends boolean = boolean> {
|
|
5181
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5342
5182
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5343
5183
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5344
5184
|
/**
|
|
@@ -5423,6 +5263,72 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
5423
5263
|
page_size?: number;
|
|
5424
5264
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
5425
5265
|
}
|
|
5266
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5267
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5268
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5269
|
+
/**
|
|
5270
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
5271
|
+
* @tags Logos
|
|
5272
|
+
* @name FetchLogos
|
|
5273
|
+
* @summary Fetch Logos
|
|
5274
|
+
* @request GET:/companies/logos
|
|
5275
|
+
* @secure
|
|
5276
|
+
*/
|
|
5277
|
+
fetchLogos(query?: {
|
|
5278
|
+
/**
|
|
5279
|
+
* Company Id In
|
|
5280
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5281
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5282
|
+
* @example "74822,83343211"
|
|
5283
|
+
*/
|
|
5284
|
+
company_id__in?: string;
|
|
5285
|
+
/**
|
|
5286
|
+
* Size
|
|
5287
|
+
* Page size
|
|
5288
|
+
* @min 1
|
|
5289
|
+
* @max 100
|
|
5290
|
+
* @default 50
|
|
5291
|
+
*/
|
|
5292
|
+
size?: number;
|
|
5293
|
+
/**
|
|
5294
|
+
* Page
|
|
5295
|
+
* Page number
|
|
5296
|
+
* @min 1
|
|
5297
|
+
* @default 1
|
|
5298
|
+
*/
|
|
5299
|
+
page?: number;
|
|
5300
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
5301
|
+
/**
|
|
5302
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
5303
|
+
* @tags Logos
|
|
5304
|
+
* @name FetchLogo
|
|
5305
|
+
* @summary Fetch Logo
|
|
5306
|
+
* @request GET:/companies/{company_id}/logos
|
|
5307
|
+
* @secure
|
|
5308
|
+
*/
|
|
5309
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
5310
|
+
}
|
|
5311
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
5312
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5313
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5314
|
+
/**
|
|
5315
|
+
* @description This endpoint provides filters
|
|
5316
|
+
* @tags Metadata
|
|
5317
|
+
* @name GetCompanyFilters
|
|
5318
|
+
* @summary Get Company Filters
|
|
5319
|
+
* @request GET:/filters
|
|
5320
|
+
* @secure
|
|
5321
|
+
*/
|
|
5322
|
+
getCompanyFilters(query: {
|
|
5323
|
+
/** Desired filter type. */
|
|
5324
|
+
type: BridgeWiseCompanyFilterType;
|
|
5325
|
+
/**
|
|
5326
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5327
|
+
* @default "en-US"
|
|
5328
|
+
*/
|
|
5329
|
+
language?: BridgeWiseLanguageEnum;
|
|
5330
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
5331
|
+
}
|
|
5426
5332
|
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5427
5333
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5428
5334
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5508,74 +5414,74 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
5508
5414
|
segment?: string;
|
|
5509
5415
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5510
5416
|
}
|
|
5511
|
-
export class
|
|
5417
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
5512
5418
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5513
5419
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5514
5420
|
/**
|
|
5515
|
-
* @description
|
|
5516
|
-
* @tags
|
|
5517
|
-
* @name
|
|
5518
|
-
* @summary Get
|
|
5519
|
-
* @request GET:/
|
|
5421
|
+
* @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.
|
|
5422
|
+
* @tags Technical Analysis
|
|
5423
|
+
* @name GetCompanyTechnicalAnalysis
|
|
5424
|
+
* @summary Get Company Technical Analysis
|
|
5425
|
+
* @request GET:/companies/{company_id}/technical-analysis
|
|
5520
5426
|
* @secure
|
|
5521
5427
|
*/
|
|
5522
|
-
|
|
5523
|
-
/**
|
|
5524
|
-
* Trading Item Id
|
|
5525
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5526
|
-
*/
|
|
5527
|
-
trading_item_id?: number | null;
|
|
5428
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
5528
5429
|
/**
|
|
5529
|
-
*
|
|
5530
|
-
*
|
|
5430
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5431
|
+
* @default "en-US"
|
|
5531
5432
|
*/
|
|
5532
|
-
|
|
5433
|
+
language?: BridgeWiseLanguageEnum;
|
|
5533
5434
|
/**
|
|
5534
|
-
*
|
|
5535
|
-
* Specify
|
|
5435
|
+
* Trading Item Id
|
|
5436
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5536
5437
|
*/
|
|
5537
|
-
|
|
5538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5438
|
+
trading_item_id?: number;
|
|
5439
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
5539
5440
|
/**
|
|
5540
|
-
* @description
|
|
5541
|
-
* @tags
|
|
5542
|
-
* @name
|
|
5543
|
-
* @summary Get
|
|
5544
|
-
* @request GET:/
|
|
5441
|
+
* @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.
|
|
5442
|
+
* @tags Technical Analysis
|
|
5443
|
+
* @name GetCompanyTechnicalParagraphs
|
|
5444
|
+
* @summary Get Company Technical Paragraphs
|
|
5445
|
+
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
5545
5446
|
* @secure
|
|
5546
5447
|
*/
|
|
5547
|
-
|
|
5448
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
5548
5449
|
/**
|
|
5549
|
-
*
|
|
5550
|
-
*
|
|
5450
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5451
|
+
* @default "en-US"
|
|
5551
5452
|
*/
|
|
5552
|
-
|
|
5453
|
+
language?: BridgeWiseLanguageEnum;
|
|
5553
5454
|
/**
|
|
5554
|
-
*
|
|
5555
|
-
* Specify a
|
|
5455
|
+
* Trading Item Id
|
|
5456
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5556
5457
|
*/
|
|
5557
|
-
|
|
5558
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5458
|
+
trading_item_id?: number;
|
|
5459
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
5559
5460
|
/**
|
|
5560
|
-
* @description
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary Get
|
|
5564
|
-
* @request GET:/
|
|
5461
|
+
* @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.
|
|
5462
|
+
* @tags Technical Analysis
|
|
5463
|
+
* @name GetCompanyTechnicalParameters
|
|
5464
|
+
* @summary Get Company Technical Parameters
|
|
5465
|
+
* @request GET:/companies/{company_id}/technical-parameters
|
|
5565
5466
|
* @secure
|
|
5566
5467
|
*/
|
|
5567
|
-
|
|
5468
|
+
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
5568
5469
|
/**
|
|
5569
|
-
*
|
|
5570
|
-
*
|
|
5470
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5471
|
+
* @default "en-US"
|
|
5571
5472
|
*/
|
|
5572
|
-
|
|
5473
|
+
language?: BridgeWiseLanguageEnum;
|
|
5573
5474
|
/**
|
|
5574
|
-
*
|
|
5575
|
-
*
|
|
5475
|
+
* Trading Item Id
|
|
5476
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5576
5477
|
*/
|
|
5577
|
-
|
|
5578
|
-
|
|
5478
|
+
trading_item_id?: number;
|
|
5479
|
+
/**
|
|
5480
|
+
* Parameter Id
|
|
5481
|
+
* Get desired parameter by ID.
|
|
5482
|
+
*/
|
|
5483
|
+
parameter_id?: number;
|
|
5484
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
5579
5485
|
}
|
|
5580
5486
|
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5581
5487
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5634,53 +5540,6 @@ export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
|
5634
5540
|
*/
|
|
5635
5541
|
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5636
5542
|
}
|
|
5637
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
5638
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5639
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5640
|
-
/**
|
|
5641
|
-
* @tags Users
|
|
5642
|
-
* @name Authenticate
|
|
5643
|
-
* @summary Authenticate
|
|
5644
|
-
* @request POST:/users/authenticate
|
|
5645
|
-
* @secure
|
|
5646
|
-
*/
|
|
5647
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5648
|
-
/**
|
|
5649
|
-
* @tags Users
|
|
5650
|
-
* @name FetchClientDetails
|
|
5651
|
-
* @summary Fetch Client Details
|
|
5652
|
-
* @request GET:/users/machine
|
|
5653
|
-
* @secure
|
|
5654
|
-
*/
|
|
5655
|
-
fetchClientDetails(headers: {
|
|
5656
|
-
/** Authorization */
|
|
5657
|
-
authorization: string;
|
|
5658
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5659
|
-
}
|
|
5660
|
-
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5661
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5662
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5663
|
-
/**
|
|
5664
|
-
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5665
|
-
* @tags Fund ESG Analysis
|
|
5666
|
-
* @name GetFundEsgAnalysis
|
|
5667
|
-
* @summary Get Fund Esg Analysis
|
|
5668
|
-
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5669
|
-
* @secure
|
|
5670
|
-
*/
|
|
5671
|
-
getFundEsgAnalysis(fundId: number, query?: {
|
|
5672
|
-
/**
|
|
5673
|
-
* Limit
|
|
5674
|
-
* Number of historical periods to be returned (default is 1).
|
|
5675
|
-
*/
|
|
5676
|
-
limit?: number;
|
|
5677
|
-
/**
|
|
5678
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5679
|
-
* @default "en-US"
|
|
5680
|
-
*/
|
|
5681
|
-
language?: BridgeWiseLanguageEnum;
|
|
5682
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5683
|
-
}
|
|
5684
5543
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
5685
5544
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5686
5545
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5854,6 +5713,147 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
5854
5713
|
*/
|
|
5855
5714
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5856
5715
|
}
|
|
5716
|
+
export class Themes<HandleError extends boolean = boolean> {
|
|
5717
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5718
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5719
|
+
/**
|
|
5720
|
+
* @description Retrieve a list of themes and their details associated with the company.
|
|
5721
|
+
* @tags Themes
|
|
5722
|
+
* @name GetCompanyThemes
|
|
5723
|
+
* @summary Get Company Themes
|
|
5724
|
+
* @request GET:/companies/{company_id}/themes
|
|
5725
|
+
* @secure
|
|
5726
|
+
*/
|
|
5727
|
+
getCompanyThemes(companyId: number, query?: {
|
|
5728
|
+
/**
|
|
5729
|
+
* Sort By
|
|
5730
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5731
|
+
* @default "group,rank"
|
|
5732
|
+
*/
|
|
5733
|
+
sort_by?: string | null;
|
|
5734
|
+
/**
|
|
5735
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5736
|
+
* @default "en-US"
|
|
5737
|
+
*/
|
|
5738
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
5739
|
+
/** Filter themes by group. Allowed values: 1, 2, 3. */
|
|
5740
|
+
group?: BridgeWiseThemeGroupEnum;
|
|
5741
|
+
/** Filter basic and advanced theme packages. */
|
|
5742
|
+
package?: BridgeWiseThemePackageEnum;
|
|
5743
|
+
/** The type of the theme. */
|
|
5744
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
5745
|
+
/**
|
|
5746
|
+
* Page
|
|
5747
|
+
* Define the page number for pagination.
|
|
5748
|
+
* @min 1
|
|
5749
|
+
* @default 1
|
|
5750
|
+
*/
|
|
5751
|
+
page?: number;
|
|
5752
|
+
/**
|
|
5753
|
+
* Page Size
|
|
5754
|
+
* Define the number of records per page for pagination purposes.
|
|
5755
|
+
* @min 1
|
|
5756
|
+
* @default 10
|
|
5757
|
+
*/
|
|
5758
|
+
page_size?: number;
|
|
5759
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyThemeListResponse, HandleError>>;
|
|
5760
|
+
/**
|
|
5761
|
+
* @description Retrieve a list of themes with their details. Filter by theme_id or search term, and order by any theme field. If no filter is provided, all themes are returned.
|
|
5762
|
+
* @tags Themes
|
|
5763
|
+
* @name GetThemes
|
|
5764
|
+
* @summary Get Themes
|
|
5765
|
+
* @request GET:/themes
|
|
5766
|
+
* @secure
|
|
5767
|
+
*/
|
|
5768
|
+
getThemes(query?: {
|
|
5769
|
+
/**
|
|
5770
|
+
* Search
|
|
5771
|
+
* Search string to filter themes by name or description.
|
|
5772
|
+
*/
|
|
5773
|
+
search?: string | null;
|
|
5774
|
+
/**
|
|
5775
|
+
* Sort By
|
|
5776
|
+
* Field to order themes with optional ascending or descending (-) indicators, <br>Example: -rank,companies_count</br>
|
|
5777
|
+
* @default "rank"
|
|
5778
|
+
*/
|
|
5779
|
+
sort_by?: string;
|
|
5780
|
+
/**
|
|
5781
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5782
|
+
* @default "en-US"
|
|
5783
|
+
*/
|
|
5784
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
5785
|
+
/** Filter basic and advanced theme packages. */
|
|
5786
|
+
package?: BridgeWiseThemePackageEnum;
|
|
5787
|
+
/** The type of the theme. */
|
|
5788
|
+
type?: BridgeWiseThemeTypeEnum;
|
|
5789
|
+
/**
|
|
5790
|
+
* Page
|
|
5791
|
+
* Define the page number for pagination.
|
|
5792
|
+
* @min 1
|
|
5793
|
+
* @default 1
|
|
5794
|
+
*/
|
|
5795
|
+
page?: number;
|
|
5796
|
+
/**
|
|
5797
|
+
* Page Size
|
|
5798
|
+
* Define the number of records per page for pagination purposes.
|
|
5799
|
+
* @min 1
|
|
5800
|
+
* @default 10
|
|
5801
|
+
*/
|
|
5802
|
+
page_size?: number;
|
|
5803
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListResponse, HandleError>>;
|
|
5804
|
+
/**
|
|
5805
|
+
* @description Retrieve a specific theme by its ID.
|
|
5806
|
+
* @tags Themes
|
|
5807
|
+
* @name GetTheme
|
|
5808
|
+
* @summary Get Theme
|
|
5809
|
+
* @request GET:/themes/{theme_id}
|
|
5810
|
+
* @secure
|
|
5811
|
+
*/
|
|
5812
|
+
getTheme(themeId: number, query?: {
|
|
5813
|
+
/**
|
|
5814
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5815
|
+
* @default "en-US"
|
|
5816
|
+
*/
|
|
5817
|
+
language?: BridgeWiseThemeLanguageEnum;
|
|
5818
|
+
/**
|
|
5819
|
+
* Include Filter
|
|
5820
|
+
* Include theme filters.
|
|
5821
|
+
* @default false
|
|
5822
|
+
*/
|
|
5823
|
+
include_filter?: boolean;
|
|
5824
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeResponse, HandleError>>;
|
|
5825
|
+
/**
|
|
5826
|
+
* @tags Themes
|
|
5827
|
+
* @name GetThemeFilters
|
|
5828
|
+
* @summary Get Theme Filters
|
|
5829
|
+
* @request GET:/themes/{theme_id}/filters
|
|
5830
|
+
* @secure
|
|
5831
|
+
*/
|
|
5832
|
+
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
5833
|
+
}
|
|
5834
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5835
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5836
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5837
|
+
/**
|
|
5838
|
+
* @tags Users
|
|
5839
|
+
* @name Authenticate
|
|
5840
|
+
* @summary Authenticate
|
|
5841
|
+
* @request POST:/users/authenticate
|
|
5842
|
+
* @secure
|
|
5843
|
+
*/
|
|
5844
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5845
|
+
/**
|
|
5846
|
+
* @tags Users
|
|
5847
|
+
* @name FetchClientDetails
|
|
5848
|
+
* @summary Fetch Client Details
|
|
5849
|
+
* @request GET:/users/machine
|
|
5850
|
+
* @secure
|
|
5851
|
+
*/
|
|
5852
|
+
fetchClientDetails(headers: {
|
|
5853
|
+
/** Authorization */
|
|
5854
|
+
authorization: string;
|
|
5855
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5856
|
+
}
|
|
5857
5857
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
5858
5858
|
readonly config: JwtClientConfig<HandleError>;
|
|
5859
5859
|
activities: Activities<HandleError>;
|