@orbis-systems/orbis-api-clients 0.2.0 → 0.2.1
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/index.d.ts +729 -729
- 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/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -267,7 +267,7 @@ export interface InsightArticlesRequest {
|
|
|
267
267
|
symbols?: string;
|
|
268
268
|
tag?: string;
|
|
269
269
|
tag_group?: string;
|
|
270
|
-
type?:
|
|
270
|
+
type?: InsightArticlesRequestTypeEnum;
|
|
271
271
|
}
|
|
272
272
|
export interface InsightAssetAllocationBreakdown {
|
|
273
273
|
breakdown: string;
|
|
@@ -449,7 +449,7 @@ export interface InsightCreateRegionRequest {
|
|
|
449
449
|
regions?: InsightRegion[];
|
|
450
450
|
}
|
|
451
451
|
export interface InsightCryptoLogoConvertedRequest {
|
|
452
|
-
conversion?:
|
|
452
|
+
conversion?: InsightCryptoLogoConvertedRequestConversionEnum;
|
|
453
453
|
symbol?: string;
|
|
454
454
|
}
|
|
455
455
|
export interface InsightCryptoLogosResponse {
|
|
@@ -1440,9 +1440,9 @@ export interface InsightMomentumRatioGraphResponse {
|
|
|
1440
1440
|
export interface InsightMostPopularTagsRequest {
|
|
1441
1441
|
/** (REQUIRE) */
|
|
1442
1442
|
language?: string;
|
|
1443
|
-
time?:
|
|
1443
|
+
time?: InsightMostPopularTagsRequestTimeEnum;
|
|
1444
1444
|
/** (REQUIRE) */
|
|
1445
|
-
type?:
|
|
1445
|
+
type?: InsightMostPopularTagsRequestTypeEnum;
|
|
1446
1446
|
}
|
|
1447
1447
|
export interface InsightMover {
|
|
1448
1448
|
company_name: string;
|
|
@@ -1572,7 +1572,7 @@ export interface InsightNewsfeedRequest {
|
|
|
1572
1572
|
released_before?: number;
|
|
1573
1573
|
symbol?: string;
|
|
1574
1574
|
tag?: string;
|
|
1575
|
-
type?:
|
|
1575
|
+
type?: InsightNewsfeedRequestTypeEnum;
|
|
1576
1576
|
with_tag_group?: string;
|
|
1577
1577
|
}
|
|
1578
1578
|
export interface InsightOptionData {
|
|
@@ -1597,7 +1597,7 @@ export interface InsightOptionValues {
|
|
|
1597
1597
|
}
|
|
1598
1598
|
export interface InsightOrdering {
|
|
1599
1599
|
/** @default "asc" */
|
|
1600
|
-
direction:
|
|
1600
|
+
direction: InsightOrderingDirectionEnum;
|
|
1601
1601
|
/**
|
|
1602
1602
|
* Sort direction:
|
|
1603
1603
|
* * asc - Ascending, from A to Z.
|
|
@@ -1640,7 +1640,7 @@ export interface InsightPerformingExpertsRatings {
|
|
|
1640
1640
|
ticker: string;
|
|
1641
1641
|
}
|
|
1642
1642
|
export interface InsightPeriodFilter {
|
|
1643
|
-
type?:
|
|
1643
|
+
type?: InsightPeriodFilterTypeEnum;
|
|
1644
1644
|
value?: number;
|
|
1645
1645
|
}
|
|
1646
1646
|
export interface InsightPortfoliosRequest {
|
|
@@ -1785,7 +1785,7 @@ export interface InsightSearchArticleRequest {
|
|
|
1785
1785
|
language?: string;
|
|
1786
1786
|
/** (REQUIRE) */
|
|
1787
1787
|
s?: string;
|
|
1788
|
-
type?:
|
|
1788
|
+
type?: InsightSearchArticleRequestTypeEnum;
|
|
1789
1789
|
}
|
|
1790
1790
|
export interface InsightSeasonalityEntry {
|
|
1791
1791
|
april: InsightTickerSeasonality;
|
|
@@ -1969,7 +1969,7 @@ export interface InsightSymbolIndustries {
|
|
|
1969
1969
|
sub_industry: string;
|
|
1970
1970
|
}
|
|
1971
1971
|
export interface InsightSymbolLogoConvertedRequest {
|
|
1972
|
-
conversion?:
|
|
1972
|
+
conversion?: InsightSymbolLogoConvertedRequestConversionEnum;
|
|
1973
1973
|
symbol?: string;
|
|
1974
1974
|
}
|
|
1975
1975
|
export interface InsightSymbolLogosResponse {
|
|
@@ -2261,11 +2261,11 @@ export interface InsightEquityDataResponse {
|
|
|
2261
2261
|
volume: number;
|
|
2262
2262
|
yest_close_px: number;
|
|
2263
2263
|
}
|
|
2264
|
-
export enum
|
|
2264
|
+
export enum InsightArticlesRequestTypeEnum {
|
|
2265
2265
|
Education = "education",
|
|
2266
2266
|
NonEducation = "non-education"
|
|
2267
2267
|
}
|
|
2268
|
-
export enum
|
|
2268
|
+
export enum InsightCryptoLogoConvertedRequestConversionEnum {
|
|
2269
2269
|
Original = "original",
|
|
2270
2270
|
Default = "default",
|
|
2271
2271
|
Normal = "normal",
|
|
@@ -2275,39 +2275,39 @@ export enum InsightInsightCryptoLogoConvertedRequestConversionEnum {
|
|
|
2275
2275
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
2276
2276
|
BestMatch = "best_match"
|
|
2277
2277
|
}
|
|
2278
|
-
export enum
|
|
2278
|
+
export enum InsightMostPopularTagsRequestTimeEnum {
|
|
2279
2279
|
Week = "week",
|
|
2280
2280
|
Month = "month",
|
|
2281
2281
|
Year = "year"
|
|
2282
2282
|
}
|
|
2283
2283
|
/** (REQUIRE) */
|
|
2284
|
-
export enum
|
|
2284
|
+
export enum InsightMostPopularTagsRequestTypeEnum {
|
|
2285
2285
|
Symbol = "symbol",
|
|
2286
2286
|
Primary = "primary",
|
|
2287
2287
|
Tags = "tags"
|
|
2288
2288
|
}
|
|
2289
|
-
export enum
|
|
2289
|
+
export enum InsightNewsfeedRequestTypeEnum {
|
|
2290
2290
|
Education = "education",
|
|
2291
2291
|
NonEducation = "non-education"
|
|
2292
2292
|
}
|
|
2293
2293
|
/** @default "asc" */
|
|
2294
|
-
export enum
|
|
2294
|
+
export enum InsightOrderingDirectionEnum {
|
|
2295
2295
|
Asc = "asc",
|
|
2296
2296
|
Desc = "desc"
|
|
2297
2297
|
}
|
|
2298
|
-
export enum
|
|
2298
|
+
export enum InsightPeriodFilterTypeEnum {
|
|
2299
2299
|
Day = "day",
|
|
2300
2300
|
Week = "week",
|
|
2301
2301
|
Month = "month",
|
|
2302
2302
|
Year = "year"
|
|
2303
2303
|
}
|
|
2304
|
-
export enum
|
|
2304
|
+
export enum InsightSearchArticleRequestTypeEnum {
|
|
2305
2305
|
All = "all",
|
|
2306
2306
|
Tag = "tag",
|
|
2307
2307
|
Primary = "primary",
|
|
2308
2308
|
Symbol = "symbol"
|
|
2309
2309
|
}
|
|
2310
|
-
export enum
|
|
2310
|
+
export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
2311
2311
|
Original = "original",
|
|
2312
2312
|
Default = "default",
|
|
2313
2313
|
Normal = "normal",
|
|
@@ -2332,28 +2332,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
2332
2332
|
Date = "date",
|
|
2333
2333
|
Rank = "rank"
|
|
2334
2334
|
}
|
|
2335
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
2336
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2337
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2338
|
-
/**
|
|
2339
|
-
* @description get seasonlity data with comparison to benchmark
|
|
2340
|
-
* @tags AlphaTools
|
|
2341
|
-
* @name GetMomentumRatioGraph
|
|
2342
|
-
* @summary get seasonlity data
|
|
2343
|
-
* @request POST:/rst
|
|
2344
|
-
* @secure
|
|
2345
|
-
*/
|
|
2346
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
2347
|
-
/**
|
|
2348
|
-
* @description get seasonlity data with comparison to benchmark
|
|
2349
|
-
* @tags AlphaTools
|
|
2350
|
-
* @name GetSeasonality
|
|
2351
|
-
* @summary get seasonlity data
|
|
2352
|
-
* @request POST:/seasonality
|
|
2353
|
-
* @secure
|
|
2354
|
-
*/
|
|
2355
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
2356
|
-
}
|
|
2357
2335
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
2358
2336
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2359
2337
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2393,6 +2371,190 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
2393
2371
|
*/
|
|
2394
2372
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
2395
2373
|
}
|
|
2374
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
2375
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2376
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2377
|
+
/**
|
|
2378
|
+
* @description Get continents
|
|
2379
|
+
* @tags World Markets
|
|
2380
|
+
* @name ContinentGet
|
|
2381
|
+
* @summary Get continents
|
|
2382
|
+
* @request GET:/continents
|
|
2383
|
+
* @secure
|
|
2384
|
+
*/
|
|
2385
|
+
continentGet(query: {
|
|
2386
|
+
/** Query limit */
|
|
2387
|
+
limit: number;
|
|
2388
|
+
/** Query offset */
|
|
2389
|
+
offset: number;
|
|
2390
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
2391
|
+
/**
|
|
2392
|
+
* @description Edit continent
|
|
2393
|
+
* @tags World Markets
|
|
2394
|
+
* @name ContinentEdit
|
|
2395
|
+
* @summary Edit continent
|
|
2396
|
+
* @request PUT:/continents
|
|
2397
|
+
* @secure
|
|
2398
|
+
*/
|
|
2399
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2400
|
+
/**
|
|
2401
|
+
* @description Create continents
|
|
2402
|
+
* @tags World Markets
|
|
2403
|
+
* @name ContinentCreate
|
|
2404
|
+
* @summary Create continents
|
|
2405
|
+
* @request POST:/continents
|
|
2406
|
+
* @secure
|
|
2407
|
+
*/
|
|
2408
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
2409
|
+
/**
|
|
2410
|
+
* @description Delete continent
|
|
2411
|
+
* @tags World Markets
|
|
2412
|
+
* @name ContinentDelete
|
|
2413
|
+
* @summary Delete continent
|
|
2414
|
+
* @request DELETE:/continents
|
|
2415
|
+
* @secure
|
|
2416
|
+
*/
|
|
2417
|
+
continentDelete(query: {
|
|
2418
|
+
/** continent id */
|
|
2419
|
+
id: string;
|
|
2420
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2421
|
+
/**
|
|
2422
|
+
* @description Get country codes
|
|
2423
|
+
* @tags World Markets
|
|
2424
|
+
* @name CountryCodeGet
|
|
2425
|
+
* @summary Get country codes
|
|
2426
|
+
* @request GET:/country-codes
|
|
2427
|
+
* @secure
|
|
2428
|
+
*/
|
|
2429
|
+
countryCodeGet(query: {
|
|
2430
|
+
/** Query limit */
|
|
2431
|
+
limit: number;
|
|
2432
|
+
/** Query offset */
|
|
2433
|
+
offset: number;
|
|
2434
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
2435
|
+
/**
|
|
2436
|
+
* @description Edit country code
|
|
2437
|
+
* @tags World Markets
|
|
2438
|
+
* @name CountryCodeEdit
|
|
2439
|
+
* @summary Edit country code
|
|
2440
|
+
* @request PUT:/country-codes
|
|
2441
|
+
* @secure
|
|
2442
|
+
*/
|
|
2443
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2444
|
+
/**
|
|
2445
|
+
* @description Add country codes
|
|
2446
|
+
* @tags World Markets
|
|
2447
|
+
* @name CountryCodeAdd
|
|
2448
|
+
* @summary Add country codes
|
|
2449
|
+
* @request POST:/country-codes
|
|
2450
|
+
* @secure
|
|
2451
|
+
*/
|
|
2452
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
2453
|
+
/**
|
|
2454
|
+
* @description Delete country code
|
|
2455
|
+
* @tags World Markets
|
|
2456
|
+
* @name CountryCodeDelete
|
|
2457
|
+
* @summary Delete country code
|
|
2458
|
+
* @request DELETE:/country-codes
|
|
2459
|
+
* @secure
|
|
2460
|
+
*/
|
|
2461
|
+
countryCodeDelete(query: {
|
|
2462
|
+
/** a3 code */
|
|
2463
|
+
a3code: string;
|
|
2464
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2465
|
+
/**
|
|
2466
|
+
* @description Get global indexes
|
|
2467
|
+
* @tags World Markets
|
|
2468
|
+
* @name GlobalIndexGet
|
|
2469
|
+
* @summary Get global indexes
|
|
2470
|
+
* @request GET:/global-indexes
|
|
2471
|
+
* @secure
|
|
2472
|
+
*/
|
|
2473
|
+
globalIndexGet(query: {
|
|
2474
|
+
/** Query limit */
|
|
2475
|
+
limit: number;
|
|
2476
|
+
/** Query offset */
|
|
2477
|
+
offset: number;
|
|
2478
|
+
/** Continent code for filtering */
|
|
2479
|
+
continent?: string;
|
|
2480
|
+
/** Quote type for price fetch */
|
|
2481
|
+
quote_access_type?: string;
|
|
2482
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
2483
|
+
/**
|
|
2484
|
+
* @description Edit global index
|
|
2485
|
+
* @tags World Markets
|
|
2486
|
+
* @name GlobalIndexEdit
|
|
2487
|
+
* @summary Edit global index
|
|
2488
|
+
* @request PUT:/global-indexes
|
|
2489
|
+
* @secure
|
|
2490
|
+
*/
|
|
2491
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2492
|
+
/**
|
|
2493
|
+
* @description Add global indexes
|
|
2494
|
+
* @tags World Markets
|
|
2495
|
+
* @name GlobalIndexAdd
|
|
2496
|
+
* @summary Add global indexes
|
|
2497
|
+
* @request POST:/global-indexes
|
|
2498
|
+
* @secure
|
|
2499
|
+
*/
|
|
2500
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
2501
|
+
/**
|
|
2502
|
+
* @description Edit global index
|
|
2503
|
+
* @tags World Markets
|
|
2504
|
+
* @name GlobalIndexDelete
|
|
2505
|
+
* @summary Delete global index
|
|
2506
|
+
* @request DELETE:/global-indexes
|
|
2507
|
+
* @secure
|
|
2508
|
+
*/
|
|
2509
|
+
globalIndexDelete(query: {
|
|
2510
|
+
/** a3 code */
|
|
2511
|
+
a3code: string;
|
|
2512
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2513
|
+
/**
|
|
2514
|
+
* @description Get regions
|
|
2515
|
+
* @tags World Markets
|
|
2516
|
+
* @name RegionGet
|
|
2517
|
+
* @summary Get regions
|
|
2518
|
+
* @request GET:/regions
|
|
2519
|
+
* @secure
|
|
2520
|
+
*/
|
|
2521
|
+
regionGet(query: {
|
|
2522
|
+
/** Query limit */
|
|
2523
|
+
limit: number;
|
|
2524
|
+
/** Query offset */
|
|
2525
|
+
offset: number;
|
|
2526
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
2527
|
+
/**
|
|
2528
|
+
* @description Edit region
|
|
2529
|
+
* @tags World Markets
|
|
2530
|
+
* @name RegionEdit
|
|
2531
|
+
* @summary Edit region
|
|
2532
|
+
* @request PUT:/regions
|
|
2533
|
+
* @secure
|
|
2534
|
+
*/
|
|
2535
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2536
|
+
/**
|
|
2537
|
+
* @description Create regions
|
|
2538
|
+
* @tags World Markets
|
|
2539
|
+
* @name RegionCreate
|
|
2540
|
+
* @summary Create regions
|
|
2541
|
+
* @request POST:/regions
|
|
2542
|
+
* @secure
|
|
2543
|
+
*/
|
|
2544
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
2545
|
+
/**
|
|
2546
|
+
* @description Delete region
|
|
2547
|
+
* @tags World Markets
|
|
2548
|
+
* @name RegionDelete
|
|
2549
|
+
* @summary Delete region
|
|
2550
|
+
* @request DELETE:/regions
|
|
2551
|
+
* @secure
|
|
2552
|
+
*/
|
|
2553
|
+
regionDelete(query: {
|
|
2554
|
+
/** region id */
|
|
2555
|
+
id: string;
|
|
2556
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2557
|
+
}
|
|
2396
2558
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
2397
2559
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2398
2560
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2456,6 +2618,19 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
2456
2618
|
offset: number;
|
|
2457
2619
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
2458
2620
|
}
|
|
2621
|
+
export class Lists<HandleError extends boolean = boolean> {
|
|
2622
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2623
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2624
|
+
/**
|
|
2625
|
+
* @description filter custom lists
|
|
2626
|
+
* @tags lists
|
|
2627
|
+
* @name FilterCustomLists
|
|
2628
|
+
* @summary filter custom lists
|
|
2629
|
+
* @request POST:/custom-lists/filter
|
|
2630
|
+
* @secure
|
|
2631
|
+
*/
|
|
2632
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
2633
|
+
}
|
|
2459
2634
|
export class Dashboard<HandleError extends boolean = boolean> {
|
|
2460
2635
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2461
2636
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2615,234 +2790,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
2615
2790
|
*/
|
|
2616
2791
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
2617
2792
|
}
|
|
2618
|
-
export
|
|
2619
|
-
|
|
2620
|
-
|
|
2621
|
-
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
|
|
2625
|
-
|
|
2626
|
-
|
|
2627
|
-
|
|
2628
|
-
|
|
2629
|
-
|
|
2630
|
-
bank_qualified: boolean;
|
|
2631
|
-
bond_warrant: boolean;
|
|
2632
|
-
call_type: string;
|
|
2633
|
-
callable: boolean;
|
|
2634
|
-
close_price: number;
|
|
2635
|
-
close_price_asof: string;
|
|
2636
|
-
close_ytw: number;
|
|
2637
|
-
convertible: boolean;
|
|
2638
|
-
country: string;
|
|
2639
|
-
country_code: string;
|
|
2640
|
-
country_domicile: string;
|
|
2641
|
-
country_issue: string;
|
|
2642
|
-
coupon: number;
|
|
2643
|
-
coupon_frequency: string;
|
|
2644
|
-
coupon_type: string;
|
|
2645
|
-
currency: string;
|
|
2646
|
-
cusip: string;
|
|
2647
|
-
dated_date: string;
|
|
2648
|
-
daycount: string;
|
|
2649
|
-
description: string;
|
|
2650
|
-
description_short: string;
|
|
2651
|
-
duration: number;
|
|
2652
|
-
first_coupon_date: string;
|
|
2653
|
-
insured: boolean;
|
|
2654
|
-
isin: string;
|
|
2655
|
-
issue_date: string;
|
|
2656
|
-
issue_minimum_denomination: number;
|
|
2657
|
-
issue_price: number;
|
|
2658
|
-
issue_size: number;
|
|
2659
|
-
issuer: string;
|
|
2660
|
-
last_coupon_date: string;
|
|
2661
|
-
liquidity_institutional_aggregate: number;
|
|
2662
|
-
liquidity_institutional_buy: number;
|
|
2663
|
-
liquidity_institutional_sell: number;
|
|
2664
|
-
liquidity_micro_aggregate: number;
|
|
2665
|
-
liquidity_micro_buy: number;
|
|
2666
|
-
liquidity_micro_sell: number;
|
|
2667
|
-
liquidity_retail_aggregate: number;
|
|
2668
|
-
liquidity_retail_buy: number;
|
|
2669
|
-
liquidity_retail_sell: number;
|
|
2670
|
-
maturity_date: string;
|
|
2671
|
-
municipal_state: string;
|
|
2672
|
-
municipal_taxable_federal: boolean;
|
|
2673
|
-
municipal_type: string;
|
|
2674
|
-
next_call_date: string;
|
|
2675
|
-
next_call_price: number;
|
|
2676
|
-
next_coupon_date: string;
|
|
2677
|
-
par_value: number;
|
|
2678
|
-
perpetual: boolean;
|
|
2679
|
-
private_placement: boolean;
|
|
2680
|
-
purpose: string;
|
|
2681
|
-
puttable: boolean;
|
|
2682
|
-
reg_s: boolean;
|
|
2683
|
-
sector: string;
|
|
2684
|
-
seniority: string;
|
|
2685
|
-
settlement_convention: string;
|
|
2686
|
-
sinking_fund: boolean;
|
|
2687
|
-
sp_creditwatch: string;
|
|
2688
|
-
sp_creditwatch_date: string;
|
|
2689
|
-
sp_outlook: string;
|
|
2690
|
-
sp_outlook_date: string;
|
|
2691
|
-
sp_rating: string;
|
|
2692
|
-
sp_rating_date: string;
|
|
2693
|
-
status: string;
|
|
2694
|
-
ticker: string;
|
|
2695
|
-
treasury_subtype: string;
|
|
2696
|
-
type: string;
|
|
2697
|
-
updated_at: string;
|
|
2698
|
-
}
|
|
2699
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
2700
|
-
bank_qualified?: boolean;
|
|
2701
|
-
callable?: boolean;
|
|
2702
|
-
convertible?: boolean;
|
|
2703
|
-
country_codes?: string[];
|
|
2704
|
-
coupon?: InsightLessAndMoreV2;
|
|
2705
|
-
coupon_frequencies?: string[];
|
|
2706
|
-
cusip?: string[];
|
|
2707
|
-
description?: string;
|
|
2708
|
-
has_ticker?: boolean;
|
|
2709
|
-
insured?: boolean;
|
|
2710
|
-
isin?: string[];
|
|
2711
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
2712
|
-
issuer?: string;
|
|
2713
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
2714
|
-
municipal_states?: string[];
|
|
2715
|
-
municipal_tax?: boolean;
|
|
2716
|
-
municipal_types?: string[];
|
|
2717
|
-
order?: InsightOrderingV2;
|
|
2718
|
-
pagination?: InsightPaginationV2;
|
|
2719
|
-
paging?: InsightPagingV2;
|
|
2720
|
-
purposes?: string[];
|
|
2721
|
-
sectors?: string[];
|
|
2722
|
-
sorts?: InsightOrderingV2[];
|
|
2723
|
-
sp_ratings?: string[];
|
|
2724
|
-
statuses?: string[];
|
|
2725
|
-
tickers?: string[];
|
|
2726
|
-
types?: string[];
|
|
2727
|
-
}
|
|
2728
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
2729
|
-
count: number;
|
|
2730
|
-
data: InsightFixedIncomeV2[];
|
|
2731
|
-
}
|
|
2732
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
2733
|
-
exchange?: string[];
|
|
2734
|
-
market_cap?: InsightLessAndMoreV2;
|
|
2735
|
-
order?: InsightOrderingV2;
|
|
2736
|
-
pagination?: InsightPaginationV2;
|
|
2737
|
-
paging?: InsightPagingV2;
|
|
2738
|
-
price?: InsightLessAndMoreV2;
|
|
2739
|
-
quote_access_type?: string;
|
|
2740
|
-
sorts?: InsightOrderingV2[];
|
|
2741
|
-
volume?: InsightLessAndMoreV2;
|
|
2742
|
-
}
|
|
2743
|
-
export interface InsightIncludeExcludeV2 {
|
|
2744
|
-
exclude: string[];
|
|
2745
|
-
include: string[];
|
|
2746
|
-
}
|
|
2747
|
-
export interface InsightLessAndMoreV2 {
|
|
2748
|
-
less_than: number;
|
|
2749
|
-
more_than: number;
|
|
2750
|
-
}
|
|
2751
|
-
export interface InsightOrderingV2 {
|
|
2752
|
-
/** @default "asc" */
|
|
2753
|
-
direction: InsightInsightOrderingV2DirectionEnumV2;
|
|
2754
|
-
/**
|
|
2755
|
-
* Sort direction:
|
|
2756
|
-
* * asc - Ascending, from A to Z.
|
|
2757
|
-
* * desc - Descending, from Z to A.
|
|
2758
|
-
*/
|
|
2759
|
-
field: string;
|
|
2760
|
-
}
|
|
2761
|
-
export interface InsightPaginationV2 {
|
|
2762
|
-
page: number;
|
|
2763
|
-
size: number;
|
|
2764
|
-
}
|
|
2765
|
-
export interface InsightPagingV2 {
|
|
2766
|
-
limit: number;
|
|
2767
|
-
offset: number;
|
|
2768
|
-
}
|
|
2769
|
-
export interface InsightStockMarketHeatmapResponseV2 {
|
|
2770
|
-
details: InsightStockMarketHeatmapEntryV2[];
|
|
2771
|
-
max_change: number;
|
|
2772
|
-
min_change: number;
|
|
2773
|
-
}
|
|
2774
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
2775
|
-
average_volume_30d: number;
|
|
2776
|
-
company_name: string;
|
|
2777
|
-
dividend_ex_date: string;
|
|
2778
|
-
dividend_pay_date: string;
|
|
2779
|
-
dividend_percent: number;
|
|
2780
|
-
exchange: string;
|
|
2781
|
-
exchange_name: string;
|
|
2782
|
-
gap: number;
|
|
2783
|
-
industry: string;
|
|
2784
|
-
industry_code: string;
|
|
2785
|
-
last_price: number;
|
|
2786
|
-
market_cap: number;
|
|
2787
|
-
pe_ratio: number;
|
|
2788
|
-
price_change: number;
|
|
2789
|
-
price_change_percent: number;
|
|
2790
|
-
symbol: string;
|
|
2791
|
-
volume: number;
|
|
2792
|
-
}
|
|
2793
|
-
export interface InsightStockScreenerRequestV2 {
|
|
2794
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
2795
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
2796
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
2797
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
2798
|
-
exchange?: InsightIncludeExcludeV2;
|
|
2799
|
-
gap?: InsightLessAndMoreV2;
|
|
2800
|
-
industry?: InsightIncludeExcludeV2;
|
|
2801
|
-
market_cap?: InsightLessAndMoreV2;
|
|
2802
|
-
order?: InsightOrderingV2;
|
|
2803
|
-
pagination?: InsightPaginationV2;
|
|
2804
|
-
paging?: InsightPagingV2;
|
|
2805
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
2806
|
-
price?: InsightLessAndMoreV2;
|
|
2807
|
-
quote_access_type?: string;
|
|
2808
|
-
sorts?: InsightOrderingV2[];
|
|
2809
|
-
stock_type?: string;
|
|
2810
|
-
volume?: InsightLessAndMoreV2;
|
|
2811
|
-
}
|
|
2812
|
-
export interface InsightStockScreenerResponseV2 {
|
|
2813
|
-
count: number;
|
|
2814
|
-
details: InsightStockScreenerQuoteV2[];
|
|
2815
|
-
}
|
|
2816
|
-
/** @default "asc" */
|
|
2817
|
-
export enum InsightInsightOrderingV2DirectionEnumV2 {
|
|
2818
|
-
Asc = "asc",
|
|
2819
|
-
Desc = "desc"
|
|
2820
|
-
}
|
|
2821
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
2822
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2823
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2824
|
-
/**
|
|
2825
|
-
* @description get fixed income entries
|
|
2826
|
-
* @tags FixedIncome
|
|
2827
|
-
* @name GetFixedIncomeEntries
|
|
2828
|
-
* @summary get fixed income entries
|
|
2829
|
-
* @request POST:/fixed-income
|
|
2830
|
-
* @secure
|
|
2831
|
-
*/
|
|
2832
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
2833
|
-
}
|
|
2834
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
2835
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2836
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2837
|
-
/**
|
|
2838
|
-
* @description get fundamentals by symbol data
|
|
2839
|
-
* @tags Fundamentals
|
|
2840
|
-
* @name GetFundamentalsBySymbolData
|
|
2841
|
-
* @summary get fundamentals by symbol data
|
|
2842
|
-
* @request POST:/fundamentals
|
|
2843
|
-
* @secure
|
|
2844
|
-
*/
|
|
2845
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
|
|
2793
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
2794
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2795
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2796
|
+
/**
|
|
2797
|
+
* @description get fundamentals by symbol data
|
|
2798
|
+
* @tags Fundamentals
|
|
2799
|
+
* @name GetFundamentalsBySymbolData
|
|
2800
|
+
* @summary get fundamentals by symbol data
|
|
2801
|
+
* @request POST:/fundamentals
|
|
2802
|
+
* @secure
|
|
2803
|
+
*/
|
|
2804
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
|
|
2846
2805
|
}
|
|
2847
2806
|
export class Funds<HandleError extends boolean = boolean> {
|
|
2848
2807
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2917,58 +2876,187 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
2917
2876
|
Authorization?: string;
|
|
2918
2877
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
2919
2878
|
}
|
|
2920
|
-
export class
|
|
2879
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
2921
2880
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2922
2881
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2923
2882
|
/**
|
|
2924
|
-
* @description
|
|
2925
|
-
* @tags
|
|
2926
|
-
* @name
|
|
2927
|
-
* @summary
|
|
2928
|
-
* @request
|
|
2883
|
+
* @description data for visual heat map
|
|
2884
|
+
* @tags StockScreener
|
|
2885
|
+
* @name StockMarketHeatmap
|
|
2886
|
+
* @summary data for visual heat map
|
|
2887
|
+
* @request GET:/heatmaps
|
|
2929
2888
|
* @secure
|
|
2930
2889
|
*/
|
|
2931
|
-
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2890
|
+
stockMarketHeatmap(query: {
|
|
2891
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
2892
|
+
heatmap_name?: string;
|
|
2893
|
+
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
2894
|
+
quote_access_type: string;
|
|
2895
|
+
}, headers?: {
|
|
2896
|
+
/** Authorization */
|
|
2897
|
+
Authorization?: string;
|
|
2898
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
2936
2899
|
/**
|
|
2937
|
-
* @description
|
|
2938
|
-
* @tags
|
|
2939
|
-
* @name
|
|
2940
|
-
* @summary
|
|
2941
|
-
* @request POST:/
|
|
2900
|
+
* @description create or update heat map preset
|
|
2901
|
+
* @tags StockScreener
|
|
2902
|
+
* @name CreateStockMarketHeatmapPreset
|
|
2903
|
+
* @summary create or update heat map preset
|
|
2904
|
+
* @request POST:/heatmaps
|
|
2942
2905
|
* @secure
|
|
2943
2906
|
*/
|
|
2944
|
-
|
|
2907
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2945
2908
|
/**
|
|
2946
|
-
* @description
|
|
2947
|
-
* @tags
|
|
2948
|
-
* @name
|
|
2949
|
-
* @summary get
|
|
2950
|
-
* @request
|
|
2909
|
+
* @description Sector and Industry Group performance
|
|
2910
|
+
* @tags StockScreener
|
|
2911
|
+
* @name IndustriesPerformance
|
|
2912
|
+
* @summary get industries performance
|
|
2913
|
+
* @request POST:/industries-performance
|
|
2951
2914
|
* @secure
|
|
2952
2915
|
*/
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
|
|
2956
|
-
|
|
2957
|
-
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
|
|
2916
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2917
|
+
/**
|
|
2918
|
+
* @description filter stocks by params
|
|
2919
|
+
* @tags StockScreener
|
|
2920
|
+
* @name StockScreener
|
|
2921
|
+
* @summary filter stocks by params
|
|
2922
|
+
* @request POST:/stock-screener
|
|
2923
|
+
* @secure
|
|
2924
|
+
*/
|
|
2925
|
+
stockScreener(filter: InsightStockScreenerRequest, headers?: {
|
|
2926
|
+
/** Authorization */
|
|
2927
|
+
Authorization?: string;
|
|
2928
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
2929
|
+
/**
|
|
2930
|
+
* @description get screener presets
|
|
2931
|
+
* @tags StockScreener
|
|
2932
|
+
* @name GetScreenerPresets
|
|
2933
|
+
* @summary get screener presets
|
|
2934
|
+
* @request GET:/stock-screener/presets
|
|
2935
|
+
* @secure
|
|
2936
|
+
*/
|
|
2937
|
+
getScreenerPresets(query: {
|
|
2938
|
+
/** how many records to return */
|
|
2939
|
+
limit: number;
|
|
2940
|
+
/** how many records to skip */
|
|
2941
|
+
offset: number;
|
|
2942
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2943
|
+
/**
|
|
2944
|
+
* @description update screener preset
|
|
2945
|
+
* @tags StockScreener
|
|
2946
|
+
* @name UpdateScreenerPreset
|
|
2947
|
+
* @summary update screener preset
|
|
2948
|
+
* @request PUT:/stock-screener/presets
|
|
2949
|
+
* @secure
|
|
2950
|
+
*/
|
|
2951
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2952
|
+
/**
|
|
2953
|
+
* @description create screener preset
|
|
2954
|
+
* @tags StockScreener
|
|
2955
|
+
* @name CreateOrScreenerPreset
|
|
2956
|
+
* @summary create screener preset
|
|
2957
|
+
* @request POST:/stock-screener/presets
|
|
2958
|
+
* @secure
|
|
2959
|
+
*/
|
|
2960
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2961
|
+
/**
|
|
2962
|
+
* @description remove screener preset
|
|
2963
|
+
* @tags StockScreener
|
|
2964
|
+
* @name RemoveScreenerPreset
|
|
2965
|
+
* @summary remove screener preset
|
|
2966
|
+
* @request DELETE:/stock-screener/presets
|
|
2967
|
+
* @secure
|
|
2968
|
+
*/
|
|
2969
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
2970
|
+
/**
|
|
2971
|
+
* @description get top symbols
|
|
2972
|
+
* @tags StockScreener
|
|
2973
|
+
* @name GetTopSymbols
|
|
2974
|
+
* @summary get top symbols
|
|
2975
|
+
* @request POST:/stock-screener/top
|
|
2976
|
+
* @secure
|
|
2977
|
+
*/
|
|
2978
|
+
getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
2979
|
+
}
|
|
2980
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
2961
2981
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2962
2982
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2963
2983
|
/**
|
|
2964
|
-
* @description
|
|
2965
|
-
* @tags
|
|
2966
|
-
* @name
|
|
2967
|
-
* @summary
|
|
2968
|
-
* @request
|
|
2984
|
+
* @description Get single historical quote
|
|
2985
|
+
* @tags Quotes
|
|
2986
|
+
* @name GitHistoricalQuote
|
|
2987
|
+
* @summary Get single historical quote
|
|
2988
|
+
* @request GET:/historical/quote
|
|
2969
2989
|
* @secure
|
|
2970
2990
|
*/
|
|
2971
|
-
|
|
2991
|
+
gitHistoricalQuote(query: {
|
|
2992
|
+
/** Symbol */
|
|
2993
|
+
symbol: string;
|
|
2994
|
+
/** Date */
|
|
2995
|
+
date: string;
|
|
2996
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
2997
|
+
/**
|
|
2998
|
+
* @description get quote history by symbol
|
|
2999
|
+
* @tags Quotes
|
|
3000
|
+
* @name GitQuoteHistory
|
|
3001
|
+
* @summary Get quote history
|
|
3002
|
+
* @request POST:/quote-history
|
|
3003
|
+
* @secure
|
|
3004
|
+
*/
|
|
3005
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
3006
|
+
/**
|
|
3007
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
3008
|
+
* @tags Quotes
|
|
3009
|
+
* @name GetQuotesEquityData
|
|
3010
|
+
* @summary Get Quotes Equity data
|
|
3011
|
+
* @request GET:/quotes/equity
|
|
3012
|
+
* @secure
|
|
3013
|
+
*/
|
|
3014
|
+
getQuotesEquityData(query: {
|
|
3015
|
+
/** Comma separated symbols */
|
|
3016
|
+
symbols: string;
|
|
3017
|
+
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3018
|
+
quote_access_type: string;
|
|
3019
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
3020
|
+
}
|
|
3021
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
3022
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3023
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3024
|
+
/**
|
|
3025
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
3026
|
+
* @tags Intraday
|
|
3027
|
+
* @name IntradayQuotes
|
|
3028
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
3029
|
+
* @request POST:/intraday/quotes
|
|
3030
|
+
* @secure
|
|
3031
|
+
*/
|
|
3032
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
3033
|
+
}
|
|
3034
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
3035
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3036
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3037
|
+
/**
|
|
3038
|
+
* @description get recent ipos info
|
|
3039
|
+
* @tags Ipos
|
|
3040
|
+
* @name RecentCreate
|
|
3041
|
+
* @summary get recent ipos info
|
|
3042
|
+
* @request POST:/ipos/recent
|
|
3043
|
+
* @secure
|
|
3044
|
+
*/
|
|
3045
|
+
recentCreate(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
3046
|
+
/**
|
|
3047
|
+
* @description get upcoming ipos info
|
|
3048
|
+
* @tags Ipos
|
|
3049
|
+
* @name UpcomingList
|
|
3050
|
+
* @summary get upcoming ipos info
|
|
3051
|
+
* @request GET:/ipos/upcoming
|
|
3052
|
+
* @secure
|
|
3053
|
+
*/
|
|
3054
|
+
upcomingList(query: {
|
|
3055
|
+
/** how many records to return. Max value is 50 */
|
|
3056
|
+
limit: number;
|
|
3057
|
+
/** how many records to skip */
|
|
3058
|
+
offset: number;
|
|
3059
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
2972
3060
|
}
|
|
2973
3061
|
export class Logos<HandleError extends boolean = boolean> {
|
|
2974
3062
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3359,203 +3447,61 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
3359
3447
|
offset: number;
|
|
3360
3448
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
3361
3449
|
}
|
|
3362
|
-
export class
|
|
3450
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
3363
3451
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3364
3452
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3365
3453
|
/**
|
|
3366
|
-
* @description
|
|
3367
|
-
* @tags
|
|
3368
|
-
* @name
|
|
3369
|
-
* @summary
|
|
3370
|
-
* @request
|
|
3371
|
-
* @secure
|
|
3372
|
-
*/
|
|
3373
|
-
gitHistoricalQuote(query: {
|
|
3374
|
-
/** Symbol */
|
|
3375
|
-
symbol: string;
|
|
3376
|
-
/** Date */
|
|
3377
|
-
date: string;
|
|
3378
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
3379
|
-
/**
|
|
3380
|
-
* @description get quote history by symbol
|
|
3381
|
-
* @tags Quotes
|
|
3382
|
-
* @name GitQuoteHistory
|
|
3383
|
-
* @summary Get quote history
|
|
3384
|
-
* @request POST:/quote-history
|
|
3454
|
+
* @description get seasonlity data with comparison to benchmark
|
|
3455
|
+
* @tags AlphaTools
|
|
3456
|
+
* @name GetMomentumRatioGraph
|
|
3457
|
+
* @summary get seasonlity data
|
|
3458
|
+
* @request POST:/rst
|
|
3385
3459
|
* @secure
|
|
3386
3460
|
*/
|
|
3387
|
-
|
|
3461
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
3388
3462
|
/**
|
|
3389
|
-
* @description
|
|
3390
|
-
* @tags
|
|
3391
|
-
* @name
|
|
3392
|
-
* @summary
|
|
3393
|
-
* @request
|
|
3463
|
+
* @description get seasonlity data with comparison to benchmark
|
|
3464
|
+
* @tags AlphaTools
|
|
3465
|
+
* @name GetSeasonality
|
|
3466
|
+
* @summary get seasonlity data
|
|
3467
|
+
* @request POST:/seasonality
|
|
3394
3468
|
* @secure
|
|
3395
3469
|
*/
|
|
3396
|
-
|
|
3397
|
-
/** Comma separated symbols */
|
|
3398
|
-
symbols: string;
|
|
3399
|
-
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3400
|
-
quote_access_type: string;
|
|
3401
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
3470
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
3402
3471
|
}
|
|
3403
|
-
export class
|
|
3472
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
3404
3473
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3405
3474
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3406
3475
|
/**
|
|
3407
|
-
* @description
|
|
3408
|
-
* @tags
|
|
3409
|
-
* @name
|
|
3410
|
-
* @summary
|
|
3411
|
-
* @request
|
|
3412
|
-
* @secure
|
|
3413
|
-
*/
|
|
3414
|
-
stockMarketHeatmap(query: {
|
|
3415
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
3416
|
-
heatmap_name?: string;
|
|
3417
|
-
/** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
|
|
3418
|
-
quote_access_type: string;
|
|
3419
|
-
}, headers?: {
|
|
3420
|
-
/** Authorization */
|
|
3421
|
-
Authorization?: string;
|
|
3422
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
3423
|
-
/**
|
|
3424
|
-
* @description create or update heat map preset
|
|
3425
|
-
* @tags StockScreener
|
|
3426
|
-
* @name CreateStockMarketHeatmapPreset
|
|
3427
|
-
* @summary create or update heat map preset
|
|
3428
|
-
* @request POST:/heatmaps
|
|
3476
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
3477
|
+
* @tags TipRank
|
|
3478
|
+
* @name TiprankAnalystConsensus
|
|
3479
|
+
* @summary Get tiprank AnalystConsensus
|
|
3480
|
+
* @request POST:/tipranks/analyst-consensus
|
|
3429
3481
|
* @secure
|
|
3430
3482
|
*/
|
|
3431
|
-
|
|
3483
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
3432
3484
|
/**
|
|
3433
|
-
* @description
|
|
3434
|
-
* @tags
|
|
3435
|
-
* @name
|
|
3436
|
-
* @summary
|
|
3437
|
-
* @request POST:/
|
|
3485
|
+
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
3486
|
+
* @tags TipRank
|
|
3487
|
+
* @name TiprankLatestAnalystRatingsOnStock
|
|
3488
|
+
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
3489
|
+
* @request POST:/tipranks/analyst-multi
|
|
3438
3490
|
* @secure
|
|
3439
3491
|
*/
|
|
3440
|
-
|
|
3492
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
3441
3493
|
/**
|
|
3442
|
-
* @description
|
|
3443
|
-
* @tags
|
|
3444
|
-
* @name
|
|
3445
|
-
* @summary
|
|
3446
|
-
* @request POST:/
|
|
3494
|
+
* @description Returns the latest analyst portfolio items.
|
|
3495
|
+
* @tags TipRank
|
|
3496
|
+
* @name TiprankPortfolios
|
|
3497
|
+
* @summary Get the latest analyst portfolio items
|
|
3498
|
+
* @request POST:/tipranks/analyst-portfolio
|
|
3447
3499
|
* @secure
|
|
3448
3500
|
*/
|
|
3449
|
-
|
|
3501
|
+
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
3450
3502
|
/** Authorization */
|
|
3451
3503
|
Authorization?: string;
|
|
3452
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3453
|
-
/**
|
|
3454
|
-
* @description get screener presets
|
|
3455
|
-
* @tags StockScreener
|
|
3456
|
-
* @name GetScreenerPresets
|
|
3457
|
-
* @summary get screener presets
|
|
3458
|
-
* @request GET:/stock-screener/presets
|
|
3459
|
-
* @secure
|
|
3460
|
-
*/
|
|
3461
|
-
getScreenerPresets(query: {
|
|
3462
|
-
/** how many records to return */
|
|
3463
|
-
limit: number;
|
|
3464
|
-
/** how many records to skip */
|
|
3465
|
-
offset: number;
|
|
3466
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3467
|
-
/**
|
|
3468
|
-
* @description update screener preset
|
|
3469
|
-
* @tags StockScreener
|
|
3470
|
-
* @name UpdateScreenerPreset
|
|
3471
|
-
* @summary update screener preset
|
|
3472
|
-
* @request PUT:/stock-screener/presets
|
|
3473
|
-
* @secure
|
|
3474
|
-
*/
|
|
3475
|
-
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3476
|
-
/**
|
|
3477
|
-
* @description create screener preset
|
|
3478
|
-
* @tags StockScreener
|
|
3479
|
-
* @name CreateOrScreenerPreset
|
|
3480
|
-
* @summary create screener preset
|
|
3481
|
-
* @request POST:/stock-screener/presets
|
|
3482
|
-
* @secure
|
|
3483
|
-
*/
|
|
3484
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3485
|
-
/**
|
|
3486
|
-
* @description remove screener preset
|
|
3487
|
-
* @tags StockScreener
|
|
3488
|
-
* @name RemoveScreenerPreset
|
|
3489
|
-
* @summary remove screener preset
|
|
3490
|
-
* @request DELETE:/stock-screener/presets
|
|
3491
|
-
* @secure
|
|
3492
|
-
*/
|
|
3493
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3494
|
-
/**
|
|
3495
|
-
* @description get top symbols
|
|
3496
|
-
* @tags StockScreener
|
|
3497
|
-
* @name GetTopSymbols
|
|
3498
|
-
* @summary get top symbols
|
|
3499
|
-
* @request POST:/stock-screener/top
|
|
3500
|
-
* @secure
|
|
3501
|
-
*/
|
|
3502
|
-
getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
3503
|
-
}
|
|
3504
|
-
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
3505
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3506
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3507
|
-
/**
|
|
3508
|
-
* @description filter stocks by params
|
|
3509
|
-
* @tags StockScreener
|
|
3510
|
-
* @name StockScreener
|
|
3511
|
-
* @summary filter stocks by params
|
|
3512
|
-
* @request POST:/stock-screener
|
|
3513
|
-
* @secure
|
|
3514
|
-
*/
|
|
3515
|
-
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
3516
|
-
/**
|
|
3517
|
-
* @description get top symbols
|
|
3518
|
-
* @tags StockScreener
|
|
3519
|
-
* @name GetTopSymbols
|
|
3520
|
-
* @summary get top symbols
|
|
3521
|
-
* @request POST:/stock-screener/top
|
|
3522
|
-
* @secure
|
|
3523
|
-
*/
|
|
3524
|
-
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponseV2, HandleError>>;
|
|
3525
|
-
}
|
|
3526
|
-
export class TipRank<HandleError extends boolean = boolean> {
|
|
3527
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3528
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3529
|
-
/**
|
|
3530
|
-
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
3531
|
-
* @tags TipRank
|
|
3532
|
-
* @name TiprankAnalystConsensus
|
|
3533
|
-
* @summary Get tiprank AnalystConsensus
|
|
3534
|
-
* @request POST:/tipranks/analyst-consensus
|
|
3535
|
-
* @secure
|
|
3536
|
-
*/
|
|
3537
|
-
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
3538
|
-
/**
|
|
3539
|
-
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
3540
|
-
* @tags TipRank
|
|
3541
|
-
* @name TiprankLatestAnalystRatingsOnStock
|
|
3542
|
-
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
3543
|
-
* @request POST:/tipranks/analyst-multi
|
|
3544
|
-
* @secure
|
|
3545
|
-
*/
|
|
3546
|
-
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
3547
|
-
/**
|
|
3548
|
-
* @description Returns the latest analyst portfolio items.
|
|
3549
|
-
* @tags TipRank
|
|
3550
|
-
* @name TiprankPortfolios
|
|
3551
|
-
* @summary Get the latest analyst portfolio items
|
|
3552
|
-
* @request POST:/tipranks/analyst-portfolio
|
|
3553
|
-
* @secure
|
|
3554
|
-
*/
|
|
3555
|
-
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
3556
|
-
/** Authorization */
|
|
3557
|
-
Authorization?: string;
|
|
3558
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
3504
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
3559
3505
|
/**
|
|
3560
3506
|
* @description Returns the analyst profile information
|
|
3561
3507
|
* @tags TipRank
|
|
@@ -3902,189 +3848,243 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
3902
3848
|
*/
|
|
3903
3849
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
3904
3850
|
}
|
|
3905
|
-
export
|
|
3906
|
-
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
|
|
3910
|
-
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
3914
|
-
|
|
3915
|
-
|
|
3916
|
-
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
|
|
3920
|
-
|
|
3921
|
-
|
|
3922
|
-
|
|
3923
|
-
|
|
3924
|
-
|
|
3925
|
-
|
|
3926
|
-
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
|
|
3930
|
-
|
|
3931
|
-
|
|
3932
|
-
|
|
3933
|
-
|
|
3934
|
-
|
|
3935
|
-
|
|
3936
|
-
|
|
3937
|
-
|
|
3938
|
-
|
|
3939
|
-
|
|
3940
|
-
|
|
3941
|
-
|
|
3942
|
-
|
|
3943
|
-
|
|
3944
|
-
|
|
3945
|
-
|
|
3946
|
-
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
|
|
3952
|
-
|
|
3953
|
-
|
|
3954
|
-
|
|
3955
|
-
|
|
3956
|
-
|
|
3957
|
-
|
|
3958
|
-
|
|
3959
|
-
|
|
3960
|
-
|
|
3961
|
-
|
|
3962
|
-
|
|
3963
|
-
|
|
3964
|
-
|
|
3965
|
-
|
|
3966
|
-
|
|
3967
|
-
|
|
3968
|
-
|
|
3969
|
-
|
|
3970
|
-
|
|
3971
|
-
|
|
3972
|
-
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
|
|
3976
|
-
|
|
3977
|
-
|
|
3978
|
-
|
|
3979
|
-
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
3984
|
-
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
|
|
3988
|
-
|
|
3989
|
-
|
|
3990
|
-
|
|
3991
|
-
|
|
3992
|
-
|
|
3993
|
-
|
|
3994
|
-
|
|
3995
|
-
|
|
3996
|
-
|
|
3997
|
-
|
|
3998
|
-
|
|
3999
|
-
|
|
4000
|
-
|
|
4001
|
-
|
|
4002
|
-
|
|
4003
|
-
|
|
4004
|
-
|
|
4005
|
-
|
|
4006
|
-
|
|
4007
|
-
|
|
4008
|
-
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
|
|
4012
|
-
|
|
4013
|
-
|
|
4014
|
-
|
|
4015
|
-
|
|
4016
|
-
|
|
4017
|
-
|
|
4018
|
-
|
|
4019
|
-
|
|
4020
|
-
|
|
4021
|
-
|
|
4022
|
-
|
|
4023
|
-
|
|
4024
|
-
|
|
4025
|
-
|
|
4026
|
-
|
|
4027
|
-
|
|
4028
|
-
|
|
4029
|
-
|
|
4030
|
-
|
|
4031
|
-
|
|
4032
|
-
|
|
4033
|
-
|
|
4034
|
-
|
|
4035
|
-
|
|
4036
|
-
|
|
4037
|
-
|
|
4038
|
-
|
|
4039
|
-
|
|
4040
|
-
|
|
4041
|
-
/** a3 code */
|
|
4042
|
-
a3code: string;
|
|
4043
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
3851
|
+
export interface InsightStockMarketHeatmapEntryV2 {
|
|
3852
|
+
price_change_percent: number;
|
|
3853
|
+
symbol: string;
|
|
3854
|
+
title: string;
|
|
3855
|
+
}
|
|
3856
|
+
export interface InsightBeforeAndAfterV2 {
|
|
3857
|
+
after: string;
|
|
3858
|
+
before: string;
|
|
3859
|
+
}
|
|
3860
|
+
export interface InsightFixedIncomeV2 {
|
|
3861
|
+
a144: boolean;
|
|
3862
|
+
accrued_interest: number;
|
|
3863
|
+
bank_qualified: boolean;
|
|
3864
|
+
bond_warrant: boolean;
|
|
3865
|
+
call_type: string;
|
|
3866
|
+
callable: boolean;
|
|
3867
|
+
close_price: number;
|
|
3868
|
+
close_price_asof: string;
|
|
3869
|
+
close_ytw: number;
|
|
3870
|
+
convertible: boolean;
|
|
3871
|
+
country: string;
|
|
3872
|
+
country_code: string;
|
|
3873
|
+
country_domicile: string;
|
|
3874
|
+
country_issue: string;
|
|
3875
|
+
coupon: number;
|
|
3876
|
+
coupon_frequency: string;
|
|
3877
|
+
coupon_type: string;
|
|
3878
|
+
currency: string;
|
|
3879
|
+
cusip: string;
|
|
3880
|
+
dated_date: string;
|
|
3881
|
+
daycount: string;
|
|
3882
|
+
description: string;
|
|
3883
|
+
description_short: string;
|
|
3884
|
+
duration: number;
|
|
3885
|
+
first_coupon_date: string;
|
|
3886
|
+
insured: boolean;
|
|
3887
|
+
isin: string;
|
|
3888
|
+
issue_date: string;
|
|
3889
|
+
issue_minimum_denomination: number;
|
|
3890
|
+
issue_price: number;
|
|
3891
|
+
issue_size: number;
|
|
3892
|
+
issuer: string;
|
|
3893
|
+
last_coupon_date: string;
|
|
3894
|
+
liquidity_institutional_aggregate: number;
|
|
3895
|
+
liquidity_institutional_buy: number;
|
|
3896
|
+
liquidity_institutional_sell: number;
|
|
3897
|
+
liquidity_micro_aggregate: number;
|
|
3898
|
+
liquidity_micro_buy: number;
|
|
3899
|
+
liquidity_micro_sell: number;
|
|
3900
|
+
liquidity_retail_aggregate: number;
|
|
3901
|
+
liquidity_retail_buy: number;
|
|
3902
|
+
liquidity_retail_sell: number;
|
|
3903
|
+
maturity_date: string;
|
|
3904
|
+
municipal_state: string;
|
|
3905
|
+
municipal_taxable_federal: boolean;
|
|
3906
|
+
municipal_type: string;
|
|
3907
|
+
next_call_date: string;
|
|
3908
|
+
next_call_price: number;
|
|
3909
|
+
next_coupon_date: string;
|
|
3910
|
+
par_value: number;
|
|
3911
|
+
perpetual: boolean;
|
|
3912
|
+
private_placement: boolean;
|
|
3913
|
+
purpose: string;
|
|
3914
|
+
puttable: boolean;
|
|
3915
|
+
reg_s: boolean;
|
|
3916
|
+
sector: string;
|
|
3917
|
+
seniority: string;
|
|
3918
|
+
settlement_convention: string;
|
|
3919
|
+
sinking_fund: boolean;
|
|
3920
|
+
sp_creditwatch: string;
|
|
3921
|
+
sp_creditwatch_date: string;
|
|
3922
|
+
sp_outlook: string;
|
|
3923
|
+
sp_outlook_date: string;
|
|
3924
|
+
sp_rating: string;
|
|
3925
|
+
sp_rating_date: string;
|
|
3926
|
+
status: string;
|
|
3927
|
+
ticker: string;
|
|
3928
|
+
treasury_subtype: string;
|
|
3929
|
+
type: string;
|
|
3930
|
+
updated_at: string;
|
|
3931
|
+
}
|
|
3932
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
3933
|
+
bank_qualified?: boolean;
|
|
3934
|
+
callable?: boolean;
|
|
3935
|
+
convertible?: boolean;
|
|
3936
|
+
country_codes?: string[];
|
|
3937
|
+
coupon?: InsightLessAndMoreV2;
|
|
3938
|
+
coupon_frequencies?: string[];
|
|
3939
|
+
cusip?: string[];
|
|
3940
|
+
description?: string;
|
|
3941
|
+
has_ticker?: boolean;
|
|
3942
|
+
insured?: boolean;
|
|
3943
|
+
isin?: string[];
|
|
3944
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
3945
|
+
issuer?: string;
|
|
3946
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
3947
|
+
municipal_states?: string[];
|
|
3948
|
+
municipal_tax?: boolean;
|
|
3949
|
+
municipal_types?: string[];
|
|
3950
|
+
order?: InsightOrderingV2;
|
|
3951
|
+
pagination?: InsightPaginationV2;
|
|
3952
|
+
paging?: InsightPagingV2;
|
|
3953
|
+
purposes?: string[];
|
|
3954
|
+
sectors?: string[];
|
|
3955
|
+
sorts?: InsightOrderingV2[];
|
|
3956
|
+
sp_ratings?: string[];
|
|
3957
|
+
statuses?: string[];
|
|
3958
|
+
tickers?: string[];
|
|
3959
|
+
types?: string[];
|
|
3960
|
+
}
|
|
3961
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
3962
|
+
count: number;
|
|
3963
|
+
data: InsightFixedIncomeV2[];
|
|
3964
|
+
}
|
|
3965
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
3966
|
+
exchange?: string[];
|
|
3967
|
+
market_cap?: InsightLessAndMoreV2;
|
|
3968
|
+
order?: InsightOrderingV2;
|
|
3969
|
+
pagination?: InsightPaginationV2;
|
|
3970
|
+
paging?: InsightPagingV2;
|
|
3971
|
+
price?: InsightLessAndMoreV2;
|
|
3972
|
+
quote_access_type?: string;
|
|
3973
|
+
sorts?: InsightOrderingV2[];
|
|
3974
|
+
volume?: InsightLessAndMoreV2;
|
|
3975
|
+
}
|
|
3976
|
+
export interface InsightIncludeExcludeV2 {
|
|
3977
|
+
exclude: string[];
|
|
3978
|
+
include: string[];
|
|
3979
|
+
}
|
|
3980
|
+
export interface InsightLessAndMoreV2 {
|
|
3981
|
+
less_than: number;
|
|
3982
|
+
more_than: number;
|
|
3983
|
+
}
|
|
3984
|
+
export interface InsightOrderingV2 {
|
|
3985
|
+
/** @default "asc" */
|
|
3986
|
+
direction: InsightOrderingV2DirectionEnumV2;
|
|
4044
3987
|
/**
|
|
4045
|
-
*
|
|
4046
|
-
*
|
|
4047
|
-
*
|
|
4048
|
-
* @summary Get regions
|
|
4049
|
-
* @request GET:/regions
|
|
4050
|
-
* @secure
|
|
3988
|
+
* Sort direction:
|
|
3989
|
+
* * asc - Ascending, from A to Z.
|
|
3990
|
+
* * desc - Descending, from Z to A.
|
|
4051
3991
|
*/
|
|
4052
|
-
|
|
4053
|
-
|
|
4054
|
-
|
|
4055
|
-
|
|
4056
|
-
|
|
4057
|
-
|
|
3992
|
+
field: string;
|
|
3993
|
+
}
|
|
3994
|
+
export interface InsightPaginationV2 {
|
|
3995
|
+
page: number;
|
|
3996
|
+
size: number;
|
|
3997
|
+
}
|
|
3998
|
+
export interface InsightPagingV2 {
|
|
3999
|
+
limit: number;
|
|
4000
|
+
offset: number;
|
|
4001
|
+
}
|
|
4002
|
+
export interface InsightStockMarketHeatmapResponseV2 {
|
|
4003
|
+
details: InsightStockMarketHeatmapEntryV2[];
|
|
4004
|
+
max_change: number;
|
|
4005
|
+
min_change: number;
|
|
4006
|
+
}
|
|
4007
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
4008
|
+
average_volume_30d: number;
|
|
4009
|
+
company_name: string;
|
|
4010
|
+
dividend_ex_date: string;
|
|
4011
|
+
dividend_pay_date: string;
|
|
4012
|
+
dividend_percent: number;
|
|
4013
|
+
exchange: string;
|
|
4014
|
+
exchange_name: string;
|
|
4015
|
+
gap: number;
|
|
4016
|
+
industry: string;
|
|
4017
|
+
industry_code: string;
|
|
4018
|
+
last_price: number;
|
|
4019
|
+
market_cap: number;
|
|
4020
|
+
pe_ratio: number;
|
|
4021
|
+
price_change: number;
|
|
4022
|
+
price_change_percent: number;
|
|
4023
|
+
symbol: string;
|
|
4024
|
+
volume: number;
|
|
4025
|
+
}
|
|
4026
|
+
export interface InsightStockScreenerRequestV2 {
|
|
4027
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
4028
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
4029
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
4030
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
4031
|
+
exchange?: InsightIncludeExcludeV2;
|
|
4032
|
+
gap?: InsightLessAndMoreV2;
|
|
4033
|
+
industry?: InsightIncludeExcludeV2;
|
|
4034
|
+
market_cap?: InsightLessAndMoreV2;
|
|
4035
|
+
order?: InsightOrderingV2;
|
|
4036
|
+
pagination?: InsightPaginationV2;
|
|
4037
|
+
paging?: InsightPagingV2;
|
|
4038
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
4039
|
+
price?: InsightLessAndMoreV2;
|
|
4040
|
+
quote_access_type?: string;
|
|
4041
|
+
sorts?: InsightOrderingV2[];
|
|
4042
|
+
stock_type?: string;
|
|
4043
|
+
volume?: InsightLessAndMoreV2;
|
|
4044
|
+
}
|
|
4045
|
+
export interface InsightStockScreenerResponseV2 {
|
|
4046
|
+
count: number;
|
|
4047
|
+
details: InsightStockScreenerQuoteV2[];
|
|
4048
|
+
}
|
|
4049
|
+
/** @default "asc" */
|
|
4050
|
+
export enum InsightOrderingV2DirectionEnumV2 {
|
|
4051
|
+
Asc = "asc",
|
|
4052
|
+
Desc = "desc"
|
|
4053
|
+
}
|
|
4054
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
4055
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4056
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4058
4057
|
/**
|
|
4059
|
-
* @description
|
|
4060
|
-
* @tags
|
|
4061
|
-
* @name
|
|
4062
|
-
* @summary
|
|
4063
|
-
* @request
|
|
4058
|
+
* @description get fixed income entries
|
|
4059
|
+
* @tags FixedIncome
|
|
4060
|
+
* @name GetFixedIncomeEntries
|
|
4061
|
+
* @summary get fixed income entries
|
|
4062
|
+
* @request POST:/fixed-income
|
|
4064
4063
|
* @secure
|
|
4065
4064
|
*/
|
|
4066
|
-
|
|
4065
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
4066
|
+
}
|
|
4067
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
4068
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4069
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4067
4070
|
/**
|
|
4068
|
-
* @description
|
|
4069
|
-
* @tags
|
|
4070
|
-
* @name
|
|
4071
|
-
* @summary
|
|
4072
|
-
* @request POST:/
|
|
4071
|
+
* @description filter stocks by params
|
|
4072
|
+
* @tags StockScreener
|
|
4073
|
+
* @name StockScreener
|
|
4074
|
+
* @summary filter stocks by params
|
|
4075
|
+
* @request POST:/stock-screener
|
|
4073
4076
|
* @secure
|
|
4074
4077
|
*/
|
|
4075
|
-
|
|
4078
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
4076
4079
|
/**
|
|
4077
|
-
* @description
|
|
4078
|
-
* @tags
|
|
4079
|
-
* @name
|
|
4080
|
-
* @summary
|
|
4081
|
-
* @request
|
|
4080
|
+
* @description get top symbols
|
|
4081
|
+
* @tags StockScreener
|
|
4082
|
+
* @name GetTopSymbols
|
|
4083
|
+
* @summary get top symbols
|
|
4084
|
+
* @request POST:/stock-screener/top
|
|
4082
4085
|
* @secure
|
|
4083
4086
|
*/
|
|
4084
|
-
|
|
4085
|
-
/** region id */
|
|
4086
|
-
id: string;
|
|
4087
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4087
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponseV2, HandleError>>;
|
|
4088
4088
|
}
|
|
4089
4089
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4090
4090
|
alphaTools: AlphaTools<HandleError>;
|
|
@@ -4187,7 +4187,7 @@ export interface MiddlewareWatchlistEntryDto {
|
|
|
4187
4187
|
* Default to `equity` if not provided
|
|
4188
4188
|
* @default "equity"
|
|
4189
4189
|
*/
|
|
4190
|
-
type?:
|
|
4190
|
+
type?: MiddlewareWatchlistEntryDtoTypeEnum;
|
|
4191
4191
|
symbol: string;
|
|
4192
4192
|
}
|
|
4193
4193
|
export interface MiddlewareWatchlistDto {
|
|
@@ -4260,7 +4260,7 @@ export interface MiddlewareAppVersionDto {
|
|
|
4260
4260
|
* Default to `equity` if not provided
|
|
4261
4261
|
* @default "equity"
|
|
4262
4262
|
*/
|
|
4263
|
-
export enum
|
|
4263
|
+
export enum MiddlewareWatchlistEntryDtoTypeEnum {
|
|
4264
4264
|
Equity = "equity",
|
|
4265
4265
|
Option = "option",
|
|
4266
4266
|
Crypto = "crypto",
|
|
@@ -20346,7 +20346,7 @@ export interface UmaAuthFormDto {
|
|
|
20346
20346
|
logo_path?: string;
|
|
20347
20347
|
redirect_url: string;
|
|
20348
20348
|
reset_password_link_template?: string;
|
|
20349
|
-
reset_password_type:
|
|
20349
|
+
reset_password_type: UmaAuthFormDtoResetPasswordTypeEnum;
|
|
20350
20350
|
slug: string;
|
|
20351
20351
|
}
|
|
20352
20352
|
export interface UmaAuthFormSerializer {
|
|
@@ -20361,7 +20361,7 @@ export interface UmaAuthFormSerializer {
|
|
|
20361
20361
|
logo_path: string;
|
|
20362
20362
|
redirect_url: string;
|
|
20363
20363
|
reset_password_link_template: string;
|
|
20364
|
-
reset_password_type:
|
|
20364
|
+
reset_password_type: UmaAuthFormSerializerResetPasswordTypeEnum;
|
|
20365
20365
|
slug: string;
|
|
20366
20366
|
updated_at: string;
|
|
20367
20367
|
}
|
|
@@ -20401,7 +20401,7 @@ export interface UmaB2BResetPasswordDto {
|
|
|
20401
20401
|
export interface UmaB2BSendContactChangeCodeDto {
|
|
20402
20402
|
/** @maxLength 255 */
|
|
20403
20403
|
contact: string;
|
|
20404
|
-
type:
|
|
20404
|
+
type: UmaB2BSendContactChangeCodeDtoTypeEnum;
|
|
20405
20405
|
}
|
|
20406
20406
|
export interface UmaB2BUploadAvatarSerializer {
|
|
20407
20407
|
big_avatar_path: string;
|
|
@@ -20462,15 +20462,15 @@ export interface UmaB2CResetPasswordDto {
|
|
|
20462
20462
|
contact?: string;
|
|
20463
20463
|
/** @maxLength 100 */
|
|
20464
20464
|
new_password: string;
|
|
20465
|
-
reset_type:
|
|
20465
|
+
reset_type: UmaB2CResetPasswordDtoResetTypeEnum;
|
|
20466
20466
|
}
|
|
20467
20467
|
export interface UmaB2CSendContactChangeCodeDto {
|
|
20468
20468
|
/** @maxLength 255 */
|
|
20469
20469
|
contact: string;
|
|
20470
|
-
type:
|
|
20470
|
+
type: UmaB2CSendContactChangeCodeDtoTypeEnum;
|
|
20471
20471
|
}
|
|
20472
20472
|
export interface UmaB2CSendVerificationCodeDto {
|
|
20473
|
-
code_type:
|
|
20473
|
+
code_type: UmaB2CSendVerificationCodeDtoCodeTypeEnum;
|
|
20474
20474
|
contact: string;
|
|
20475
20475
|
}
|
|
20476
20476
|
export interface UmaB2CUserSettingsSerializer {
|
|
@@ -20654,13 +20654,13 @@ export interface UmaCreateEndpointDto {
|
|
|
20654
20654
|
is_active?: boolean;
|
|
20655
20655
|
is_public?: boolean;
|
|
20656
20656
|
metadata?: UmaEndpointMetadataDto;
|
|
20657
|
-
method:
|
|
20657
|
+
method: UmaCreateEndpointDtoMethodEnum;
|
|
20658
20658
|
/** @min 1 */
|
|
20659
20659
|
microservice_id: number;
|
|
20660
20660
|
required_permissions?: number[];
|
|
20661
20661
|
/** @maxLength 255 */
|
|
20662
20662
|
route: string;
|
|
20663
|
-
type?:
|
|
20663
|
+
type?: UmaCreateEndpointDtoTypeEnum;
|
|
20664
20664
|
}
|
|
20665
20665
|
export interface UmaCreateFirmDto {
|
|
20666
20666
|
allow_b2c_email_notifications?: boolean;
|
|
@@ -20687,7 +20687,7 @@ export interface UmaCreateIdentityProviderDto {
|
|
|
20687
20687
|
priority: number;
|
|
20688
20688
|
/** @maxLength 1000 */
|
|
20689
20689
|
redirect_url?: string;
|
|
20690
|
-
type:
|
|
20690
|
+
type: UmaCreateIdentityProviderDtoTypeEnum;
|
|
20691
20691
|
}
|
|
20692
20692
|
export interface UmaCreateMicroserviceDto {
|
|
20693
20693
|
domains?: UmaMicroserviceDomainDto[];
|
|
@@ -20701,14 +20701,14 @@ export interface UmaCreateMicroserviceDto {
|
|
|
20701
20701
|
slug: string;
|
|
20702
20702
|
}
|
|
20703
20703
|
export interface UmaCreatePermissionDto {
|
|
20704
|
-
assignment_group:
|
|
20704
|
+
assignment_group: UmaCreatePermissionDtoAssignmentGroupEnum;
|
|
20705
20705
|
metadata?: UmaPermissionMetadata;
|
|
20706
20706
|
microservice_id?: number;
|
|
20707
20707
|
/** @maxLength 1000 */
|
|
20708
20708
|
permission: string;
|
|
20709
20709
|
}
|
|
20710
20710
|
export interface UmaCreateRoleDto {
|
|
20711
|
-
assignment_group?:
|
|
20711
|
+
assignment_group?: UmaCreateRoleDtoAssignmentGroupEnum;
|
|
20712
20712
|
/** @min 0 */
|
|
20713
20713
|
firm_id?: number;
|
|
20714
20714
|
microservice_id: number;
|
|
@@ -20741,7 +20741,7 @@ export interface UmaCreateSecretNoteDto {
|
|
|
20741
20741
|
max_view_count: number;
|
|
20742
20742
|
name?: string;
|
|
20743
20743
|
note_params: Record<string, string>;
|
|
20744
|
-
type:
|
|
20744
|
+
type: UmaCreateSecretNoteDtoTypeEnum;
|
|
20745
20745
|
}
|
|
20746
20746
|
export interface UmaCreateTagDto {
|
|
20747
20747
|
name: string;
|
|
@@ -20790,7 +20790,7 @@ export interface UmaEndpointMetadataDto {
|
|
|
20790
20790
|
skip_email_verification_check?: boolean;
|
|
20791
20791
|
skip_mfa_enabled_check?: boolean;
|
|
20792
20792
|
skip_phone_verification_check?: boolean;
|
|
20793
|
-
user_type?:
|
|
20793
|
+
user_type?: UmaEndpointMetadataDtoUserTypeEnum;
|
|
20794
20794
|
}
|
|
20795
20795
|
export interface UmaEndpointMetadataSerializer {
|
|
20796
20796
|
admin_ui_permission_key: string;
|
|
@@ -20805,7 +20805,7 @@ export interface UmaEndpointSerializer {
|
|
|
20805
20805
|
is_active: boolean;
|
|
20806
20806
|
is_public: boolean;
|
|
20807
20807
|
metadata: UmaEndpointMetadataSerializer;
|
|
20808
|
-
method:
|
|
20808
|
+
method: UmaEndpointSerializerMethodEnum;
|
|
20809
20809
|
microservice: UmaMicroserviceSerializer;
|
|
20810
20810
|
microservice_id: number;
|
|
20811
20811
|
required_permissions: UmaPermissionSerializer[];
|
|
@@ -20969,7 +20969,7 @@ export interface UmaGetB2CUsersListFiltersDto {
|
|
|
20969
20969
|
permission_names?: string[];
|
|
20970
20970
|
phone_verified?: boolean;
|
|
20971
20971
|
role_ids?: number[];
|
|
20972
|
-
show_only?:
|
|
20972
|
+
show_only?: UmaGetB2CUsersListFiltersDtoShowOnlyEnum;
|
|
20973
20973
|
}
|
|
20974
20974
|
export interface UmaGetBranchesListDto {
|
|
20975
20975
|
count_branch_admins?: boolean;
|
|
@@ -21008,7 +21008,7 @@ export interface UmaGetFirmsListDto {
|
|
|
21008
21008
|
}
|
|
21009
21009
|
export interface UmaGetFirmsListFiltersDto {
|
|
21010
21010
|
ids?: number[];
|
|
21011
|
-
statuses?:
|
|
21011
|
+
statuses?: UmaGetFirmsListFiltersDtoStatusesEnum;
|
|
21012
21012
|
tag_ids?: number[];
|
|
21013
21013
|
}
|
|
21014
21014
|
export interface UmaGetIdentityProvidersListDto {
|
|
@@ -21020,7 +21020,7 @@ export interface UmaGetIdentityProvidersListDto {
|
|
|
21020
21020
|
export interface UmaGetIdentityProvidersListFiltersDto {
|
|
21021
21021
|
firm_ids?: number[];
|
|
21022
21022
|
ids?: number[];
|
|
21023
|
-
types?:
|
|
21023
|
+
types?: UmaGetIdentityProvidersListFiltersDtoTypesEnum[];
|
|
21024
21024
|
}
|
|
21025
21025
|
export interface UmaGetMicroservicesListDto {
|
|
21026
21026
|
filters?: UmaGetMicroservicesListFiltersDto;
|
|
@@ -21101,7 +21101,7 @@ export interface UmaGetUsersListFiltersDto {
|
|
|
21101
21101
|
permission_names?: string[];
|
|
21102
21102
|
phone_verified?: boolean;
|
|
21103
21103
|
role_ids?: number[];
|
|
21104
|
-
show_only?:
|
|
21104
|
+
show_only?: UmaGetUsersListFiltersDtoShowOnlyEnum;
|
|
21105
21105
|
}
|
|
21106
21106
|
export interface UmaGetWatchmenInstancesDto {
|
|
21107
21107
|
pagination: UmaPaginationDto;
|
|
@@ -21111,7 +21111,7 @@ export interface UmaGetWatchmenInstancesDto {
|
|
|
21111
21111
|
export interface UmaGetWebAuthnLoginChallengeDto {
|
|
21112
21112
|
/** @maxLength 255 */
|
|
21113
21113
|
email: string;
|
|
21114
|
-
user_type?:
|
|
21114
|
+
user_type?: UmaGetWebAuthnLoginChallengeDtoUserTypeEnum;
|
|
21115
21115
|
}
|
|
21116
21116
|
export interface UmaIdentityProviderSerializer {
|
|
21117
21117
|
auth_url: string;
|
|
@@ -21123,7 +21123,7 @@ export interface UmaIdentityProviderSerializer {
|
|
|
21123
21123
|
id: number;
|
|
21124
21124
|
priority: number;
|
|
21125
21125
|
redirect_url: string;
|
|
21126
|
-
type:
|
|
21126
|
+
type: UmaIdentityProviderSerializerTypeEnum;
|
|
21127
21127
|
updated_at: string;
|
|
21128
21128
|
}
|
|
21129
21129
|
export interface UmaImageDimensionsSerializer {
|
|
@@ -21146,7 +21146,7 @@ export interface UmaInitOAuthLoginSerializer {
|
|
|
21146
21146
|
export interface UmaLinkWatchmenUserToUmaDto {
|
|
21147
21147
|
/** @min 1 */
|
|
21148
21148
|
uma_user_id: number;
|
|
21149
|
-
uma_user_type:
|
|
21149
|
+
uma_user_type: UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum;
|
|
21150
21150
|
watchmen_instance_slug: string;
|
|
21151
21151
|
/** @min 1 */
|
|
21152
21152
|
watchmen_user_id: number;
|
|
@@ -21231,7 +21231,7 @@ export interface UmaPermissionMetadataSerializer {
|
|
|
21231
21231
|
is_microservice_global: boolean;
|
|
21232
21232
|
}
|
|
21233
21233
|
export interface UmaPermissionSerializer {
|
|
21234
|
-
assignment_group:
|
|
21234
|
+
assignment_group: UmaPermissionSerializerAssignmentGroupEnum;
|
|
21235
21235
|
created_at: string;
|
|
21236
21236
|
/** @example 1 */
|
|
21237
21237
|
id: number;
|
|
@@ -21288,7 +21288,7 @@ export interface UmaResetPasswordSettingsSerializer {
|
|
|
21288
21288
|
export interface UmaRevokeUserSessionsDto {
|
|
21289
21289
|
/** @min 1 */
|
|
21290
21290
|
user_id: number;
|
|
21291
|
-
user_type:
|
|
21291
|
+
user_type: UmaRevokeUserSessionsDtoUserTypeEnum;
|
|
21292
21292
|
}
|
|
21293
21293
|
export interface UmaRoleSerializer {
|
|
21294
21294
|
assignment_group: UmaPermissionAG;
|
|
@@ -21318,7 +21318,7 @@ export interface UmaSecretNoteSerializer {
|
|
|
21318
21318
|
id: string;
|
|
21319
21319
|
name: string;
|
|
21320
21320
|
note_params: Record<string, string>;
|
|
21321
|
-
type:
|
|
21321
|
+
type: UmaSecretNoteSerializerTypeEnum;
|
|
21322
21322
|
views_left: number;
|
|
21323
21323
|
}
|
|
21324
21324
|
export interface UmaSendB2BMfaCodeDto {
|
|
@@ -21329,7 +21329,7 @@ export interface UmaSendB2BMfaCodeDto {
|
|
|
21329
21329
|
* @example "test@gmail.com"
|
|
21330
21330
|
*/
|
|
21331
21331
|
email: string;
|
|
21332
|
-
type:
|
|
21332
|
+
type: UmaSendB2BMfaCodeDtoTypeEnum;
|
|
21333
21333
|
}
|
|
21334
21334
|
export interface UmaSendB2CMfaCodeDto {
|
|
21335
21335
|
/** @maxLength 255 */
|
|
@@ -21339,17 +21339,17 @@ export interface UmaSendB2CMfaCodeDto {
|
|
|
21339
21339
|
* @example "test@gmail.com"
|
|
21340
21340
|
*/
|
|
21341
21341
|
login: string;
|
|
21342
|
-
type:
|
|
21342
|
+
type: UmaSendB2CMfaCodeDtoTypeEnum;
|
|
21343
21343
|
}
|
|
21344
21344
|
export interface UmaSendB2CResetPasswordCodeDto {
|
|
21345
21345
|
auth_form_slug: string;
|
|
21346
|
-
code_type?:
|
|
21346
|
+
code_type?: UmaSendB2CResetPasswordCodeDtoCodeTypeEnum;
|
|
21347
21347
|
contact: string;
|
|
21348
|
-
reset_type:
|
|
21348
|
+
reset_type: UmaSendB2CResetPasswordCodeDtoResetTypeEnum;
|
|
21349
21349
|
}
|
|
21350
21350
|
export interface UmaSendResetPasswordCodeDto {
|
|
21351
21351
|
contact: string;
|
|
21352
|
-
type:
|
|
21352
|
+
type: UmaSendResetPasswordCodeDtoTypeEnum;
|
|
21353
21353
|
}
|
|
21354
21354
|
export interface UmaSendVerificationCodeForSecretNoteDto {
|
|
21355
21355
|
/** @maxLength 255 */
|
|
@@ -21437,7 +21437,7 @@ export interface UmaTagSerializer {
|
|
|
21437
21437
|
updated_at: string;
|
|
21438
21438
|
}
|
|
21439
21439
|
export interface UmaTenantSettingDto {
|
|
21440
|
-
label:
|
|
21440
|
+
label: UmaTenantSettingDtoLabelEnum;
|
|
21441
21441
|
value: string;
|
|
21442
21442
|
}
|
|
21443
21443
|
export enum UmaTenantSettingLabel {
|
|
@@ -21466,7 +21466,7 @@ export interface UmaUpdateAPIKeysDto {
|
|
|
21466
21466
|
export interface UmaUpdateAuthAppDto {
|
|
21467
21467
|
/** @maxLength 255 */
|
|
21468
21468
|
name: string;
|
|
21469
|
-
status:
|
|
21469
|
+
status: UmaUpdateAuthAppDtoStatusEnum;
|
|
21470
21470
|
}
|
|
21471
21471
|
export interface UmaUpdateB2BUserDto {
|
|
21472
21472
|
allow_feedback?: boolean;
|
|
@@ -21552,13 +21552,13 @@ export interface UmaUpdateEndpointDto {
|
|
|
21552
21552
|
is_active?: boolean;
|
|
21553
21553
|
is_public?: boolean;
|
|
21554
21554
|
metadata?: UmaEndpointMetadataDto;
|
|
21555
|
-
method:
|
|
21555
|
+
method: UmaUpdateEndpointDtoMethodEnum;
|
|
21556
21556
|
/** @min 1 */
|
|
21557
21557
|
microservice_id: number;
|
|
21558
21558
|
required_permissions?: number[];
|
|
21559
21559
|
/** @maxLength 255 */
|
|
21560
21560
|
route: string;
|
|
21561
|
-
type?:
|
|
21561
|
+
type?: UmaUpdateEndpointDtoTypeEnum;
|
|
21562
21562
|
updated_at: string;
|
|
21563
21563
|
}
|
|
21564
21564
|
export interface UmaUpdateFirmDto {
|
|
@@ -21569,7 +21569,7 @@ export interface UmaUpdateFirmDto {
|
|
|
21569
21569
|
name: string;
|
|
21570
21570
|
/** @maxLength 255 */
|
|
21571
21571
|
slug: string;
|
|
21572
|
-
status:
|
|
21572
|
+
status: UmaUpdateFirmDtoStatusEnum;
|
|
21573
21573
|
twilio_creds?: UmaFirmTwilioCredsDto;
|
|
21574
21574
|
updated_at: string;
|
|
21575
21575
|
}
|
|
@@ -21588,7 +21588,7 @@ export interface UmaUpdateIdentityProviderDto {
|
|
|
21588
21588
|
priority: number;
|
|
21589
21589
|
/** @maxLength 1000 */
|
|
21590
21590
|
redirect_url?: string;
|
|
21591
|
-
type:
|
|
21591
|
+
type: UmaUpdateIdentityProviderDtoTypeEnum;
|
|
21592
21592
|
updated_at: string;
|
|
21593
21593
|
}
|
|
21594
21594
|
export interface UmaUpdateMicroserviceDto {
|
|
@@ -21604,7 +21604,7 @@ export interface UmaUpdateMicroserviceDto {
|
|
|
21604
21604
|
updated_at: string;
|
|
21605
21605
|
}
|
|
21606
21606
|
export interface UmaUpdatePermissionDto {
|
|
21607
|
-
assignment_group?:
|
|
21607
|
+
assignment_group?: UmaUpdatePermissionDtoAssignmentGroupEnum;
|
|
21608
21608
|
metadata?: UmaPermissionMetadata;
|
|
21609
21609
|
microservice_id?: number;
|
|
21610
21610
|
/** @maxLength 1000 */
|
|
@@ -21668,7 +21668,7 @@ export interface UmaUpsertUserDto {
|
|
|
21668
21668
|
phone?: string;
|
|
21669
21669
|
rep_code?: string;
|
|
21670
21670
|
roles: number[];
|
|
21671
|
-
type:
|
|
21671
|
+
type: UmaUpsertUserDtoTypeEnum;
|
|
21672
21672
|
}
|
|
21673
21673
|
export interface UmaUpsertUsersDto {
|
|
21674
21674
|
/** @maxItems 100 */
|
|
@@ -21712,7 +21712,7 @@ export interface UmaVerificationSettingsSerializer {
|
|
|
21712
21712
|
}
|
|
21713
21713
|
export interface UmaVerifyContactDto {
|
|
21714
21714
|
code: string;
|
|
21715
|
-
code_type:
|
|
21715
|
+
code_type: UmaVerifyContactDtoCodeTypeEnum;
|
|
21716
21716
|
contact: string;
|
|
21717
21717
|
}
|
|
21718
21718
|
export interface UmaVerifyWatchmenAuthTokenDto {
|
|
@@ -21848,34 +21848,34 @@ export interface UmaWatchmenInstanceMutationSerializer {
|
|
|
21848
21848
|
status: number;
|
|
21849
21849
|
watchmen_instance: UmaWatchmenInstanceSerializer;
|
|
21850
21850
|
}
|
|
21851
|
-
export enum
|
|
21851
|
+
export enum UmaAuthFormDtoResetPasswordTypeEnum {
|
|
21852
21852
|
ByContactCode = "by_contact_code",
|
|
21853
21853
|
ByEmailLink = "by_email_link"
|
|
21854
21854
|
}
|
|
21855
|
-
export enum
|
|
21855
|
+
export enum UmaAuthFormSerializerResetPasswordTypeEnum {
|
|
21856
21856
|
ByContactCode = "by_contact_code",
|
|
21857
21857
|
ByEmailLink = "by_email_link"
|
|
21858
21858
|
}
|
|
21859
|
-
export enum
|
|
21859
|
+
export enum UmaB2BSendContactChangeCodeDtoTypeEnum {
|
|
21860
21860
|
Email = "email",
|
|
21861
21861
|
Voice = "voice",
|
|
21862
21862
|
Sms = "sms"
|
|
21863
21863
|
}
|
|
21864
|
-
export enum
|
|
21864
|
+
export enum UmaB2CResetPasswordDtoResetTypeEnum {
|
|
21865
21865
|
ByContactCode = "by_contact_code",
|
|
21866
21866
|
ByEmailLink = "by_email_link"
|
|
21867
21867
|
}
|
|
21868
|
-
export enum
|
|
21868
|
+
export enum UmaB2CSendContactChangeCodeDtoTypeEnum {
|
|
21869
21869
|
Email = "email",
|
|
21870
21870
|
Voice = "voice",
|
|
21871
21871
|
Sms = "sms"
|
|
21872
21872
|
}
|
|
21873
|
-
export enum
|
|
21873
|
+
export enum UmaB2CSendVerificationCodeDtoCodeTypeEnum {
|
|
21874
21874
|
Email = "email",
|
|
21875
21875
|
Voice = "voice",
|
|
21876
21876
|
Sms = "sms"
|
|
21877
21877
|
}
|
|
21878
|
-
export enum
|
|
21878
|
+
export enum UmaCreateEndpointDtoMethodEnum {
|
|
21879
21879
|
POST = "POST",
|
|
21880
21880
|
PUT = "PUT",
|
|
21881
21881
|
DELETE = "DELETE",
|
|
@@ -21883,31 +21883,31 @@ export enum UmaUmaCreateEndpointDtoMethodEnum {
|
|
|
21883
21883
|
PATCH = "PATCH",
|
|
21884
21884
|
ALL = "ALL"
|
|
21885
21885
|
}
|
|
21886
|
-
export enum
|
|
21886
|
+
export enum UmaCreateEndpointDtoTypeEnum {
|
|
21887
21887
|
Regular = "regular",
|
|
21888
21888
|
DisplayOnly = "display_only"
|
|
21889
21889
|
}
|
|
21890
|
-
export enum
|
|
21890
|
+
export enum UmaCreateIdentityProviderDtoTypeEnum {
|
|
21891
21891
|
Okta = "okta"
|
|
21892
21892
|
}
|
|
21893
|
-
export enum
|
|
21893
|
+
export enum UmaCreatePermissionDtoAssignmentGroupEnum {
|
|
21894
21894
|
Regular = "regular",
|
|
21895
21895
|
Superadmin = "superadmin",
|
|
21896
21896
|
B2BOnly = "b2b_only"
|
|
21897
21897
|
}
|
|
21898
|
-
export enum
|
|
21898
|
+
export enum UmaCreateRoleDtoAssignmentGroupEnum {
|
|
21899
21899
|
Regular = "regular",
|
|
21900
21900
|
Superadmin = "superadmin",
|
|
21901
21901
|
B2BOnly = "b2b_only"
|
|
21902
21902
|
}
|
|
21903
|
-
export enum
|
|
21903
|
+
export enum UmaCreateSecretNoteDtoTypeEnum {
|
|
21904
21904
|
Password = "password"
|
|
21905
21905
|
}
|
|
21906
|
-
export enum
|
|
21906
|
+
export enum UmaEndpointMetadataDtoUserTypeEnum {
|
|
21907
21907
|
B2B = "b2b",
|
|
21908
21908
|
B2C = "b2c"
|
|
21909
21909
|
}
|
|
21910
|
-
export enum
|
|
21910
|
+
export enum UmaEndpointSerializerMethodEnum {
|
|
21911
21911
|
POST = "POST",
|
|
21912
21912
|
PUT = "PUT",
|
|
21913
21913
|
DELETE = "DELETE",
|
|
@@ -21915,82 +21915,82 @@ export enum UmaUmaEndpointSerializerMethodEnum {
|
|
|
21915
21915
|
PATCH = "PATCH",
|
|
21916
21916
|
ALL = "ALL"
|
|
21917
21917
|
}
|
|
21918
|
-
export enum
|
|
21918
|
+
export enum UmaGetB2CUsersListFiltersDtoShowOnlyEnum {
|
|
21919
21919
|
Admin = "admin",
|
|
21920
21920
|
BranchAdmin = "branch_admin",
|
|
21921
21921
|
Compliance = "compliance"
|
|
21922
21922
|
}
|
|
21923
|
-
export enum
|
|
21923
|
+
export enum UmaGetFirmsListFiltersDtoStatusesEnum {
|
|
21924
21924
|
InProgress = "in_progress",
|
|
21925
21925
|
Active = "active",
|
|
21926
21926
|
Suspended = "suspended",
|
|
21927
21927
|
Deleted = "deleted"
|
|
21928
21928
|
}
|
|
21929
|
-
export enum
|
|
21929
|
+
export enum UmaGetIdentityProvidersListFiltersDtoTypesEnum {
|
|
21930
21930
|
Okta = "okta"
|
|
21931
21931
|
}
|
|
21932
|
-
export enum
|
|
21932
|
+
export enum UmaGetUsersListFiltersDtoShowOnlyEnum {
|
|
21933
21933
|
Admin = "admin",
|
|
21934
21934
|
BranchAdmin = "branch_admin",
|
|
21935
21935
|
Compliance = "compliance"
|
|
21936
21936
|
}
|
|
21937
|
-
export enum
|
|
21937
|
+
export enum UmaGetWebAuthnLoginChallengeDtoUserTypeEnum {
|
|
21938
21938
|
B2B = "b2b",
|
|
21939
21939
|
B2C = "b2c"
|
|
21940
21940
|
}
|
|
21941
|
-
export enum
|
|
21941
|
+
export enum UmaIdentityProviderSerializerTypeEnum {
|
|
21942
21942
|
Okta = "okta"
|
|
21943
21943
|
}
|
|
21944
|
-
export enum
|
|
21944
|
+
export enum UmaLinkWatchmenUserToUmaDtoUmaUserTypeEnum {
|
|
21945
21945
|
B2B = "b2b",
|
|
21946
21946
|
B2C = "b2c"
|
|
21947
21947
|
}
|
|
21948
|
-
export enum
|
|
21948
|
+
export enum UmaPermissionSerializerAssignmentGroupEnum {
|
|
21949
21949
|
Regular = "regular",
|
|
21950
21950
|
Chiefadmin = "chiefadmin",
|
|
21951
21951
|
Superadmin = "superadmin"
|
|
21952
21952
|
}
|
|
21953
|
-
export enum
|
|
21953
|
+
export enum UmaRevokeUserSessionsDtoUserTypeEnum {
|
|
21954
21954
|
B2B = "b2b",
|
|
21955
21955
|
B2C = "b2c"
|
|
21956
21956
|
}
|
|
21957
|
-
export enum
|
|
21957
|
+
export enum UmaSecretNoteSerializerTypeEnum {
|
|
21958
21958
|
Password = "password"
|
|
21959
21959
|
}
|
|
21960
|
-
export enum
|
|
21960
|
+
export enum UmaSendB2BMfaCodeDtoTypeEnum {
|
|
21961
21961
|
Email = "email",
|
|
21962
21962
|
Voice = "voice",
|
|
21963
21963
|
Sms = "sms"
|
|
21964
21964
|
}
|
|
21965
|
-
export enum
|
|
21965
|
+
export enum UmaSendB2CMfaCodeDtoTypeEnum {
|
|
21966
21966
|
Email = "email",
|
|
21967
21967
|
Voice = "voice",
|
|
21968
21968
|
Sms = "sms"
|
|
21969
21969
|
}
|
|
21970
|
-
export enum
|
|
21970
|
+
export enum UmaSendB2CResetPasswordCodeDtoCodeTypeEnum {
|
|
21971
21971
|
Email = "email",
|
|
21972
21972
|
Voice = "voice",
|
|
21973
21973
|
Sms = "sms"
|
|
21974
21974
|
}
|
|
21975
|
-
export enum
|
|
21975
|
+
export enum UmaSendB2CResetPasswordCodeDtoResetTypeEnum {
|
|
21976
21976
|
ByContactCode = "by_contact_code",
|
|
21977
21977
|
ByEmailLink = "by_email_link"
|
|
21978
21978
|
}
|
|
21979
|
-
export enum
|
|
21979
|
+
export enum UmaSendResetPasswordCodeDtoTypeEnum {
|
|
21980
21980
|
Email = "email",
|
|
21981
21981
|
Voice = "voice",
|
|
21982
21982
|
Sms = "sms"
|
|
21983
21983
|
}
|
|
21984
|
-
export enum
|
|
21984
|
+
export enum UmaTenantSettingDtoLabelEnum {
|
|
21985
21985
|
StorePasswordHistoryForDays = "store_password_history_for_days",
|
|
21986
21986
|
ResetPasswordIfUserInactiveForDays = "reset_password_if_user_inactive_for_days",
|
|
21987
21987
|
PeriodicallyResetPasswordAfterDays = "periodically_reset_password_after_days"
|
|
21988
21988
|
}
|
|
21989
|
-
export enum
|
|
21989
|
+
export enum UmaUpdateAuthAppDtoStatusEnum {
|
|
21990
21990
|
Active = "active",
|
|
21991
21991
|
Disabled = "disabled"
|
|
21992
21992
|
}
|
|
21993
|
-
export enum
|
|
21993
|
+
export enum UmaUpdateEndpointDtoMethodEnum {
|
|
21994
21994
|
POST = "POST",
|
|
21995
21995
|
PUT = "PUT",
|
|
21996
21996
|
DELETE = "DELETE",
|
|
@@ -21998,29 +21998,29 @@ export enum UmaUmaUpdateEndpointDtoMethodEnum {
|
|
|
21998
21998
|
PATCH = "PATCH",
|
|
21999
21999
|
ALL = "ALL"
|
|
22000
22000
|
}
|
|
22001
|
-
export enum
|
|
22001
|
+
export enum UmaUpdateEndpointDtoTypeEnum {
|
|
22002
22002
|
Regular = "regular",
|
|
22003
22003
|
DisplayOnly = "display_only"
|
|
22004
22004
|
}
|
|
22005
|
-
export enum
|
|
22005
|
+
export enum UmaUpdateFirmDtoStatusEnum {
|
|
22006
22006
|
InProgress = "in_progress",
|
|
22007
22007
|
Active = "active",
|
|
22008
22008
|
Suspended = "suspended",
|
|
22009
22009
|
Deleted = "deleted"
|
|
22010
22010
|
}
|
|
22011
|
-
export enum
|
|
22011
|
+
export enum UmaUpdateIdentityProviderDtoTypeEnum {
|
|
22012
22012
|
Okta = "okta"
|
|
22013
22013
|
}
|
|
22014
|
-
export enum
|
|
22014
|
+
export enum UmaUpdatePermissionDtoAssignmentGroupEnum {
|
|
22015
22015
|
Regular = "regular",
|
|
22016
22016
|
Superadmin = "superadmin",
|
|
22017
22017
|
B2BOnly = "b2b_only"
|
|
22018
22018
|
}
|
|
22019
|
-
export enum
|
|
22019
|
+
export enum UmaUpsertUserDtoTypeEnum {
|
|
22020
22020
|
B2B = "b2b",
|
|
22021
22021
|
B2C = "b2c"
|
|
22022
22022
|
}
|
|
22023
|
-
export enum
|
|
22023
|
+
export enum UmaVerifyContactDtoCodeTypeEnum {
|
|
22024
22024
|
Email = "email",
|
|
22025
22025
|
Voice = "voice",
|
|
22026
22026
|
Sms = "sms"
|