@orbis-systems/orbis-api-clients 0.6.9 → 0.6.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +95 -95
- 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 +162 -168
- 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/index.d.ts +1 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +530 -332
- 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 +1 -2
- 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 +1350 -1351
- 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 +329 -317
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4,10 +4,9 @@ interface BaseClientConfig<HandleError extends boolean = boolean> {
|
|
|
4
4
|
baseUrl: string;
|
|
5
5
|
handleError?: HandleError;
|
|
6
6
|
storage?: Storage;
|
|
7
|
-
defaultHeaders?: Record<string, string>;
|
|
8
7
|
defaultSecure?: boolean;
|
|
9
8
|
authDataStorageKey?: string;
|
|
10
|
-
|
|
9
|
+
axiosConfig?: AxiosRequestConfig;
|
|
11
10
|
onAxiosError?: (error: AxiosError) => void;
|
|
12
11
|
onError?: (error: unknown) => void;
|
|
13
12
|
}
|
|
@@ -601,6 +600,13 @@ export interface InsightCreateOrUpdateFixedIncomePresetRequest {
|
|
|
601
600
|
preset_description?: string;
|
|
602
601
|
preset_name: string;
|
|
603
602
|
}
|
|
603
|
+
export interface InsightCreateOrUpdateFundScreenerPresetRequest {
|
|
604
|
+
id?: string;
|
|
605
|
+
preset?: InsightFundScreenerRequest;
|
|
606
|
+
preset_color: string;
|
|
607
|
+
preset_description?: string;
|
|
608
|
+
preset_name: string;
|
|
609
|
+
}
|
|
604
610
|
export interface InsightCreateOrUpdateScreenerPresetRequest {
|
|
605
611
|
id?: string;
|
|
606
612
|
preset?: InsightStockScreenerRequest;
|
|
@@ -892,15 +898,6 @@ export interface InsightFixedIncome {
|
|
|
892
898
|
type: string;
|
|
893
899
|
updated_at: string;
|
|
894
900
|
}
|
|
895
|
-
export interface InsightFixedIncomePreset {
|
|
896
|
-
created_at: string;
|
|
897
|
-
id: string;
|
|
898
|
-
preset: Record<string, any>;
|
|
899
|
-
preset_color: string;
|
|
900
|
-
preset_description: string;
|
|
901
|
-
preset_name: string;
|
|
902
|
-
updated_at: string;
|
|
903
|
-
}
|
|
904
901
|
export interface InsightFundFilterAsset {
|
|
905
902
|
asset_id?: string;
|
|
906
903
|
asset_name?: string;
|
|
@@ -1274,6 +1271,10 @@ export interface InsightGetPreIPOCompaniesResponse {
|
|
|
1274
1271
|
count: number;
|
|
1275
1272
|
details: InsightPreIPOCompany[];
|
|
1276
1273
|
}
|
|
1274
|
+
export interface InsightGetPreIPOCompanyFundingRoundsResponse {
|
|
1275
|
+
count: number;
|
|
1276
|
+
details: InsightPreIPOCompanyFundingRound[];
|
|
1277
|
+
}
|
|
1277
1278
|
export interface InsightGetPreIPOCompanyInvestmentsResponse {
|
|
1278
1279
|
count: number;
|
|
1279
1280
|
details: InsightPreIPOCompanyInvestment[];
|
|
@@ -1286,6 +1287,10 @@ export interface InsightGetPreIPOCompanyResearchDocumentsResponse {
|
|
|
1286
1287
|
count: number;
|
|
1287
1288
|
details: InsightPreIPOCompanyResearchDocument[];
|
|
1288
1289
|
}
|
|
1290
|
+
export interface InsightGetPreIPOCompanySPVsResponse {
|
|
1291
|
+
count: number;
|
|
1292
|
+
details: InsightPreIPOCompanySPV[];
|
|
1293
|
+
}
|
|
1289
1294
|
export interface InsightGetScreenerPresetsResponse {
|
|
1290
1295
|
count: number;
|
|
1291
1296
|
default_presets: InsightScreenerPreset[];
|
|
@@ -3262,6 +3267,28 @@ export interface InsightPreIPOCompanyArticle {
|
|
|
3262
3267
|
short_summary: string;
|
|
3263
3268
|
source: string;
|
|
3264
3269
|
}
|
|
3270
|
+
export interface InsightPreIPOCompanyFundingRound {
|
|
3271
|
+
citations: InsightPreIPOCompanyFundingRoundCitation[];
|
|
3272
|
+
id: string;
|
|
3273
|
+
issued_at: string;
|
|
3274
|
+
pre_ipo_company_id: string;
|
|
3275
|
+
round_name: string;
|
|
3276
|
+
share_details: InsightPreIPOCompanyFundingRoundShare[];
|
|
3277
|
+
source: string;
|
|
3278
|
+
}
|
|
3279
|
+
export interface InsightPreIPOCompanyFundingRoundCitation {
|
|
3280
|
+
funding_round_id: string;
|
|
3281
|
+
type: string;
|
|
3282
|
+
updated_at: string;
|
|
3283
|
+
url: string;
|
|
3284
|
+
}
|
|
3285
|
+
export interface InsightPreIPOCompanyFundingRoundShare {
|
|
3286
|
+
funding_round_id: string;
|
|
3287
|
+
issue_price: number;
|
|
3288
|
+
issued_at: string;
|
|
3289
|
+
name: string;
|
|
3290
|
+
updated_at: string;
|
|
3291
|
+
}
|
|
3265
3292
|
export interface InsightPreIPOCompanyInvestment {
|
|
3266
3293
|
carried_interest: number;
|
|
3267
3294
|
company_name: string;
|
|
@@ -3306,6 +3333,56 @@ export interface InsightPreIPOCompanyResearchDocument {
|
|
|
3306
3333
|
title: string;
|
|
3307
3334
|
type: string;
|
|
3308
3335
|
}
|
|
3336
|
+
export interface InsightPreIPOCompanySPV {
|
|
3337
|
+
all_in_price_per_share: number;
|
|
3338
|
+
close_date: string;
|
|
3339
|
+
cusip: string;
|
|
3340
|
+
demand_side_commission_split: number;
|
|
3341
|
+
description: string;
|
|
3342
|
+
documents: InsightPreIPOCompanySPVDocument[];
|
|
3343
|
+
exemptions_claimed: string[];
|
|
3344
|
+
funding_deadline: string;
|
|
3345
|
+
id: string;
|
|
3346
|
+
investor_fee_per_share: number;
|
|
3347
|
+
investor_price_per_share: number;
|
|
3348
|
+
management_fee: number;
|
|
3349
|
+
management_fee_years_payable: number;
|
|
3350
|
+
master_llc_name: string;
|
|
3351
|
+
min_commitment_amount: number;
|
|
3352
|
+
monark_commission_split: number;
|
|
3353
|
+
name: string;
|
|
3354
|
+
notable_investors: string[];
|
|
3355
|
+
number_of_seats_remaining: number;
|
|
3356
|
+
pre_funded_inventory: boolean;
|
|
3357
|
+
pre_ipo_company_id: string;
|
|
3358
|
+
pre_ipo_company_investment_id: string;
|
|
3359
|
+
pre_ipo_company_name: string;
|
|
3360
|
+
remaining_dollar_allocation: number;
|
|
3361
|
+
remaining_share_allocation: number;
|
|
3362
|
+
spv_account_id: number;
|
|
3363
|
+
spv_custodian: string;
|
|
3364
|
+
synopsis: string;
|
|
3365
|
+
total_commission: number;
|
|
3366
|
+
total_dollar_allocation: number;
|
|
3367
|
+
total_number_of_seats: number;
|
|
3368
|
+
total_share_allocation: number;
|
|
3369
|
+
trading_symbol: string;
|
|
3370
|
+
valuation: number;
|
|
3371
|
+
}
|
|
3372
|
+
export interface InsightPreIPOCompanySPVDocument {
|
|
3373
|
+
description: string;
|
|
3374
|
+
id: string;
|
|
3375
|
+
investor_id: string;
|
|
3376
|
+
investor_subscription_id: string;
|
|
3377
|
+
name: string;
|
|
3378
|
+
partner_id: string;
|
|
3379
|
+
pre_ipo_company_id: string;
|
|
3380
|
+
pre_ipo_company_investment_id: string;
|
|
3381
|
+
pre_ipo_company_spv_id: string;
|
|
3382
|
+
tax_year: number;
|
|
3383
|
+
template_document: boolean;
|
|
3384
|
+
type: string;
|
|
3385
|
+
}
|
|
3309
3386
|
export interface InsightPublicQuoteProfile {
|
|
3310
3387
|
average_volume_30d: number;
|
|
3311
3388
|
closing_price: number;
|
|
@@ -4160,6 +4237,20 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
|
4160
4237
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
4161
4238
|
BestMatch = "best_match"
|
|
4162
4239
|
}
|
|
4240
|
+
/** sort direction */
|
|
4241
|
+
export enum InsightGetPreIpoCompanySpvsParamsDirectionEnum {
|
|
4242
|
+
ASC = "ASC",
|
|
4243
|
+
DESC = "DESC"
|
|
4244
|
+
}
|
|
4245
|
+
/** sort field */
|
|
4246
|
+
export enum InsightGetPreIpoCompanySpvsParamsFieldEnum {
|
|
4247
|
+
Name = "name",
|
|
4248
|
+
RemainingDollarAllocation = "remaining_dollar_allocation",
|
|
4249
|
+
RemainingShareAllocation = "remaining_share_allocation",
|
|
4250
|
+
NumberOfSeatsRemaining = "number_of_seats_remaining",
|
|
4251
|
+
Valuation = "valuation",
|
|
4252
|
+
MinCommitmentAmount = "min_commitment_amount"
|
|
4253
|
+
}
|
|
4163
4254
|
/** EQUITY|ETF|CRYPTO */
|
|
4164
4255
|
export enum InsightTopStocksParamsStockTypeEnum {
|
|
4165
4256
|
EQUITY = "EQUITY",
|
|
@@ -4188,6 +4279,129 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4188
4279
|
Date = "date",
|
|
4189
4280
|
Rank = "rank"
|
|
4190
4281
|
}
|
|
4282
|
+
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4283
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4284
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4285
|
+
/**
|
|
4286
|
+
* @description get company profile, industries classification and closest earning release
|
|
4287
|
+
* @tags CompanyProfile
|
|
4288
|
+
* @name GetCompanyProfile
|
|
4289
|
+
* @summary get company profile
|
|
4290
|
+
* @request GET:/company-profile
|
|
4291
|
+
* @secure
|
|
4292
|
+
*/
|
|
4293
|
+
getCompanyProfile(query: {
|
|
4294
|
+
/** Company symbol */
|
|
4295
|
+
symbol: string;
|
|
4296
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4297
|
+
/**
|
|
4298
|
+
* @description get combined profile, equities and funds
|
|
4299
|
+
* @tags CompanyProfile
|
|
4300
|
+
* @name GetCombinedProfile
|
|
4301
|
+
* @summary get company profile
|
|
4302
|
+
* @request GET:/quote-profile
|
|
4303
|
+
* @secure
|
|
4304
|
+
*/
|
|
4305
|
+
getCombinedProfile(query: {
|
|
4306
|
+
/** Company symbol */
|
|
4307
|
+
symbol: string;
|
|
4308
|
+
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4309
|
+
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4310
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4311
|
+
/**
|
|
4312
|
+
* @description sort input array of symbols by type
|
|
4313
|
+
* @tags CompanyProfile
|
|
4314
|
+
* @name GetSymbolsPerSymbolType
|
|
4315
|
+
* @summary sort input array of symbols by type
|
|
4316
|
+
* @request POST:/symbols-per-type
|
|
4317
|
+
* @secure
|
|
4318
|
+
*/
|
|
4319
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4320
|
+
}
|
|
4321
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4322
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4323
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4324
|
+
/**
|
|
4325
|
+
* @description get custom lists
|
|
4326
|
+
* @tags Custom Lists
|
|
4327
|
+
* @name GetCustomLists
|
|
4328
|
+
* @summary get custom lists
|
|
4329
|
+
* @request GET:/custom-lists
|
|
4330
|
+
* @secure
|
|
4331
|
+
*/
|
|
4332
|
+
getCustomLists(query: {
|
|
4333
|
+
/** how many records to return. Max value is 50 */
|
|
4334
|
+
limit: number;
|
|
4335
|
+
/** how many records to skip */
|
|
4336
|
+
offset: number;
|
|
4337
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4338
|
+
/**
|
|
4339
|
+
* @description update custom list
|
|
4340
|
+
* @tags Custom Lists
|
|
4341
|
+
* @name UpdateCustomList
|
|
4342
|
+
* @summary update custom list
|
|
4343
|
+
* @request PUT:/custom-lists
|
|
4344
|
+
* @secure
|
|
4345
|
+
*/
|
|
4346
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4347
|
+
/**
|
|
4348
|
+
* @description create custom list
|
|
4349
|
+
* @tags Custom Lists
|
|
4350
|
+
* @name CreateCustomList
|
|
4351
|
+
* @summary create custom list
|
|
4352
|
+
* @request POST:/custom-lists
|
|
4353
|
+
* @secure
|
|
4354
|
+
*/
|
|
4355
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4356
|
+
/**
|
|
4357
|
+
* @description remove custom list
|
|
4358
|
+
* @tags Custom Lists
|
|
4359
|
+
* @name RemoveCustomList
|
|
4360
|
+
* @summary remove custom list
|
|
4361
|
+
* @request DELETE:/custom-lists
|
|
4362
|
+
* @secure
|
|
4363
|
+
*/
|
|
4364
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4365
|
+
/**
|
|
4366
|
+
* @description filter custom lists
|
|
4367
|
+
* @tags Custom Lists
|
|
4368
|
+
* @name FilterCustomLists
|
|
4369
|
+
* @summary filter custom lists
|
|
4370
|
+
* @request POST:/custom-lists/filter
|
|
4371
|
+
* @secure
|
|
4372
|
+
*/
|
|
4373
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4374
|
+
/**
|
|
4375
|
+
* @description get custom list with quotes
|
|
4376
|
+
* @tags Custom Lists
|
|
4377
|
+
* @name GetCustomListWithQuotes
|
|
4378
|
+
* @summary get custom list with quotes
|
|
4379
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
4380
|
+
* @secure
|
|
4381
|
+
*/
|
|
4382
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4383
|
+
/** sort direction - asc or desc */
|
|
4384
|
+
order_direction: string;
|
|
4385
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4386
|
+
order_field: string;
|
|
4387
|
+
/** how many equities records to return. Max value is 50 */
|
|
4388
|
+
limit: number;
|
|
4389
|
+
/** how many equities records to skip */
|
|
4390
|
+
offset: number;
|
|
4391
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4392
|
+
/**
|
|
4393
|
+
* @description filter custom list
|
|
4394
|
+
* @tags Custom Lists
|
|
4395
|
+
* @name FilterCustomList
|
|
4396
|
+
* @summary filter custom list
|
|
4397
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4398
|
+
* @secure
|
|
4399
|
+
*/
|
|
4400
|
+
filterCustomList(idOrSlug: string, query?: {
|
|
4401
|
+
/** symbols to check inclusion */
|
|
4402
|
+
symbols?: string[];
|
|
4403
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4404
|
+
}
|
|
4191
4405
|
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4192
4406
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4193
4407
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4370,191 +4584,68 @@ export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
|
4370
4584
|
id: string;
|
|
4371
4585
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4372
4586
|
}
|
|
4373
|
-
export class
|
|
4587
|
+
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4374
4588
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4375
4589
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4376
4590
|
/**
|
|
4377
|
-
* @description get
|
|
4378
|
-
* @tags
|
|
4379
|
-
* @name
|
|
4380
|
-
* @summary get
|
|
4381
|
-
* @request
|
|
4591
|
+
* @description get ownerships by symbol
|
|
4592
|
+
* @tags Dashboard
|
|
4593
|
+
* @name DashboardGetOwnershipsBySymbol
|
|
4594
|
+
* @summary get ownerships by symbol
|
|
4595
|
+
* @request POST:/dashboard/ownerships
|
|
4382
4596
|
* @secure
|
|
4383
4597
|
*/
|
|
4384
|
-
|
|
4385
|
-
/** Company symbol */
|
|
4386
|
-
symbol: string;
|
|
4387
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
4598
|
+
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
4388
4599
|
/**
|
|
4389
|
-
* @description
|
|
4390
|
-
* @tags
|
|
4391
|
-
* @name
|
|
4392
|
-
* @summary
|
|
4393
|
-
* @request
|
|
4600
|
+
* @description rewrite field value
|
|
4601
|
+
* @tags Dashboard
|
|
4602
|
+
* @name RewriteFieldValue
|
|
4603
|
+
* @summary rewrite field value
|
|
4604
|
+
* @request POST:/rewrite-field
|
|
4394
4605
|
* @secure
|
|
4395
4606
|
*/
|
|
4396
|
-
|
|
4397
|
-
/** Company symbol */
|
|
4398
|
-
symbol: string;
|
|
4399
|
-
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
4400
|
-
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
4401
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
4607
|
+
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4402
4608
|
/**
|
|
4403
|
-
* @description
|
|
4404
|
-
* @tags
|
|
4405
|
-
* @name
|
|
4406
|
-
* @summary
|
|
4407
|
-
* @request
|
|
4609
|
+
* @description remove rewritten value
|
|
4610
|
+
* @tags Dashboard
|
|
4611
|
+
* @name CreateRewriteField
|
|
4612
|
+
* @summary remove rewritten value
|
|
4613
|
+
* @request DELETE:/rewrite-field
|
|
4408
4614
|
* @secure
|
|
4409
4615
|
*/
|
|
4410
|
-
|
|
4411
|
-
}
|
|
4412
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4413
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4414
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4616
|
+
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4415
4617
|
/**
|
|
4416
|
-
* @description
|
|
4417
|
-
* @tags
|
|
4418
|
-
* @name
|
|
4419
|
-
* @summary get
|
|
4420
|
-
* @request GET:/
|
|
4618
|
+
* @description Get rewritten field action log
|
|
4619
|
+
* @tags Dashboard
|
|
4620
|
+
* @name GetRewrittenFieldActionLog
|
|
4621
|
+
* @summary get rewritten field action log
|
|
4622
|
+
* @request GET:/rewritten-field-action-log
|
|
4421
4623
|
* @secure
|
|
4422
4624
|
*/
|
|
4423
|
-
|
|
4625
|
+
getRewrittenFieldActionLog(query: {
|
|
4626
|
+
/** Internal UUID */
|
|
4627
|
+
internal_id: string;
|
|
4628
|
+
/** Field ID */
|
|
4629
|
+
field_id: string;
|
|
4424
4630
|
/** how many records to return. Max value is 50 */
|
|
4425
4631
|
limit: number;
|
|
4426
4632
|
/** how many records to skip */
|
|
4427
4633
|
offset: number;
|
|
4428
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4634
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4429
4635
|
/**
|
|
4430
|
-
* @description
|
|
4431
|
-
* @tags
|
|
4432
|
-
* @name
|
|
4433
|
-
* @summary
|
|
4434
|
-
* @request
|
|
4636
|
+
* @description Get rewritten values
|
|
4637
|
+
* @tags Dashboard
|
|
4638
|
+
* @name GetRewrittenValues
|
|
4639
|
+
* @summary get rewritten values
|
|
4640
|
+
* @request GET:/rewritten-fields
|
|
4435
4641
|
* @secure
|
|
4436
4642
|
*/
|
|
4437
|
-
|
|
4438
|
-
|
|
4439
|
-
|
|
4440
|
-
|
|
4441
|
-
|
|
4442
|
-
|
|
4443
|
-
* @request POST:/custom-lists
|
|
4444
|
-
* @secure
|
|
4445
|
-
*/
|
|
4446
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4447
|
-
/**
|
|
4448
|
-
* @description remove custom list
|
|
4449
|
-
* @tags Custom Lists
|
|
4450
|
-
* @name RemoveCustomList
|
|
4451
|
-
* @summary remove custom list
|
|
4452
|
-
* @request DELETE:/custom-lists
|
|
4453
|
-
* @secure
|
|
4454
|
-
*/
|
|
4455
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4456
|
-
/**
|
|
4457
|
-
* @description filter custom lists
|
|
4458
|
-
* @tags Custom Lists
|
|
4459
|
-
* @name FilterCustomLists
|
|
4460
|
-
* @summary filter custom lists
|
|
4461
|
-
* @request POST:/custom-lists/filter
|
|
4462
|
-
* @secure
|
|
4463
|
-
*/
|
|
4464
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4465
|
-
/**
|
|
4466
|
-
* @description get custom list with quotes
|
|
4467
|
-
* @tags Custom Lists
|
|
4468
|
-
* @name GetCustomListWithQuotes
|
|
4469
|
-
* @summary get custom list with quotes
|
|
4470
|
-
* @request GET:/custom-lists/{id-or-slug}
|
|
4471
|
-
* @secure
|
|
4472
|
-
*/
|
|
4473
|
-
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4474
|
-
/** sort direction - asc or desc */
|
|
4475
|
-
order_direction: string;
|
|
4476
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4477
|
-
order_field: string;
|
|
4478
|
-
/** how many equities records to return. Max value is 50 */
|
|
4479
|
-
limit: number;
|
|
4480
|
-
/** how many equities records to skip */
|
|
4481
|
-
offset: number;
|
|
4482
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4483
|
-
/**
|
|
4484
|
-
* @description filter custom list
|
|
4485
|
-
* @tags Custom Lists
|
|
4486
|
-
* @name FilterCustomList
|
|
4487
|
-
* @summary filter custom list
|
|
4488
|
-
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4489
|
-
* @secure
|
|
4490
|
-
*/
|
|
4491
|
-
filterCustomList(idOrSlug: string, query?: {
|
|
4492
|
-
/** symbols to check inclusion */
|
|
4493
|
-
symbols?: string[];
|
|
4494
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4495
|
-
}
|
|
4496
|
-
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4497
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4498
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4499
|
-
/**
|
|
4500
|
-
* @description get ownerships by symbol
|
|
4501
|
-
* @tags Dashboard
|
|
4502
|
-
* @name DashboardGetOwnershipsBySymbol
|
|
4503
|
-
* @summary get ownerships by symbol
|
|
4504
|
-
* @request POST:/dashboard/ownerships
|
|
4505
|
-
* @secure
|
|
4506
|
-
*/
|
|
4507
|
-
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
4508
|
-
/**
|
|
4509
|
-
* @description rewrite field value
|
|
4510
|
-
* @tags Dashboard
|
|
4511
|
-
* @name RewriteFieldValue
|
|
4512
|
-
* @summary rewrite field value
|
|
4513
|
-
* @request POST:/rewrite-field
|
|
4514
|
-
* @secure
|
|
4515
|
-
*/
|
|
4516
|
-
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4517
|
-
/**
|
|
4518
|
-
* @description remove rewritten value
|
|
4519
|
-
* @tags Dashboard
|
|
4520
|
-
* @name CreateRewriteField
|
|
4521
|
-
* @summary remove rewritten value
|
|
4522
|
-
* @request DELETE:/rewrite-field
|
|
4523
|
-
* @secure
|
|
4524
|
-
*/
|
|
4525
|
-
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4526
|
-
/**
|
|
4527
|
-
* @description Get rewritten field action log
|
|
4528
|
-
* @tags Dashboard
|
|
4529
|
-
* @name GetRewrittenFieldActionLog
|
|
4530
|
-
* @summary get rewritten field action log
|
|
4531
|
-
* @request GET:/rewritten-field-action-log
|
|
4532
|
-
* @secure
|
|
4533
|
-
*/
|
|
4534
|
-
getRewrittenFieldActionLog(query: {
|
|
4535
|
-
/** Internal UUID */
|
|
4536
|
-
internal_id: string;
|
|
4537
|
-
/** Field ID */
|
|
4538
|
-
field_id: string;
|
|
4539
|
-
/** how many records to return. Max value is 50 */
|
|
4540
|
-
limit: number;
|
|
4541
|
-
/** how many records to skip */
|
|
4542
|
-
offset: number;
|
|
4543
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4544
|
-
/**
|
|
4545
|
-
* @description Get rewritten values
|
|
4546
|
-
* @tags Dashboard
|
|
4547
|
-
* @name GetRewrittenValues
|
|
4548
|
-
* @summary get rewritten values
|
|
4549
|
-
* @request GET:/rewritten-fields
|
|
4550
|
-
* @secure
|
|
4551
|
-
*/
|
|
4552
|
-
getRewrittenValues(query: {
|
|
4553
|
-
/** how many records to return. Max value is 50 */
|
|
4554
|
-
limit: number;
|
|
4555
|
-
/** how many records to skip */
|
|
4556
|
-
offset: number;
|
|
4557
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4643
|
+
getRewrittenValues(query: {
|
|
4644
|
+
/** how many records to return. Max value is 50 */
|
|
4645
|
+
limit: number;
|
|
4646
|
+
/** how many records to skip */
|
|
4647
|
+
offset: number;
|
|
4648
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4558
4649
|
/**
|
|
4559
4650
|
* @description get symbol-related fields
|
|
4560
4651
|
* @tags Dashboard
|
|
@@ -4581,6 +4672,19 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
4581
4672
|
*/
|
|
4582
4673
|
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
4583
4674
|
}
|
|
4675
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4676
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4677
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4678
|
+
/**
|
|
4679
|
+
* @description get fundamentals by symbol data
|
|
4680
|
+
* @tags Fundamentals
|
|
4681
|
+
* @name GetFundamentalsBySymbolData
|
|
4682
|
+
* @summary get fundamentals by symbol data
|
|
4683
|
+
* @request POST:/fundamentals
|
|
4684
|
+
* @secure
|
|
4685
|
+
*/
|
|
4686
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4687
|
+
}
|
|
4584
4688
|
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
4585
4689
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4586
4690
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4624,16 +4728,16 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4624
4728
|
* @request PUT:/fixed-income/presets
|
|
4625
4729
|
* @secure
|
|
4626
4730
|
*/
|
|
4627
|
-
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4731
|
+
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4628
4732
|
/**
|
|
4629
4733
|
* @description create fixed-income preset
|
|
4630
4734
|
* @tags FixedIncome
|
|
4631
|
-
* @name
|
|
4735
|
+
* @name CreateFixedIncomePreset
|
|
4632
4736
|
* @summary create fixed-income preset
|
|
4633
4737
|
* @request POST:/fixed-income/presets
|
|
4634
4738
|
* @secure
|
|
4635
4739
|
*/
|
|
4636
|
-
|
|
4740
|
+
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4637
4741
|
/**
|
|
4638
4742
|
* @description remove fixed-income preset
|
|
4639
4743
|
* @tags FixedIncome
|
|
@@ -4653,19 +4757,6 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4653
4757
|
*/
|
|
4654
4758
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4655
4759
|
}
|
|
4656
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4657
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4658
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4659
|
-
/**
|
|
4660
|
-
* @description get fundamentals by symbol data
|
|
4661
|
-
* @tags Fundamentals
|
|
4662
|
-
* @name GetFundamentalsBySymbolData
|
|
4663
|
-
* @summary get fundamentals by symbol data
|
|
4664
|
-
* @request POST:/fundamentals
|
|
4665
|
-
* @secure
|
|
4666
|
-
*/
|
|
4667
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4668
|
-
}
|
|
4669
4760
|
export class Funds<HandleError extends boolean = boolean> {
|
|
4670
4761
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4671
4762
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4714,6 +4805,47 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
4714
4805
|
* @secure
|
|
4715
4806
|
*/
|
|
4716
4807
|
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
4808
|
+
/**
|
|
4809
|
+
* @description get fund screener presets
|
|
4810
|
+
* @tags Funds
|
|
4811
|
+
* @name GetFundScreenerPresets
|
|
4812
|
+
* @summary get fund screener presets
|
|
4813
|
+
* @request GET:/funds/screener/presets
|
|
4814
|
+
* @secure
|
|
4815
|
+
*/
|
|
4816
|
+
getFundScreenerPresets(query: {
|
|
4817
|
+
/** how many records to return */
|
|
4818
|
+
limit: number;
|
|
4819
|
+
/** how many records to skip */
|
|
4820
|
+
offset: number;
|
|
4821
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4822
|
+
/**
|
|
4823
|
+
* @description update fund screener preset
|
|
4824
|
+
* @tags Funds
|
|
4825
|
+
* @name UpdateFundScreenerPreset
|
|
4826
|
+
* @summary update fund screener preset
|
|
4827
|
+
* @request PUT:/funds/screener/presets
|
|
4828
|
+
* @secure
|
|
4829
|
+
*/
|
|
4830
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4831
|
+
/**
|
|
4832
|
+
* @description create fund screener preset
|
|
4833
|
+
* @tags Funds
|
|
4834
|
+
* @name CreateFundScreenerPreset
|
|
4835
|
+
* @summary create fund screener preset
|
|
4836
|
+
* @request POST:/funds/screener/presets
|
|
4837
|
+
* @secure
|
|
4838
|
+
*/
|
|
4839
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
4840
|
+
/**
|
|
4841
|
+
* @description remove fund screener preset
|
|
4842
|
+
* @tags Funds
|
|
4843
|
+
* @name RemoveFundScreenerPreset
|
|
4844
|
+
* @summary remove fund screener preset
|
|
4845
|
+
* @request DELETE:/funds/screener/presets
|
|
4846
|
+
* @secure
|
|
4847
|
+
*/
|
|
4848
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4717
4849
|
/**
|
|
4718
4850
|
* @description filter funds by params
|
|
4719
4851
|
* @tags Funds
|
|
@@ -4887,6 +5019,33 @@ export class Intraday<HandleError extends boolean = boolean> {
|
|
|
4887
5019
|
*/
|
|
4888
5020
|
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
4889
5021
|
}
|
|
5022
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5023
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5024
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5025
|
+
/**
|
|
5026
|
+
* @description get recent ipos info
|
|
5027
|
+
* @tags Ipos
|
|
5028
|
+
* @name PostRecent
|
|
5029
|
+
* @summary get recent ipos info
|
|
5030
|
+
* @request POST:/ipos/recent
|
|
5031
|
+
* @secure
|
|
5032
|
+
*/
|
|
5033
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5034
|
+
/**
|
|
5035
|
+
* @description get upcoming ipos info
|
|
5036
|
+
* @tags Ipos
|
|
5037
|
+
* @name GetUpcoming
|
|
5038
|
+
* @summary get upcoming ipos info
|
|
5039
|
+
* @request GET:/ipos/upcoming
|
|
5040
|
+
* @secure
|
|
5041
|
+
*/
|
|
5042
|
+
getUpcoming(query: {
|
|
5043
|
+
/** how many records to return. Max value is 50 */
|
|
5044
|
+
limit: number;
|
|
5045
|
+
/** how many records to skip */
|
|
5046
|
+
offset: number;
|
|
5047
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5048
|
+
}
|
|
4890
5049
|
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
4891
5050
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4892
5051
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4909,14 +5068,43 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4909
5068
|
/**
|
|
4910
5069
|
* @description get pre ipo company by id
|
|
4911
5070
|
* @tags PreIPOCompanies
|
|
4912
|
-
* @name
|
|
5071
|
+
* @name GetPreIpoCompaniesById
|
|
4913
5072
|
* @summary get pre ipo company by id
|
|
4914
5073
|
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
4915
5074
|
* @originalName getPreIpoCompanies
|
|
4916
5075
|
* @duplicate
|
|
4917
5076
|
* @secure
|
|
4918
5077
|
*/
|
|
4919
|
-
|
|
5078
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5079
|
+
/**
|
|
5080
|
+
* @description get pre ipo company funding rounds
|
|
5081
|
+
* @tags PreIPOCompanies
|
|
5082
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5083
|
+
* @summary get pre ipo company funding rounds
|
|
5084
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5085
|
+
* @secure
|
|
5086
|
+
*/
|
|
5087
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5088
|
+
/** company id */
|
|
5089
|
+
pre_ipo_company_id?: string;
|
|
5090
|
+
/** search by round name */
|
|
5091
|
+
round_name?: string;
|
|
5092
|
+
/** how many records to return. Max value is 50 */
|
|
5093
|
+
limit: number;
|
|
5094
|
+
/** how many records to skip */
|
|
5095
|
+
offset: number;
|
|
5096
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5097
|
+
/**
|
|
5098
|
+
* @description get pre ipo company funding round by id
|
|
5099
|
+
* @tags PreIPOCompanies
|
|
5100
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5101
|
+
* @summary get pre ipo company funding round by id
|
|
5102
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5103
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5104
|
+
* @duplicate
|
|
5105
|
+
* @secure
|
|
5106
|
+
*/
|
|
5107
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
4920
5108
|
/**
|
|
4921
5109
|
* @description get pre ipo company investments
|
|
4922
5110
|
* @tags PreIPOCompanies
|
|
@@ -4938,14 +5126,14 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4938
5126
|
/**
|
|
4939
5127
|
* @description get pre ipo company investment by id
|
|
4940
5128
|
* @tags PreIPOCompanies
|
|
4941
|
-
* @name
|
|
5129
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
4942
5130
|
* @summary get pre ipo company investment by id
|
|
4943
5131
|
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
4944
5132
|
* @originalName getPreIpoCompanyInvestments
|
|
4945
5133
|
* @duplicate
|
|
4946
5134
|
* @secure
|
|
4947
5135
|
*/
|
|
4948
|
-
|
|
5136
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
4949
5137
|
/**
|
|
4950
5138
|
* @description get pre ipo company news
|
|
4951
5139
|
* @tags PreIPOCompanies
|
|
@@ -4967,14 +5155,14 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4967
5155
|
/**
|
|
4968
5156
|
* @description get pre ipo company news by id
|
|
4969
5157
|
* @tags PreIPOCompanies
|
|
4970
|
-
* @name
|
|
5158
|
+
* @name GetPreIpoCompanyNewsById
|
|
4971
5159
|
* @summary get pre ipo company news by id
|
|
4972
5160
|
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
4973
5161
|
* @originalName getPreIpoCompanyNews
|
|
4974
5162
|
* @duplicate
|
|
4975
5163
|
* @secure
|
|
4976
5164
|
*/
|
|
4977
|
-
|
|
5165
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
4978
5166
|
/**
|
|
4979
5167
|
* @description get pre ipo company research documents
|
|
4980
5168
|
* @tags PreIPOCompanies
|
|
@@ -4996,41 +5184,51 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
4996
5184
|
/**
|
|
4997
5185
|
* @description get pre ipo company research document by id
|
|
4998
5186
|
* @tags PreIPOCompanies
|
|
4999
|
-
* @name
|
|
5187
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5000
5188
|
* @summary get pre ipo company research document by id
|
|
5001
5189
|
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5002
5190
|
* @originalName getPreIpoCompanyResearchDocuments
|
|
5003
5191
|
* @duplicate
|
|
5004
5192
|
* @secure
|
|
5005
5193
|
*/
|
|
5006
|
-
|
|
5007
|
-
}
|
|
5008
|
-
export class Ipos<HandleError extends boolean = boolean> {
|
|
5009
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5010
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5011
|
-
/**
|
|
5012
|
-
* @description get recent ipos info
|
|
5013
|
-
* @tags Ipos
|
|
5014
|
-
* @name PostRecent
|
|
5015
|
-
* @summary get recent ipos info
|
|
5016
|
-
* @request POST:/ipos/recent
|
|
5017
|
-
* @secure
|
|
5018
|
-
*/
|
|
5019
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5194
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5020
5195
|
/**
|
|
5021
|
-
* @description get
|
|
5022
|
-
* @tags
|
|
5023
|
-
* @name
|
|
5024
|
-
* @summary get
|
|
5025
|
-
* @request GET:/ipos/
|
|
5196
|
+
* @description get pre ipo company spvs
|
|
5197
|
+
* @tags PreIPOCompanies
|
|
5198
|
+
* @name GetPreIpoCompanySpvs
|
|
5199
|
+
* @summary get pre ipo company spvs
|
|
5200
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5026
5201
|
* @secure
|
|
5027
5202
|
*/
|
|
5028
|
-
|
|
5203
|
+
getPreIpoCompanySpvs(query: {
|
|
5204
|
+
/** company id */
|
|
5205
|
+
pre_ipo_company_id?: string;
|
|
5206
|
+
/** investment id */
|
|
5207
|
+
investment_id?: string;
|
|
5208
|
+
/** search by name */
|
|
5209
|
+
name?: string;
|
|
5210
|
+
/** search by company name */
|
|
5211
|
+
company_name?: string;
|
|
5029
5212
|
/** how many records to return. Max value is 50 */
|
|
5030
5213
|
limit: number;
|
|
5031
5214
|
/** how many records to skip */
|
|
5032
5215
|
offset: number;
|
|
5033
|
-
|
|
5216
|
+
/** sort direction */
|
|
5217
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5218
|
+
/** sort field */
|
|
5219
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5220
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5221
|
+
/**
|
|
5222
|
+
* @description get pre ipo company spv by id
|
|
5223
|
+
* @tags PreIPOCompanies
|
|
5224
|
+
* @name GetPreIpoCompanySpvsById
|
|
5225
|
+
* @summary get pre ipo company spv by id
|
|
5226
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5227
|
+
* @originalName getPreIpoCompanySpvs
|
|
5228
|
+
* @duplicate
|
|
5229
|
+
* @secure
|
|
5230
|
+
*/
|
|
5231
|
+
getPreIpoCompanySpvsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5034
5232
|
}
|
|
5035
5233
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5036
5234
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5157,28 +5355,6 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5157
5355
|
market: string;
|
|
5158
5356
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5159
5357
|
}
|
|
5160
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5161
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5162
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5163
|
-
/**
|
|
5164
|
-
* @description Returns calculated matrix
|
|
5165
|
-
* @tags OptionGreeks
|
|
5166
|
-
* @name OgCalculateMatrix
|
|
5167
|
-
* @summary Calculate matrix
|
|
5168
|
-
* @request POST:/og/calculate-matrix
|
|
5169
|
-
* @secure
|
|
5170
|
-
*/
|
|
5171
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5172
|
-
/**
|
|
5173
|
-
* @description Returns calculated params
|
|
5174
|
-
* @tags OptionGreeks
|
|
5175
|
-
* @name OgCalculateParams
|
|
5176
|
-
* @summary Calculate params
|
|
5177
|
-
* @request POST:/og/calculate-params
|
|
5178
|
-
* @secure
|
|
5179
|
-
*/
|
|
5180
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5181
|
-
}
|
|
5182
5358
|
export class News<HandleError extends boolean = boolean> {
|
|
5183
5359
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5184
5360
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5320,28 +5496,6 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5320
5496
|
*/
|
|
5321
5497
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5322
5498
|
}
|
|
5323
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5324
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5325
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5326
|
-
/**
|
|
5327
|
-
* @description get ownerships by id datadata
|
|
5328
|
-
* @tags Ownerships
|
|
5329
|
-
* @name GetOwnershipsByIdData
|
|
5330
|
-
* @summary get ownerships by id data
|
|
5331
|
-
* @request POST:/ownerships
|
|
5332
|
-
* @secure
|
|
5333
|
-
*/
|
|
5334
|
-
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5335
|
-
/**
|
|
5336
|
-
* @description get ownerships by symbol data
|
|
5337
|
-
* @tags Ownerships
|
|
5338
|
-
* @name GetOwnershipsBySymbolData
|
|
5339
|
-
* @summary get ownerships by symbol data
|
|
5340
|
-
* @request POST:/symbol-ownerships
|
|
5341
|
-
* @secure
|
|
5342
|
-
*/
|
|
5343
|
-
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5344
|
-
}
|
|
5345
5499
|
export class Public<HandleError extends boolean = boolean> {
|
|
5346
5500
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5347
5501
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5468,76 +5622,49 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
5468
5622
|
offset: number;
|
|
5469
5623
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
5470
5624
|
}
|
|
5471
|
-
export class
|
|
5472
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5473
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5474
|
-
/**
|
|
5475
|
-
* @description get usage date per branch for a period
|
|
5476
|
-
* @tags UsageTracking
|
|
5477
|
-
* @name GetUsageData
|
|
5478
|
-
* @summary get insight usage data
|
|
5479
|
-
* @request POST:/tracking/usage
|
|
5480
|
-
* @secure
|
|
5481
|
-
*/
|
|
5482
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
5483
|
-
}
|
|
5484
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
5625
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5485
5626
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5486
5627
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5487
5628
|
/**
|
|
5488
|
-
* @description Returns
|
|
5489
|
-
* @tags
|
|
5490
|
-
* @name
|
|
5491
|
-
* @summary
|
|
5492
|
-
* @request POST:/
|
|
5493
|
-
* @secure
|
|
5494
|
-
*/
|
|
5495
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5496
|
-
/**
|
|
5497
|
-
* @description Returns articles
|
|
5498
|
-
* @tags Passport
|
|
5499
|
-
* @name PassportArticles
|
|
5500
|
-
* @summary Get articles
|
|
5501
|
-
* @request POST:/passport/articles
|
|
5502
|
-
* @secure
|
|
5503
|
-
*/
|
|
5504
|
-
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5505
|
-
/**
|
|
5506
|
-
* @description Returns author profile
|
|
5507
|
-
* @tags Passport
|
|
5508
|
-
* @name PassportAuthorProfile
|
|
5509
|
-
* @summary Get author profile
|
|
5510
|
-
* @request POST:/passport/author-profile
|
|
5629
|
+
* @description Returns calculated matrix
|
|
5630
|
+
* @tags OptionGreeks
|
|
5631
|
+
* @name OgCalculateMatrix
|
|
5632
|
+
* @summary Calculate matrix
|
|
5633
|
+
* @request POST:/og/calculate-matrix
|
|
5511
5634
|
* @secure
|
|
5512
5635
|
*/
|
|
5513
|
-
|
|
5636
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5514
5637
|
/**
|
|
5515
|
-
* @description Returns
|
|
5516
|
-
* @tags
|
|
5517
|
-
* @name
|
|
5518
|
-
* @summary
|
|
5519
|
-
* @request POST:/
|
|
5638
|
+
* @description Returns calculated params
|
|
5639
|
+
* @tags OptionGreeks
|
|
5640
|
+
* @name OgCalculateParams
|
|
5641
|
+
* @summary Calculate params
|
|
5642
|
+
* @request POST:/og/calculate-params
|
|
5520
5643
|
* @secure
|
|
5521
5644
|
*/
|
|
5522
|
-
|
|
5645
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5646
|
+
}
|
|
5647
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5648
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5649
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5523
5650
|
/**
|
|
5524
|
-
* @description
|
|
5525
|
-
* @tags
|
|
5526
|
-
* @name
|
|
5527
|
-
* @summary
|
|
5528
|
-
* @request POST:/
|
|
5651
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5652
|
+
* @tags AlphaTools
|
|
5653
|
+
* @name GetMomentumRatioGraph
|
|
5654
|
+
* @summary get seasonlity data
|
|
5655
|
+
* @request POST:/rst
|
|
5529
5656
|
* @secure
|
|
5530
5657
|
*/
|
|
5531
|
-
|
|
5658
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5532
5659
|
/**
|
|
5533
|
-
* @description
|
|
5534
|
-
* @tags
|
|
5535
|
-
* @name
|
|
5536
|
-
* @summary
|
|
5537
|
-
* @request POST:/
|
|
5660
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5661
|
+
* @tags AlphaTools
|
|
5662
|
+
* @name GetSeasonality
|
|
5663
|
+
* @summary get seasonlity data
|
|
5664
|
+
* @request POST:/seasonality
|
|
5538
5665
|
* @secure
|
|
5539
5666
|
*/
|
|
5540
|
-
|
|
5667
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5541
5668
|
}
|
|
5542
5669
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5543
5670
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5905,27 +6032,98 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
5905
6032
|
Authorization?: string;
|
|
5906
6033
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
5907
6034
|
}
|
|
5908
|
-
export class
|
|
6035
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
5909
6036
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5910
6037
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5911
6038
|
/**
|
|
5912
|
-
* @description get
|
|
5913
|
-
* @tags
|
|
5914
|
-
* @name
|
|
5915
|
-
* @summary get
|
|
5916
|
-
* @request POST:/
|
|
6039
|
+
* @description get usage date per branch for a period
|
|
6040
|
+
* @tags UsageTracking
|
|
6041
|
+
* @name GetUsageData
|
|
6042
|
+
* @summary get insight usage data
|
|
6043
|
+
* @request POST:/tracking/usage
|
|
5917
6044
|
* @secure
|
|
5918
6045
|
*/
|
|
5919
|
-
|
|
6046
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6047
|
+
}
|
|
6048
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6049
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6050
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5920
6051
|
/**
|
|
5921
|
-
* @description get
|
|
5922
|
-
* @tags
|
|
5923
|
-
* @name
|
|
5924
|
-
* @summary get
|
|
5925
|
-
* @request POST:/
|
|
6052
|
+
* @description get ownerships by id datadata
|
|
6053
|
+
* @tags Ownerships
|
|
6054
|
+
* @name GetOwnershipsByIdData
|
|
6055
|
+
* @summary get ownerships by id data
|
|
6056
|
+
* @request POST:/ownerships
|
|
5926
6057
|
* @secure
|
|
5927
6058
|
*/
|
|
5928
|
-
|
|
6059
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6060
|
+
/**
|
|
6061
|
+
* @description get ownerships by symbol data
|
|
6062
|
+
* @tags Ownerships
|
|
6063
|
+
* @name GetOwnershipsBySymbolData
|
|
6064
|
+
* @summary get ownerships by symbol data
|
|
6065
|
+
* @request POST:/symbol-ownerships
|
|
6066
|
+
* @secure
|
|
6067
|
+
*/
|
|
6068
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6069
|
+
}
|
|
6070
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6071
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6072
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6073
|
+
/**
|
|
6074
|
+
* @description Returns article by id
|
|
6075
|
+
* @tags Passport
|
|
6076
|
+
* @name PassportArticleById
|
|
6077
|
+
* @summary Get article by id
|
|
6078
|
+
* @request POST:/passport/article-by-id
|
|
6079
|
+
* @secure
|
|
6080
|
+
*/
|
|
6081
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6082
|
+
/**
|
|
6083
|
+
* @description Returns articles
|
|
6084
|
+
* @tags Passport
|
|
6085
|
+
* @name PassportArticles
|
|
6086
|
+
* @summary Get articles
|
|
6087
|
+
* @request POST:/passport/articles
|
|
6088
|
+
* @secure
|
|
6089
|
+
*/
|
|
6090
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6091
|
+
/**
|
|
6092
|
+
* @description Returns author profile
|
|
6093
|
+
* @tags Passport
|
|
6094
|
+
* @name PassportAuthorProfile
|
|
6095
|
+
* @summary Get author profile
|
|
6096
|
+
* @request POST:/passport/author-profile
|
|
6097
|
+
* @secure
|
|
6098
|
+
*/
|
|
6099
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6100
|
+
/**
|
|
6101
|
+
* @description Returns most popular tags
|
|
6102
|
+
* @tags Passport
|
|
6103
|
+
* @name PassportMostPopularTags
|
|
6104
|
+
* @summary Get most popular tags
|
|
6105
|
+
* @request POST:/passport/most-popular-tags
|
|
6106
|
+
* @secure
|
|
6107
|
+
*/
|
|
6108
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6109
|
+
/**
|
|
6110
|
+
* @description Returns news feed
|
|
6111
|
+
* @tags Passport
|
|
6112
|
+
* @name PassportNewsFeed
|
|
6113
|
+
* @summary Get news feed
|
|
6114
|
+
* @request POST:/passport/newsfeed
|
|
6115
|
+
* @secure
|
|
6116
|
+
*/
|
|
6117
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6118
|
+
/**
|
|
6119
|
+
* @description Returns article by parameters
|
|
6120
|
+
* @tags Passport
|
|
6121
|
+
* @name PassportSearchArticle
|
|
6122
|
+
* @summary Search article by parameters
|
|
6123
|
+
* @request POST:/passport/search-article
|
|
6124
|
+
* @secure
|
|
6125
|
+
*/
|
|
6126
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5929
6127
|
}
|
|
5930
6128
|
export interface InsightBeforeAndAfterV2 {
|
|
5931
6129
|
after?: string;
|