@orbis-systems/orbis-api-clients 0.7.11 → 0.7.12
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 +103 -103
- 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 +497 -497
- 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 +659 -484
- 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 +30 -30
- 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 +1344 -1344
- 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 +288 -288
- 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 +406 -406
- 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,48 @@ export enum BridgeWiseGetTechnicalAnalysisParamsDateFormatEnum {
|
|
|
3031
3031
|
Iso = "iso",
|
|
3032
3032
|
Epoch = "epoch"
|
|
3033
3033
|
}
|
|
3034
|
+
export class Bridget<HandleError extends boolean = boolean> {
|
|
3035
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3037
|
+
/**
|
|
3038
|
+
* @tags Bridget
|
|
3039
|
+
* @name QuestionCreate
|
|
3040
|
+
* @request POST:/bridget/question
|
|
3041
|
+
* @secure
|
|
3042
|
+
*/
|
|
3043
|
+
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3044
|
+
/**
|
|
3045
|
+
* @tags Bridget
|
|
3046
|
+
* @name TenantsExportRetrieve
|
|
3047
|
+
* @request GET:/bridget/tenants/{tenant_id}/export
|
|
3048
|
+
* @secure
|
|
3049
|
+
*/
|
|
3050
|
+
tenantsExportRetrieve(tenantId: string, query?: {
|
|
3051
|
+
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3052
|
+
client_id?: string;
|
|
3053
|
+
/**
|
|
3054
|
+
* 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.
|
|
3055
|
+
* @format date
|
|
3056
|
+
*/
|
|
3057
|
+
date?: string;
|
|
3058
|
+
/**
|
|
3059
|
+
* 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.
|
|
3060
|
+
* @format date
|
|
3061
|
+
*/
|
|
3062
|
+
end_date?: string;
|
|
3063
|
+
/** Filters by user feedback on each answer. Allowed values: like | dislike */
|
|
3064
|
+
feedback_type?: string;
|
|
3065
|
+
/** Filters to a single chat session ID. */
|
|
3066
|
+
session_id?: string;
|
|
3067
|
+
/**
|
|
3068
|
+
* 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.
|
|
3069
|
+
* @format date
|
|
3070
|
+
*/
|
|
3071
|
+
start_date?: string;
|
|
3072
|
+
/** Filters logs to a single end-user within the tenant. */
|
|
3073
|
+
user_id?: string;
|
|
3074
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3075
|
+
}
|
|
3034
3076
|
export class Bwc<HandleError extends boolean = boolean> {
|
|
3035
3077
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
3078
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3358,48 +3400,6 @@ export class Bwc<HandleError extends boolean = boolean> {
|
|
|
3358
3400
|
identifier: string;
|
|
3359
3401
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseVerifyCompanyResultV2, HandleError>>;
|
|
3360
3402
|
}
|
|
3361
|
-
export class Bridget<HandleError extends boolean = boolean> {
|
|
3362
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3363
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3364
|
-
/**
|
|
3365
|
-
* @tags Bridget
|
|
3366
|
-
* @name QuestionCreate
|
|
3367
|
-
* @request POST:/bridget/question
|
|
3368
|
-
* @secure
|
|
3369
|
-
*/
|
|
3370
|
-
questionCreate(data: BridgeWiseExternalQuestionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExternalQuestionResponse, HandleError>>;
|
|
3371
|
-
/**
|
|
3372
|
-
* @tags Bridget
|
|
3373
|
-
* @name TenantsExportRetrieve
|
|
3374
|
-
* @request GET:/bridget/tenants/{tenant_id}/export
|
|
3375
|
-
* @secure
|
|
3376
|
-
*/
|
|
3377
|
-
tenantsExportRetrieve(tenantId: string, query?: {
|
|
3378
|
-
/** Filters logs to those generated by a specific client application or integration (e.g., “web-app”, “mobile-sdk”). */
|
|
3379
|
-
client_id?: string;
|
|
3380
|
-
/**
|
|
3381
|
-
* 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.
|
|
3382
|
-
* @format date
|
|
3383
|
-
*/
|
|
3384
|
-
date?: string;
|
|
3385
|
-
/**
|
|
3386
|
-
* 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.
|
|
3387
|
-
* @format date
|
|
3388
|
-
*/
|
|
3389
|
-
end_date?: string;
|
|
3390
|
-
/** Filters by user feedback on each answer. Allowed values: like | dislike */
|
|
3391
|
-
feedback_type?: string;
|
|
3392
|
-
/** Filters to a single chat session ID. */
|
|
3393
|
-
session_id?: string;
|
|
3394
|
-
/**
|
|
3395
|
-
* 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.
|
|
3396
|
-
* @format date
|
|
3397
|
-
*/
|
|
3398
|
-
start_date?: string;
|
|
3399
|
-
/** Filters logs to a single end-user within the tenant. */
|
|
3400
|
-
user_id?: string;
|
|
3401
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseExportResponse, HandleError>>;
|
|
3402
|
-
}
|
|
3403
3403
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
3404
3404
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3405
3405
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4039,6 +4039,51 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
4039
4039
|
identifier_type: string;
|
|
4040
4040
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4041
4041
|
}
|
|
4042
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
4043
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4044
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4045
|
+
/**
|
|
4046
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
4047
|
+
* @tags Logos
|
|
4048
|
+
* @name FetchLogos
|
|
4049
|
+
* @summary Fetch Logos
|
|
4050
|
+
* @request GET:/companies/logos
|
|
4051
|
+
* @secure
|
|
4052
|
+
*/
|
|
4053
|
+
fetchLogos(query?: {
|
|
4054
|
+
/**
|
|
4055
|
+
* Company Id In
|
|
4056
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
4057
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
4058
|
+
* @example "74822,83343211"
|
|
4059
|
+
*/
|
|
4060
|
+
company_id__in?: string;
|
|
4061
|
+
/**
|
|
4062
|
+
* Size
|
|
4063
|
+
* Page size
|
|
4064
|
+
* @min 1
|
|
4065
|
+
* @max 100
|
|
4066
|
+
* @default 50
|
|
4067
|
+
*/
|
|
4068
|
+
size?: number;
|
|
4069
|
+
/**
|
|
4070
|
+
* Page
|
|
4071
|
+
* Page number
|
|
4072
|
+
* @min 1
|
|
4073
|
+
* @default 1
|
|
4074
|
+
*/
|
|
4075
|
+
page?: number;
|
|
4076
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4077
|
+
/**
|
|
4078
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
4079
|
+
* @tags Logos
|
|
4080
|
+
* @name FetchLogo
|
|
4081
|
+
* @summary Fetch Logo
|
|
4082
|
+
* @request GET:/companies/{company_id}/logos
|
|
4083
|
+
* @secure
|
|
4084
|
+
*/
|
|
4085
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
4086
|
+
}
|
|
4042
4087
|
export class Activities<HandleError extends boolean = boolean> {
|
|
4043
4088
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4044
4089
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4164,51 +4209,6 @@ export class EarningCalls<HandleError extends boolean = boolean> {
|
|
|
4164
4209
|
type?: BridgeWiseEarningsCallRecapEnum;
|
|
4165
4210
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseRecapsResponse[], HandleError>>;
|
|
4166
4211
|
}
|
|
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
4212
|
export class EsgAnalysis<HandleError extends boolean = boolean> {
|
|
4213
4213
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4214
4214
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4347,6 +4347,75 @@ export class Forecasts<HandleError extends boolean = boolean> {
|
|
|
4347
4347
|
page_size?: number;
|
|
4348
4348
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecastList | BridgeWiseEmptyModelList | BridgeWiseESGForcastV2[], HandleError>>;
|
|
4349
4349
|
}
|
|
4350
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
4351
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4352
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4353
|
+
/**
|
|
4354
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
4355
|
+
* @tags Company Market Data
|
|
4356
|
+
* @name GetCompanyMarketData
|
|
4357
|
+
* @summary Get Company Market Data
|
|
4358
|
+
* @request GET:/companies/{company_id}/market
|
|
4359
|
+
* @secure
|
|
4360
|
+
*/
|
|
4361
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
4362
|
+
/**
|
|
4363
|
+
* Trading Item Id
|
|
4364
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4365
|
+
*/
|
|
4366
|
+
trading_item_id?: number | null;
|
|
4367
|
+
/**
|
|
4368
|
+
* Date Ge
|
|
4369
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4370
|
+
*/
|
|
4371
|
+
date__ge?: string | null;
|
|
4372
|
+
/**
|
|
4373
|
+
* Date Le
|
|
4374
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4375
|
+
*/
|
|
4376
|
+
date__le?: string | null;
|
|
4377
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
4378
|
+
/**
|
|
4379
|
+
* @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.
|
|
4380
|
+
* @tags Company Market Data
|
|
4381
|
+
* @name GetCompanyMarketStatistics
|
|
4382
|
+
* @summary Get Company Market Statistics
|
|
4383
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
4384
|
+
* @secure
|
|
4385
|
+
*/
|
|
4386
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
4387
|
+
/**
|
|
4388
|
+
* Trading Item Id
|
|
4389
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4390
|
+
*/
|
|
4391
|
+
trading_item_id?: number | null;
|
|
4392
|
+
/**
|
|
4393
|
+
* Identifier In
|
|
4394
|
+
* Specify a list of external identifiers.
|
|
4395
|
+
*/
|
|
4396
|
+
identifier__in?: string | null;
|
|
4397
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4398
|
+
/**
|
|
4399
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4400
|
+
* @tags Company Market Data
|
|
4401
|
+
* @name GetTradingItems
|
|
4402
|
+
* @summary Get Trading Items
|
|
4403
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
4404
|
+
* @secure
|
|
4405
|
+
*/
|
|
4406
|
+
getTradingItems(companyId: number, query?: {
|
|
4407
|
+
/**
|
|
4408
|
+
* Primary Flag
|
|
4409
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4410
|
+
*/
|
|
4411
|
+
primary_flag?: boolean;
|
|
4412
|
+
/**
|
|
4413
|
+
* Security Primary Flag
|
|
4414
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4415
|
+
*/
|
|
4416
|
+
security_primary_flag?: boolean;
|
|
4417
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4418
|
+
}
|
|
4350
4419
|
export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
4351
4420
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4352
4421
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4488,84 +4557,15 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
4488
4557
|
date__lte?: string;
|
|
4489
4558
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
4490
4559
|
}
|
|
4491
|
-
export class
|
|
4560
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4492
4561
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4493
4562
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4494
4563
|
/**
|
|
4495
|
-
* @description
|
|
4496
|
-
* @tags Company
|
|
4497
|
-
* @name
|
|
4498
|
-
* @summary Get Company
|
|
4499
|
-
* @request GET:/companies/{company_id}/
|
|
4500
|
-
* @secure
|
|
4501
|
-
*/
|
|
4502
|
-
getCompanyMarketData(companyId: number, query?: {
|
|
4503
|
-
/**
|
|
4504
|
-
* Trading Item Id
|
|
4505
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4506
|
-
*/
|
|
4507
|
-
trading_item_id?: number | null;
|
|
4508
|
-
/**
|
|
4509
|
-
* Date Ge
|
|
4510
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4511
|
-
*/
|
|
4512
|
-
date__ge?: string | null;
|
|
4513
|
-
/**
|
|
4514
|
-
* Date Le
|
|
4515
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4516
|
-
*/
|
|
4517
|
-
date__le?: string | null;
|
|
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?: {
|
|
4528
|
-
/**
|
|
4529
|
-
* Trading Item Id
|
|
4530
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
4531
|
-
*/
|
|
4532
|
-
trading_item_id?: number | null;
|
|
4533
|
-
/**
|
|
4534
|
-
* Identifier In
|
|
4535
|
-
* Specify a list of external identifiers.
|
|
4536
|
-
*/
|
|
4537
|
-
identifier__in?: string | null;
|
|
4538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
4539
|
-
/**
|
|
4540
|
-
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
4541
|
-
* @tags Company Market Data
|
|
4542
|
-
* @name GetTradingItems
|
|
4543
|
-
* @summary Get Trading Items
|
|
4544
|
-
* @request GET:/companies/{company_id}/trading-items
|
|
4545
|
-
* @secure
|
|
4546
|
-
*/
|
|
4547
|
-
getTradingItems(companyId: number, query?: {
|
|
4548
|
-
/**
|
|
4549
|
-
* Primary Flag
|
|
4550
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
4551
|
-
*/
|
|
4552
|
-
primary_flag?: boolean;
|
|
4553
|
-
/**
|
|
4554
|
-
* Security Primary Flag
|
|
4555
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
4556
|
-
*/
|
|
4557
|
-
security_primary_flag?: boolean;
|
|
4558
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
4559
|
-
}
|
|
4560
|
-
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
4561
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4562
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4563
|
-
/**
|
|
4564
|
-
* @description This endpoint provides news articles related to the specified company.
|
|
4565
|
-
* @tags Company News
|
|
4566
|
-
* @name GetCompanyNews
|
|
4567
|
-
* @summary Get Company News
|
|
4568
|
-
* @request GET:/companies/{company_id}/news
|
|
4564
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
4565
|
+
* @tags Company News
|
|
4566
|
+
* @name GetCompanyNews
|
|
4567
|
+
* @summary Get Company News
|
|
4568
|
+
* @request GET:/companies/{company_id}/news
|
|
4569
4569
|
* @secure
|
|
4570
4570
|
*/
|
|
4571
4571
|
getCompanyNews(companyId: number, query?: {
|
|
@@ -4635,6 +4635,27 @@ export class CompanyNews<HandleError extends boolean = boolean> {
|
|
|
4635
4635
|
published_date__lte?: string;
|
|
4636
4636
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
4637
4637
|
}
|
|
4638
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
4639
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4640
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4641
|
+
/**
|
|
4642
|
+
* @description This endpoint provides filters
|
|
4643
|
+
* @tags Metadata
|
|
4644
|
+
* @name GetCompanyFilters
|
|
4645
|
+
* @summary Get Company Filters
|
|
4646
|
+
* @request GET:/filters
|
|
4647
|
+
* @secure
|
|
4648
|
+
*/
|
|
4649
|
+
getCompanyFilters(query: {
|
|
4650
|
+
/** Desired filter type. */
|
|
4651
|
+
type: BridgeWiseCompanyFilterType;
|
|
4652
|
+
/**
|
|
4653
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4654
|
+
* @default "en-US"
|
|
4655
|
+
*/
|
|
4656
|
+
language?: BridgeWiseLanguageEnum;
|
|
4657
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
4658
|
+
}
|
|
4638
4659
|
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4639
4660
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4640
4661
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4822,27 +4843,6 @@ export class Themes<HandleError extends boolean = boolean> {
|
|
|
4822
4843
|
*/
|
|
4823
4844
|
getThemeFilters(themeId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseThemeListFilter, HandleError>>;
|
|
4824
4845
|
}
|
|
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;
|
|
4839
|
-
/**
|
|
4840
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4841
|
-
* @default "en-US"
|
|
4842
|
-
*/
|
|
4843
|
-
language?: BridgeWiseLanguageEnum;
|
|
4844
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
4845
|
-
}
|
|
4846
4846
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
4847
4847
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4848
4848
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5338,90 +5338,56 @@ export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
|
5338
5338
|
show_all?: boolean;
|
|
5339
5339
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
5340
5340
|
}
|
|
5341
|
-
export class
|
|
5341
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
5342
5342
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5343
5343
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5344
5344
|
/**
|
|
5345
|
-
* @description
|
|
5346
|
-
* @tags
|
|
5347
|
-
* @name
|
|
5348
|
-
* @summary Get
|
|
5349
|
-
* @request GET:/funds/{fund_id}/
|
|
5350
|
-
* @secure
|
|
5351
|
-
*/
|
|
5352
|
-
getCompositions(fundId: number, query?: {
|
|
5353
|
-
/**
|
|
5354
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5355
|
-
* @default "en-US"
|
|
5356
|
-
*/
|
|
5357
|
-
language?: BridgeWiseLanguageEnum;
|
|
5358
|
-
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5359
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5360
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5361
|
-
/**
|
|
5362
|
-
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5363
|
-
* @tags Holdings
|
|
5364
|
-
* @name GetHoldingStatistics
|
|
5365
|
-
* @summary Get Holding Statistics
|
|
5366
|
-
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5345
|
+
* @description Provides key financial metrics for each segment within the specified fund, such as weighted averages of P/E ratio, P/B ratio, P/S ratio, Net Debt to EBITDA, Revenue Growth Rate, and Relative Market Value. It also includes the Weighted Average Segment Strength based on Bridgewise scores.
|
|
5346
|
+
* @tags Segmentations
|
|
5347
|
+
* @name GetSegmentParameters
|
|
5348
|
+
* @summary Get Segment Parameters
|
|
5349
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5367
5350
|
* @secure
|
|
5368
5351
|
*/
|
|
5369
|
-
|
|
5352
|
+
getSegmentParameters(fundId: number, query?: {
|
|
5370
5353
|
/**
|
|
5371
5354
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5372
5355
|
* @default "en-US"
|
|
5373
5356
|
*/
|
|
5374
5357
|
language?: BridgeWiseLanguageEnum;
|
|
5375
5358
|
/**
|
|
5376
|
-
*
|
|
5377
|
-
*
|
|
5378
|
-
*/
|
|
5379
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5380
|
-
/**
|
|
5381
|
-
* Page
|
|
5382
|
-
* Define the page number for pagination.
|
|
5383
|
-
* @exclusiveMin 0
|
|
5359
|
+
* Segment
|
|
5360
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5384
5361
|
*/
|
|
5385
|
-
|
|
5362
|
+
segment?: string;
|
|
5386
5363
|
/**
|
|
5387
|
-
*
|
|
5388
|
-
*
|
|
5389
|
-
* @exclusiveMin 0
|
|
5364
|
+
* Segment Type
|
|
5365
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
5390
5366
|
*/
|
|
5391
|
-
|
|
5392
|
-
|
|
5367
|
+
segment_type?: string;
|
|
5368
|
+
/** Desired segment parameter type. */
|
|
5369
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5370
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5393
5371
|
/**
|
|
5394
|
-
* @description
|
|
5395
|
-
* @tags
|
|
5396
|
-
* @name
|
|
5397
|
-
* @summary Get
|
|
5398
|
-
* @request GET:/funds/{fund_id}/
|
|
5372
|
+
* @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
|
|
5373
|
+
* @tags Segmentations
|
|
5374
|
+
* @name GetSegment
|
|
5375
|
+
* @summary Get Segment
|
|
5376
|
+
* @request GET:/funds/{fund_id}/segments
|
|
5399
5377
|
* @secure
|
|
5400
5378
|
*/
|
|
5401
|
-
|
|
5379
|
+
getSegment(fundId: number, query?: {
|
|
5402
5380
|
/**
|
|
5403
5381
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5404
5382
|
* @default "en-US"
|
|
5405
5383
|
*/
|
|
5406
5384
|
language?: BridgeWiseLanguageEnum;
|
|
5407
5385
|
/**
|
|
5408
|
-
*
|
|
5409
|
-
*
|
|
5410
|
-
*/
|
|
5411
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5412
|
-
/**
|
|
5413
|
-
* Page
|
|
5414
|
-
* Define the page number for pagination.
|
|
5415
|
-
* @exclusiveMin 0
|
|
5416
|
-
*/
|
|
5417
|
-
page?: number;
|
|
5418
|
-
/**
|
|
5419
|
-
* Page Size
|
|
5420
|
-
* Define the number of records per page for pagination purposes.
|
|
5421
|
-
* @exclusiveMin 0
|
|
5386
|
+
* Segment
|
|
5387
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5422
5388
|
*/
|
|
5423
|
-
|
|
5424
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5389
|
+
segment?: string;
|
|
5390
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5425
5391
|
}
|
|
5426
5392
|
export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
5427
5393
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5457,271 +5423,47 @@ export class SectorAnalysis<HandleError extends boolean = boolean> {
|
|
|
5457
5423
|
limit?: number;
|
|
5458
5424
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseSectorStrengthRoot, HandleError>>;
|
|
5459
5425
|
}
|
|
5460
|
-
export class
|
|
5426
|
+
export class Tenants<HandleError extends boolean = boolean> {
|
|
5461
5427
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5462
5428
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5463
5429
|
/**
|
|
5464
|
-
* @
|
|
5465
|
-
* @
|
|
5466
|
-
* @
|
|
5467
|
-
* @
|
|
5468
|
-
* @request GET:/funds/{fund_id}/segment-parameters
|
|
5430
|
+
* @tags Tenants
|
|
5431
|
+
* @name FetchTenant
|
|
5432
|
+
* @summary Fetch Tenant
|
|
5433
|
+
* @request GET:/tenants/{tenant_id}
|
|
5469
5434
|
* @secure
|
|
5470
5435
|
*/
|
|
5471
|
-
|
|
5436
|
+
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
5437
|
+
/**
|
|
5438
|
+
* @tags Tenants
|
|
5439
|
+
* @name GetHistoricalPolicyChanges
|
|
5440
|
+
* @summary Get Historical Policy Changes
|
|
5441
|
+
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
5442
|
+
* @secure
|
|
5443
|
+
*/
|
|
5444
|
+
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
5472
5445
|
/**
|
|
5473
|
-
*
|
|
5474
|
-
*
|
|
5446
|
+
* Company Ids
|
|
5447
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
5448
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5449
|
+
* @example "74822,83343211"
|
|
5475
5450
|
*/
|
|
5476
|
-
|
|
5451
|
+
company_ids?: string;
|
|
5477
5452
|
/**
|
|
5478
|
-
*
|
|
5479
|
-
*
|
|
5453
|
+
* Start Date Gte
|
|
5454
|
+
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5455
|
+
* @format date
|
|
5480
5456
|
*/
|
|
5481
|
-
|
|
5457
|
+
start_date__gte?: string;
|
|
5482
5458
|
/**
|
|
5483
|
-
*
|
|
5484
|
-
*
|
|
5459
|
+
* End Date Lte
|
|
5460
|
+
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5461
|
+
* @format date
|
|
5485
5462
|
*/
|
|
5486
|
-
|
|
5487
|
-
/** Desired segment parameter type. */
|
|
5488
|
-
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
5489
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
5490
|
-
/**
|
|
5491
|
-
* @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
|
|
5492
|
-
* @tags Segmentations
|
|
5493
|
-
* @name GetSegment
|
|
5494
|
-
* @summary Get Segment
|
|
5495
|
-
* @request GET:/funds/{fund_id}/segments
|
|
5496
|
-
* @secure
|
|
5497
|
-
*/
|
|
5498
|
-
getSegment(fundId: number, query?: {
|
|
5463
|
+
end_date__lte?: string;
|
|
5499
5464
|
/**
|
|
5500
|
-
*
|
|
5501
|
-
*
|
|
5502
|
-
*/
|
|
5503
|
-
language?: BridgeWiseLanguageEnum;
|
|
5504
|
-
/**
|
|
5505
|
-
* Segment
|
|
5506
|
-
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
5507
|
-
*/
|
|
5508
|
-
segment?: string;
|
|
5509
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
5510
|
-
}
|
|
5511
|
-
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5512
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5513
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5514
|
-
/**
|
|
5515
|
-
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5516
|
-
* @tags Fund Market Data
|
|
5517
|
-
* @name GetFundsMarketData
|
|
5518
|
-
* @summary Get Funds Market Data
|
|
5519
|
-
* @request GET:/funds/{fund_id}/market
|
|
5520
|
-
* @secure
|
|
5521
|
-
*/
|
|
5522
|
-
getFundsMarketData(fundId: number, query?: {
|
|
5523
|
-
/**
|
|
5524
|
-
* Trading Item Id
|
|
5525
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5526
|
-
*/
|
|
5527
|
-
trading_item_id?: number | null;
|
|
5528
|
-
/**
|
|
5529
|
-
* Date Ge
|
|
5530
|
-
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5531
|
-
*/
|
|
5532
|
-
date__ge?: string | null;
|
|
5533
|
-
/**
|
|
5534
|
-
* Date Le
|
|
5535
|
-
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5536
|
-
*/
|
|
5537
|
-
date__le?: string | null;
|
|
5538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5539
|
-
/**
|
|
5540
|
-
* @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.
|
|
5541
|
-
* @tags Fund Market Data
|
|
5542
|
-
* @name GetFundsMarketStatistics
|
|
5543
|
-
* @summary Get Funds Market Statistics
|
|
5544
|
-
* @request GET:/funds/{fund_id}/market-statistics
|
|
5545
|
-
* @secure
|
|
5546
|
-
*/
|
|
5547
|
-
getFundsMarketStatistics(fundId: number, query?: {
|
|
5548
|
-
/**
|
|
5549
|
-
* Trading Item Id
|
|
5550
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
5551
|
-
*/
|
|
5552
|
-
trading_item_id?: number | null;
|
|
5553
|
-
/**
|
|
5554
|
-
* Identifier In
|
|
5555
|
-
* Specify a list of external identifiers.
|
|
5556
|
-
*/
|
|
5557
|
-
identifier__in?: string | null;
|
|
5558
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5559
|
-
/**
|
|
5560
|
-
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5561
|
-
* @tags Fund Market Data
|
|
5562
|
-
* @name GetFundTradingItems
|
|
5563
|
-
* @summary Get Fund Trading Items
|
|
5564
|
-
* @request GET:/funds/{fund_id}/trading-items
|
|
5565
|
-
* @secure
|
|
5566
|
-
*/
|
|
5567
|
-
getFundTradingItems(fundId: number, query?: {
|
|
5568
|
-
/**
|
|
5569
|
-
* Primary Flag
|
|
5570
|
-
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5571
|
-
*/
|
|
5572
|
-
primary_flag?: boolean;
|
|
5573
|
-
/**
|
|
5574
|
-
* Security Primary Flag
|
|
5575
|
-
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
5576
|
-
*/
|
|
5577
|
-
security_primary_flag?: boolean;
|
|
5578
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5579
|
-
}
|
|
5580
|
-
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5581
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5582
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5583
|
-
/**
|
|
5584
|
-
* @description Get list of tenant identifiers
|
|
5585
|
-
* @tags Tenant Identifiers
|
|
5586
|
-
* @name GetTenantIdentifiers
|
|
5587
|
-
* @summary Get Tenant Identifiers
|
|
5588
|
-
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5589
|
-
* @secure
|
|
5590
|
-
*/
|
|
5591
|
-
getTenantIdentifiers(tenantId: string, query?: {
|
|
5592
|
-
/** Tenant custom identifier status. */
|
|
5593
|
-
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5594
|
-
/**
|
|
5595
|
-
* Page
|
|
5596
|
-
* Define the page number for the results.
|
|
5597
|
-
* @default 1
|
|
5598
|
-
* @example 1
|
|
5599
|
-
*/
|
|
5600
|
-
page?: number;
|
|
5601
|
-
/**
|
|
5602
|
-
* Page Size
|
|
5603
|
-
* Define the maximum number of results to retrieve.
|
|
5604
|
-
* @default 20
|
|
5605
|
-
* @example 10
|
|
5606
|
-
*/
|
|
5607
|
-
page_size?: number;
|
|
5608
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5609
|
-
/**
|
|
5610
|
-
* @description Create a new identifier for a tenant
|
|
5611
|
-
* @tags Tenant Identifiers
|
|
5612
|
-
* @name CreateTenantIdentifier
|
|
5613
|
-
* @summary Create Tenant Identifier
|
|
5614
|
-
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5615
|
-
* @secure
|
|
5616
|
-
*/
|
|
5617
|
-
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5618
|
-
/**
|
|
5619
|
-
* @description Update an existing identifier for a tenant
|
|
5620
|
-
* @tags Tenant Identifiers
|
|
5621
|
-
* @name UpdateTenantIdentifier
|
|
5622
|
-
* @summary Update Tenant Identifier
|
|
5623
|
-
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5624
|
-
* @secure
|
|
5625
|
-
*/
|
|
5626
|
-
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5627
|
-
/**
|
|
5628
|
-
* @description Delete identifier for a tenant
|
|
5629
|
-
* @tags Tenant Identifiers
|
|
5630
|
-
* @name DeleteTenantIdentifier
|
|
5631
|
-
* @summary Delete Tenant Identifier
|
|
5632
|
-
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5633
|
-
* @secure
|
|
5634
|
-
*/
|
|
5635
|
-
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5636
|
-
}
|
|
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
|
-
export class Tenants<HandleError extends boolean = boolean> {
|
|
5685
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5686
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5687
|
-
/**
|
|
5688
|
-
* @tags Tenants
|
|
5689
|
-
* @name FetchTenant
|
|
5690
|
-
* @summary Fetch Tenant
|
|
5691
|
-
* @request GET:/tenants/{tenant_id}
|
|
5692
|
-
* @secure
|
|
5693
|
-
*/
|
|
5694
|
-
fetchTenant(tenantId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantResponse, HandleError>>;
|
|
5695
|
-
/**
|
|
5696
|
-
* @tags Tenants
|
|
5697
|
-
* @name GetHistoricalPolicyChanges
|
|
5698
|
-
* @summary Get Historical Policy Changes
|
|
5699
|
-
* @request GET:/tenants/{tenant_id}/historical-policy-changes
|
|
5700
|
-
* @secure
|
|
5701
|
-
*/
|
|
5702
|
-
getHistoricalPolicyChanges(tenantId: string, query?: {
|
|
5703
|
-
/**
|
|
5704
|
-
* Company Ids
|
|
5705
|
-
* Specify a list of BW identifiers for bulk queries.
|
|
5706
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
5707
|
-
* @example "74822,83343211"
|
|
5708
|
-
*/
|
|
5709
|
-
company_ids?: string;
|
|
5710
|
-
/**
|
|
5711
|
-
* Start Date Gte
|
|
5712
|
-
* Specify the start date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5713
|
-
* @format date
|
|
5714
|
-
*/
|
|
5715
|
-
start_date__gte?: string;
|
|
5716
|
-
/**
|
|
5717
|
-
* End Date Lte
|
|
5718
|
-
* Specify the end date for viewing historical policy changes (in YYYY-MM-DD format).
|
|
5719
|
-
* @format date
|
|
5720
|
-
*/
|
|
5721
|
-
end_date__lte?: string;
|
|
5722
|
-
/**
|
|
5723
|
-
* Current Value
|
|
5724
|
-
* Specify the current value reflecting the policy change
|
|
5465
|
+
* Current Value
|
|
5466
|
+
* Specify the current value reflecting the policy change
|
|
5725
5467
|
*/
|
|
5726
5468
|
current_value?: number | boolean;
|
|
5727
5469
|
/** Type of event that is being requested. */
|
|
@@ -5854,6 +5596,264 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
5854
5596
|
*/
|
|
5855
5597
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5856
5598
|
}
|
|
5599
|
+
export class TenantIdentifiers<HandleError extends boolean = boolean> {
|
|
5600
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5601
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5602
|
+
/**
|
|
5603
|
+
* @description Get list of tenant identifiers
|
|
5604
|
+
* @tags Tenant Identifiers
|
|
5605
|
+
* @name GetTenantIdentifiers
|
|
5606
|
+
* @summary Get Tenant Identifiers
|
|
5607
|
+
* @request GET:/tenants/{tenant_id}/identifiers
|
|
5608
|
+
* @secure
|
|
5609
|
+
*/
|
|
5610
|
+
getTenantIdentifiers(tenantId: string, query?: {
|
|
5611
|
+
/** Tenant custom identifier status. */
|
|
5612
|
+
status?: BridgeWiseTenantIdentifierStatusEnum;
|
|
5613
|
+
/**
|
|
5614
|
+
* Page
|
|
5615
|
+
* Define the page number for the results.
|
|
5616
|
+
* @default 1
|
|
5617
|
+
* @example 1
|
|
5618
|
+
*/
|
|
5619
|
+
page?: number;
|
|
5620
|
+
/**
|
|
5621
|
+
* Page Size
|
|
5622
|
+
* Define the maximum number of results to retrieve.
|
|
5623
|
+
* @default 20
|
|
5624
|
+
* @example 10
|
|
5625
|
+
*/
|
|
5626
|
+
page_size?: number;
|
|
5627
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier[], HandleError>>;
|
|
5628
|
+
/**
|
|
5629
|
+
* @description Create a new identifier for a tenant
|
|
5630
|
+
* @tags Tenant Identifiers
|
|
5631
|
+
* @name CreateTenantIdentifier
|
|
5632
|
+
* @summary Create Tenant Identifier
|
|
5633
|
+
* @request POST:/tenants/{tenant_id}/identifiers
|
|
5634
|
+
* @secure
|
|
5635
|
+
*/
|
|
5636
|
+
createTenantIdentifier(tenantId: string, data: BridgeWiseCreateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5637
|
+
/**
|
|
5638
|
+
* @description Update an existing identifier for a tenant
|
|
5639
|
+
* @tags Tenant Identifiers
|
|
5640
|
+
* @name UpdateTenantIdentifier
|
|
5641
|
+
* @summary Update Tenant Identifier
|
|
5642
|
+
* @request PATCH:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5643
|
+
* @secure
|
|
5644
|
+
*/
|
|
5645
|
+
updateTenantIdentifier(tenantId: string, externalIdentifier: string, data: BridgeWiseUpdateTenantIdentifier, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTenantIdentifier, HandleError>>;
|
|
5646
|
+
/**
|
|
5647
|
+
* @description Delete identifier for a tenant
|
|
5648
|
+
* @tags Tenant Identifiers
|
|
5649
|
+
* @name DeleteTenantIdentifier
|
|
5650
|
+
* @summary Delete Tenant Identifier
|
|
5651
|
+
* @request DELETE:/tenants/{tenant_id}/identifiers/{external_identifier}
|
|
5652
|
+
* @secure
|
|
5653
|
+
*/
|
|
5654
|
+
deleteTenantIdentifier(tenantId: string, externalIdentifier: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
5655
|
+
}
|
|
5656
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
5657
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5658
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5659
|
+
/**
|
|
5660
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
5661
|
+
* @tags Fund ESG Analysis
|
|
5662
|
+
* @name GetFundEsgAnalysis
|
|
5663
|
+
* @summary Get Fund Esg Analysis
|
|
5664
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
5665
|
+
* @secure
|
|
5666
|
+
*/
|
|
5667
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
5668
|
+
/**
|
|
5669
|
+
* Limit
|
|
5670
|
+
* Number of historical periods to be returned (default is 1).
|
|
5671
|
+
*/
|
|
5672
|
+
limit?: number;
|
|
5673
|
+
/**
|
|
5674
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5675
|
+
* @default "en-US"
|
|
5676
|
+
*/
|
|
5677
|
+
language?: BridgeWiseLanguageEnum;
|
|
5678
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
5679
|
+
}
|
|
5680
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
5681
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5682
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5683
|
+
/**
|
|
5684
|
+
* @tags Users
|
|
5685
|
+
* @name Authenticate
|
|
5686
|
+
* @summary Authenticate
|
|
5687
|
+
* @request POST:/users/authenticate
|
|
5688
|
+
* @secure
|
|
5689
|
+
*/
|
|
5690
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
5691
|
+
/**
|
|
5692
|
+
* @tags Users
|
|
5693
|
+
* @name FetchClientDetails
|
|
5694
|
+
* @summary Fetch Client Details
|
|
5695
|
+
* @request GET:/users/machine
|
|
5696
|
+
* @secure
|
|
5697
|
+
*/
|
|
5698
|
+
fetchClientDetails(headers: {
|
|
5699
|
+
/** Authorization */
|
|
5700
|
+
authorization: string;
|
|
5701
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
5702
|
+
}
|
|
5703
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
5704
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5705
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5706
|
+
/**
|
|
5707
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
5708
|
+
* @tags Fund Market Data
|
|
5709
|
+
* @name GetFundsMarketData
|
|
5710
|
+
* @summary Get Funds Market Data
|
|
5711
|
+
* @request GET:/funds/{fund_id}/market
|
|
5712
|
+
* @secure
|
|
5713
|
+
*/
|
|
5714
|
+
getFundsMarketData(fundId: number, query?: {
|
|
5715
|
+
/**
|
|
5716
|
+
* Trading Item Id
|
|
5717
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5718
|
+
*/
|
|
5719
|
+
trading_item_id?: number | null;
|
|
5720
|
+
/**
|
|
5721
|
+
* Date Ge
|
|
5722
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
5723
|
+
*/
|
|
5724
|
+
date__ge?: string | null;
|
|
5725
|
+
/**
|
|
5726
|
+
* Date Le
|
|
5727
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
5728
|
+
*/
|
|
5729
|
+
date__le?: string | null;
|
|
5730
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
5731
|
+
/**
|
|
5732
|
+
* @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.
|
|
5733
|
+
* @tags Fund Market Data
|
|
5734
|
+
* @name GetFundsMarketStatistics
|
|
5735
|
+
* @summary Get Funds Market Statistics
|
|
5736
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
5737
|
+
* @secure
|
|
5738
|
+
*/
|
|
5739
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
5740
|
+
/**
|
|
5741
|
+
* Trading Item Id
|
|
5742
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
5743
|
+
*/
|
|
5744
|
+
trading_item_id?: number | null;
|
|
5745
|
+
/**
|
|
5746
|
+
* Identifier In
|
|
5747
|
+
* Specify a list of external identifiers.
|
|
5748
|
+
*/
|
|
5749
|
+
identifier__in?: string | null;
|
|
5750
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
5751
|
+
/**
|
|
5752
|
+
* @description Returns detailed information on trading items related to the specified fund, focusing exclusively on stocks.
|
|
5753
|
+
* @tags Fund Market Data
|
|
5754
|
+
* @name GetFundTradingItems
|
|
5755
|
+
* @summary Get Fund Trading Items
|
|
5756
|
+
* @request GET:/funds/{fund_id}/trading-items
|
|
5757
|
+
* @secure
|
|
5758
|
+
*/
|
|
5759
|
+
getFundTradingItems(fundId: number, query?: {
|
|
5760
|
+
/**
|
|
5761
|
+
* Primary Flag
|
|
5762
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
5763
|
+
*/
|
|
5764
|
+
primary_flag?: boolean;
|
|
5765
|
+
/**
|
|
5766
|
+
* Security Primary Flag
|
|
5767
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
5768
|
+
*/
|
|
5769
|
+
security_primary_flag?: boolean;
|
|
5770
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList | BridgeWiseFundTradingItemsList, HandleError>>;
|
|
5771
|
+
}
|
|
5772
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
5773
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5774
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5775
|
+
/**
|
|
5776
|
+
* @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.
|
|
5777
|
+
* @tags Holdings
|
|
5778
|
+
* @name GetCompositions
|
|
5779
|
+
* @summary Get Compositions
|
|
5780
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
5781
|
+
* @secure
|
|
5782
|
+
*/
|
|
5783
|
+
getCompositions(fundId: number, query?: {
|
|
5784
|
+
/**
|
|
5785
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5786
|
+
* @default "en-US"
|
|
5787
|
+
*/
|
|
5788
|
+
language?: BridgeWiseLanguageEnum;
|
|
5789
|
+
/** Filter data by specific components of the fund composition (e.g., stocks, others). */
|
|
5790
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5791
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
5792
|
+
/**
|
|
5793
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
5794
|
+
* @tags Holdings
|
|
5795
|
+
* @name GetHoldingStatistics
|
|
5796
|
+
* @summary Get Holding Statistics
|
|
5797
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
5798
|
+
* @secure
|
|
5799
|
+
*/
|
|
5800
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
5801
|
+
/**
|
|
5802
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5803
|
+
* @default "en-US"
|
|
5804
|
+
*/
|
|
5805
|
+
language?: BridgeWiseLanguageEnum;
|
|
5806
|
+
/**
|
|
5807
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5808
|
+
* @default "stocks"
|
|
5809
|
+
*/
|
|
5810
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5811
|
+
/**
|
|
5812
|
+
* Page
|
|
5813
|
+
* Define the page number for pagination.
|
|
5814
|
+
* @exclusiveMin 0
|
|
5815
|
+
*/
|
|
5816
|
+
page?: number;
|
|
5817
|
+
/**
|
|
5818
|
+
* Page Size
|
|
5819
|
+
* Define the number of records per page for pagination purposes.
|
|
5820
|
+
* @exclusiveMin 0
|
|
5821
|
+
*/
|
|
5822
|
+
page_size?: number;
|
|
5823
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
5824
|
+
/**
|
|
5825
|
+
* @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.
|
|
5826
|
+
* @tags Holdings
|
|
5827
|
+
* @name GetHoldings
|
|
5828
|
+
* @summary Get Holdings
|
|
5829
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
5830
|
+
* @secure
|
|
5831
|
+
*/
|
|
5832
|
+
getHoldings(fundId: number, query?: {
|
|
5833
|
+
/**
|
|
5834
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
5835
|
+
* @default "en-US"
|
|
5836
|
+
*/
|
|
5837
|
+
language?: BridgeWiseLanguageEnum;
|
|
5838
|
+
/**
|
|
5839
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
5840
|
+
* @default "stocks"
|
|
5841
|
+
*/
|
|
5842
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
5843
|
+
/**
|
|
5844
|
+
* Page
|
|
5845
|
+
* Define the page number for pagination.
|
|
5846
|
+
* @exclusiveMin 0
|
|
5847
|
+
*/
|
|
5848
|
+
page?: number;
|
|
5849
|
+
/**
|
|
5850
|
+
* Page Size
|
|
5851
|
+
* Define the number of records per page for pagination purposes.
|
|
5852
|
+
* @exclusiveMin 0
|
|
5853
|
+
*/
|
|
5854
|
+
page_size?: number;
|
|
5855
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, 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>;
|