@orbis-systems/orbis-api-clients 0.7.14 → 0.7.16
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 +197 -163
- 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 +710 -558
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +410 -131
- 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 +156 -87
- 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 +911 -1067
- 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 +475 -774
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +263 -245
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -267,6 +267,12 @@ export interface InsightArticleFeaturedImageInfo {
|
|
|
267
267
|
url: string;
|
|
268
268
|
width: number;
|
|
269
269
|
}
|
|
270
|
+
export enum InsightArticleSearchType {
|
|
271
|
+
ArticleSearchTypeAll = "all",
|
|
272
|
+
ArticleSearchTypeTag = "tag",
|
|
273
|
+
ArticleSearchTypePrimary = "primary",
|
|
274
|
+
ArticleSearchTypeSymbol = "symbol"
|
|
275
|
+
}
|
|
270
276
|
export interface InsightArticlesRequest {
|
|
271
277
|
/** @example 10 */
|
|
272
278
|
count?: number;
|
|
@@ -283,7 +289,11 @@ export interface InsightArticlesRequest {
|
|
|
283
289
|
/** @example "group1" */
|
|
284
290
|
tag_group?: string;
|
|
285
291
|
/** @example "education" */
|
|
286
|
-
type?:
|
|
292
|
+
type?: InsightArticlesRequestType;
|
|
293
|
+
}
|
|
294
|
+
export enum InsightArticlesRequestType {
|
|
295
|
+
ArticlesRequestTypeEducation = "education",
|
|
296
|
+
ArticlesRequestTypeNonEducation = "non-education"
|
|
287
297
|
}
|
|
288
298
|
export interface InsightAssetAllocationBreakdown {
|
|
289
299
|
breakdown: string;
|
|
@@ -359,6 +369,8 @@ export interface InsightCalculateEstimatedReturnsResponse {
|
|
|
359
369
|
}
|
|
360
370
|
export interface InsightCalculateMatrixParamsRequest {
|
|
361
371
|
expiry_date?: InsightDate;
|
|
372
|
+
/** @example "2023-12-31" */
|
|
373
|
+
formatted_expiry_date?: string;
|
|
362
374
|
/** @example 10 */
|
|
363
375
|
max_intervals?: number;
|
|
364
376
|
/** @example "c" */
|
|
@@ -378,6 +390,8 @@ export interface InsightCalculateMatrixResponse {
|
|
|
378
390
|
}
|
|
379
391
|
export interface InsightCalculateParamsRequest {
|
|
380
392
|
expiry_date?: InsightDate;
|
|
393
|
+
/** @example "2023-12-31" */
|
|
394
|
+
formatted_expiry_date?: string;
|
|
381
395
|
/** @example "c" */
|
|
382
396
|
option_type?: InsightCalculateParamsRequestOptionTypeEnum;
|
|
383
397
|
/** @example 150.25 */
|
|
@@ -510,9 +524,15 @@ export interface InsightCompanyProfile {
|
|
|
510
524
|
}
|
|
511
525
|
export interface InsightConfidenceSignal {
|
|
512
526
|
score: string;
|
|
527
|
+
/** @format float32 */
|
|
513
528
|
sectorScore: number;
|
|
529
|
+
/** @format float32 */
|
|
514
530
|
stockScore: number;
|
|
515
531
|
}
|
|
532
|
+
export enum InsightConsensusInterval {
|
|
533
|
+
ConsensusIntervalWeek = "week",
|
|
534
|
+
ConsensusIntervalMonth = "month"
|
|
535
|
+
}
|
|
516
536
|
export interface InsightContinent {
|
|
517
537
|
id: string;
|
|
518
538
|
name: string;
|
|
@@ -522,6 +542,16 @@ export interface InsightContinentBreakdown {
|
|
|
522
542
|
code: string;
|
|
523
543
|
percentage: number;
|
|
524
544
|
}
|
|
545
|
+
export enum InsightConversion {
|
|
546
|
+
ConversionOriginal = "original",
|
|
547
|
+
ConversionDefault = "default",
|
|
548
|
+
ConversionNormal = "normal",
|
|
549
|
+
ConversionThumbnail = "thumbnail",
|
|
550
|
+
ConversionSquare = "square",
|
|
551
|
+
ConversionSquareStrict = "square_strict",
|
|
552
|
+
ConversionSquareStrictOrNormal = "square_strict_or_normal",
|
|
553
|
+
ConversionBestMatch = "best_match"
|
|
554
|
+
}
|
|
525
555
|
export interface InsightCountryBreakdown {
|
|
526
556
|
breakdown: string;
|
|
527
557
|
percentage: number;
|
|
@@ -607,6 +637,33 @@ export interface InsightCreateOrUpdateFundScreenerPresetRequest {
|
|
|
607
637
|
preset_description?: string;
|
|
608
638
|
preset_name: string;
|
|
609
639
|
}
|
|
640
|
+
export interface InsightCreateOrUpdateMarketRequest {
|
|
641
|
+
/** @example "USA" */
|
|
642
|
+
country_code: string;
|
|
643
|
+
/** @example "USD" */
|
|
644
|
+
currency_code: string;
|
|
645
|
+
/** @example "U" */
|
|
646
|
+
market_code: string;
|
|
647
|
+
/** @example "United States" */
|
|
648
|
+
market_name: string;
|
|
649
|
+
/** @example true */
|
|
650
|
+
primary_market?: boolean;
|
|
651
|
+
/** @example "America/New_York" */
|
|
652
|
+
timezone: string;
|
|
653
|
+
}
|
|
654
|
+
export interface InsightCreateOrUpdateMarketScheduleRequest {
|
|
655
|
+
/** @example "U" */
|
|
656
|
+
market_code: string;
|
|
657
|
+
schedule?: {
|
|
658
|
+
friday?: InsightMarketScheduleEntry[];
|
|
659
|
+
monday?: InsightMarketScheduleEntry[];
|
|
660
|
+
saturday?: InsightMarketScheduleEntry[];
|
|
661
|
+
sunday?: InsightMarketScheduleEntry[];
|
|
662
|
+
thursday?: InsightMarketScheduleEntry[];
|
|
663
|
+
tuesday?: InsightMarketScheduleEntry[];
|
|
664
|
+
wednesday?: InsightMarketScheduleEntry[];
|
|
665
|
+
};
|
|
666
|
+
}
|
|
610
667
|
export interface InsightCreateOrUpdateScreenerPresetRequest {
|
|
611
668
|
id?: string;
|
|
612
669
|
preset?: InsightStockScreenerRequest;
|
|
@@ -784,17 +841,6 @@ export interface InsightExtendedFundData {
|
|
|
784
841
|
symbol: string;
|
|
785
842
|
url: string;
|
|
786
843
|
}
|
|
787
|
-
export interface InsightExtendedMarketDate {
|
|
788
|
-
close_time: string;
|
|
789
|
-
country_code: string;
|
|
790
|
-
currency_code: string;
|
|
791
|
-
market_code: string;
|
|
792
|
-
market_name: string;
|
|
793
|
-
open_date: string;
|
|
794
|
-
open_time: string;
|
|
795
|
-
primary_market: boolean;
|
|
796
|
-
timezone: string;
|
|
797
|
-
}
|
|
798
844
|
export interface InsightExtremum {
|
|
799
845
|
max_value: number;
|
|
800
846
|
max_value_date: string;
|
|
@@ -816,6 +862,10 @@ export interface InsightFilterCustomIndexesRequest {
|
|
|
816
862
|
paging: InsightPaging;
|
|
817
863
|
symbols?: string[];
|
|
818
864
|
}
|
|
865
|
+
export enum InsightFilterType {
|
|
866
|
+
FilterAnalysts = "analysts",
|
|
867
|
+
FilterBloggers = "bloggers"
|
|
868
|
+
}
|
|
819
869
|
export interface InsightFilteredCustomIndexResponse {
|
|
820
870
|
created_at?: string;
|
|
821
871
|
description?: string;
|
|
@@ -1179,6 +1229,8 @@ export interface InsightGetFundScreenerFiltersResponse {
|
|
|
1179
1229
|
sponsors?: InsightFundFilterSponsor[];
|
|
1180
1230
|
}
|
|
1181
1231
|
export interface InsightGetFundsForHoldingRequest {
|
|
1232
|
+
/** @example "ANY" */
|
|
1233
|
+
inverse: InsightGetFundsForHoldingRequestInverseEnum;
|
|
1182
1234
|
/** @example "LEVERAGE_I" */
|
|
1183
1235
|
leverage: InsightGetFundsForHoldingRequestLeverageEnum;
|
|
1184
1236
|
order?: InsightOrdering;
|
|
@@ -1219,6 +1271,8 @@ export interface InsightGetIndustriesPerformanceResponse {
|
|
|
1219
1271
|
worst_performing_quotes: InsightStockScreenerQuote[];
|
|
1220
1272
|
}
|
|
1221
1273
|
export interface InsightGetMarketDatesRequest {
|
|
1274
|
+
/** @example ["working_day","holiday"] */
|
|
1275
|
+
date_types?: string[];
|
|
1222
1276
|
/** @example "2023-12-31" */
|
|
1223
1277
|
end_date: string;
|
|
1224
1278
|
/** @example ["U","AU"] */
|
|
@@ -1229,15 +1283,26 @@ export interface InsightGetMarketDatesRequest {
|
|
|
1229
1283
|
}
|
|
1230
1284
|
export interface InsightGetMarketDatesResponse {
|
|
1231
1285
|
count: number;
|
|
1232
|
-
data:
|
|
1286
|
+
data: InsightMarketDate[];
|
|
1287
|
+
schedules: InsightGetMarketScheduleResponse[];
|
|
1233
1288
|
}
|
|
1234
1289
|
export interface InsightGetMarketHoursResponse {
|
|
1235
1290
|
close_time: string;
|
|
1236
|
-
|
|
1291
|
+
market: InsightMarket;
|
|
1292
|
+
next_market_day: InsightMarketDate;
|
|
1237
1293
|
open_right_now: boolean;
|
|
1238
1294
|
open_time: string;
|
|
1239
1295
|
open_today: boolean;
|
|
1240
|
-
|
|
1296
|
+
schedule: InsightWeeklyMarketSchedule;
|
|
1297
|
+
timezone: string;
|
|
1298
|
+
}
|
|
1299
|
+
export interface InsightGetMarketScheduleResponse {
|
|
1300
|
+
market: InsightMarket;
|
|
1301
|
+
schedule: InsightWeeklyMarketSchedule;
|
|
1302
|
+
}
|
|
1303
|
+
export interface InsightGetMarketsResponse {
|
|
1304
|
+
count: number;
|
|
1305
|
+
data: InsightMarketWithSchedule[];
|
|
1241
1306
|
}
|
|
1242
1307
|
export interface InsightGetOwnershipsByIDRequest {
|
|
1243
1308
|
/** @example "123e4567-e89b-12d3-a456-426614174000" */
|
|
@@ -2815,7 +2880,7 @@ export interface InsightIPOResponse {
|
|
|
2815
2880
|
sector: InsightClassificationResponse;
|
|
2816
2881
|
shares_outstanding: number;
|
|
2817
2882
|
shares_over_alloted: number;
|
|
2818
|
-
status:
|
|
2883
|
+
status: InsightIpoStatus;
|
|
2819
2884
|
sub_industry: InsightClassificationResponse;
|
|
2820
2885
|
symbol: string;
|
|
2821
2886
|
total_expenses: number;
|
|
@@ -2988,13 +3053,19 @@ export interface InsightInvestorsAlsoBought {
|
|
|
2988
3053
|
sentiment: string;
|
|
2989
3054
|
ticker: string;
|
|
2990
3055
|
}
|
|
3056
|
+
export enum InsightIpoStatus {
|
|
3057
|
+
PricedIpoStatus = "Priced",
|
|
3058
|
+
FiledIpoStatus = "Filed",
|
|
3059
|
+
WithdrawnIpoStatus = "Withdrawn",
|
|
3060
|
+
PostponedIpoStatus = "Postponed"
|
|
3061
|
+
}
|
|
2991
3062
|
export interface InsightLatestAnalystRatingsOnStockRequest {
|
|
2992
3063
|
/** Get analyst ratings from the past X months (OPTIONAL) */
|
|
2993
3064
|
months?: number;
|
|
2994
|
-
/** The number of analysts to return (OPTIONAL) */
|
|
3065
|
+
/** The number of analysts to return (OPTIONAL) Default is 3 */
|
|
2995
3066
|
num?: number;
|
|
2996
3067
|
/** Sort order of the analyst ratings Enums(date, rank) (OPTIONAL) */
|
|
2997
|
-
sort?:
|
|
3068
|
+
sort?: InsightLatestAnalystRatingsOnStockSort;
|
|
2998
3069
|
/** Comma-separated tickers */
|
|
2999
3070
|
tickers?: string[];
|
|
3000
3071
|
}
|
|
@@ -3031,6 +3102,10 @@ export interface InsightLatestAnalystRatingsOnStockResponse {
|
|
|
3031
3102
|
total_recommendations: number;
|
|
3032
3103
|
url: string;
|
|
3033
3104
|
}
|
|
3105
|
+
export enum InsightLatestAnalystRatingsOnStockSort {
|
|
3106
|
+
LatestAnalystRatingsOnStockSortDate = "date",
|
|
3107
|
+
LatestAnalystRatingsOnStockSortRank = "rank"
|
|
3108
|
+
}
|
|
3034
3109
|
export interface InsightLessAndMore {
|
|
3035
3110
|
less_than?: number;
|
|
3036
3111
|
more_than?: number;
|
|
@@ -3086,10 +3161,61 @@ export interface InsightLiveFeedResponse {
|
|
|
3086
3161
|
unique_operation_id: string;
|
|
3087
3162
|
url: string;
|
|
3088
3163
|
}
|
|
3164
|
+
export interface InsightMarket {
|
|
3165
|
+
/** @example "USA" */
|
|
3166
|
+
country_code: string;
|
|
3167
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
3168
|
+
created_at: string;
|
|
3169
|
+
/** @example "USD" */
|
|
3170
|
+
currency_code: string;
|
|
3171
|
+
/** @example "U" */
|
|
3172
|
+
market_code: string;
|
|
3173
|
+
/** @example "United States" */
|
|
3174
|
+
market_name: string;
|
|
3175
|
+
/** @example true */
|
|
3176
|
+
primary_market: boolean;
|
|
3177
|
+
/** @example "America/New_York" */
|
|
3178
|
+
timezone: string;
|
|
3179
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
3180
|
+
updated_at: string;
|
|
3181
|
+
}
|
|
3089
3182
|
export interface InsightMarketCapBreakdown {
|
|
3090
3183
|
breakdown: string;
|
|
3091
3184
|
percentage: number;
|
|
3092
3185
|
}
|
|
3186
|
+
export interface InsightMarketDate {
|
|
3187
|
+
close_time: string;
|
|
3188
|
+
holiday: boolean;
|
|
3189
|
+
market_code: string;
|
|
3190
|
+
name: string;
|
|
3191
|
+
open_date: string;
|
|
3192
|
+
open_time: string;
|
|
3193
|
+
timezone: string;
|
|
3194
|
+
}
|
|
3195
|
+
export interface InsightMarketDates {
|
|
3196
|
+
/** @example "16:00" */
|
|
3197
|
+
close_time: string;
|
|
3198
|
+
/** @example false */
|
|
3199
|
+
holiday: boolean;
|
|
3200
|
+
/** @example "U" */
|
|
3201
|
+
market_code: string;
|
|
3202
|
+
/** @example "name" */
|
|
3203
|
+
name: string;
|
|
3204
|
+
/** @example "2023-01-01" */
|
|
3205
|
+
open_date: string;
|
|
3206
|
+
/** @example "09:30" */
|
|
3207
|
+
open_time: string;
|
|
3208
|
+
}
|
|
3209
|
+
export interface InsightMarketScheduleEntry {
|
|
3210
|
+
/** @example "16:00" */
|
|
3211
|
+
close_time: string;
|
|
3212
|
+
/** @example "09:30" */
|
|
3213
|
+
open_time: string;
|
|
3214
|
+
}
|
|
3215
|
+
export interface InsightMarketWithSchedule {
|
|
3216
|
+
market: InsightMarket;
|
|
3217
|
+
schedule: InsightWeeklyMarketSchedule;
|
|
3218
|
+
}
|
|
3093
3219
|
export interface InsightMatrixData {
|
|
3094
3220
|
date: InsightDate;
|
|
3095
3221
|
option_data: InsightOptionData[];
|
|
@@ -3124,9 +3250,19 @@ export interface InsightMostPopularTagsRequest {
|
|
|
3124
3250
|
/** @example "eng" */
|
|
3125
3251
|
language: string;
|
|
3126
3252
|
/** @example "week" */
|
|
3127
|
-
time:
|
|
3253
|
+
time: InsightMostPopularTagsTimeType;
|
|
3128
3254
|
/** @example "symbol" */
|
|
3129
|
-
type:
|
|
3255
|
+
type: InsightMostPopularTagsTypesType;
|
|
3256
|
+
}
|
|
3257
|
+
export enum InsightMostPopularTagsTimeType {
|
|
3258
|
+
MostPopularTagsTimeTypeWeek = "week",
|
|
3259
|
+
MostPopularTagsTimeTypeMonth = "month",
|
|
3260
|
+
MostPopularTagsTimeTypeYear = "year"
|
|
3261
|
+
}
|
|
3262
|
+
export enum InsightMostPopularTagsTypesType {
|
|
3263
|
+
MostPopularTagsTypesTypeSymbol = "symbol",
|
|
3264
|
+
MostPopularTagsTypesTypePrimary = "primary",
|
|
3265
|
+
MostPopularTagsTypesTypeTags = "tags"
|
|
3130
3266
|
}
|
|
3131
3267
|
export interface InsightMover {
|
|
3132
3268
|
company_name: string;
|
|
@@ -3283,12 +3419,13 @@ export interface InsightNewsfeedRequest {
|
|
|
3283
3419
|
/** @example "technology" */
|
|
3284
3420
|
tag?: string;
|
|
3285
3421
|
/** @example "education" */
|
|
3286
|
-
type?:
|
|
3422
|
+
type?: InsightArticlesRequestType;
|
|
3287
3423
|
/** @example "group1" */
|
|
3288
3424
|
with_tag_group?: string;
|
|
3289
3425
|
}
|
|
3290
3426
|
export interface InsightOptionData {
|
|
3291
3427
|
expiry_date: InsightDate;
|
|
3428
|
+
formatted_expiry_date: string;
|
|
3292
3429
|
greeks: InsightOptionGreeks;
|
|
3293
3430
|
implied_volatility: number;
|
|
3294
3431
|
strike_price: number;
|
|
@@ -3308,6 +3445,10 @@ export interface InsightOptionValues {
|
|
|
3308
3445
|
option_value: number;
|
|
3309
3446
|
time_value: number;
|
|
3310
3447
|
}
|
|
3448
|
+
export enum InsightOrderDirection {
|
|
3449
|
+
OrderASC = "asc",
|
|
3450
|
+
OrderDESC = "desc"
|
|
3451
|
+
}
|
|
3311
3452
|
export interface InsightOrdering {
|
|
3312
3453
|
/**
|
|
3313
3454
|
* @default "asc"
|
|
@@ -3383,6 +3524,12 @@ export interface InsightPeriodFilter {
|
|
|
3383
3524
|
*/
|
|
3384
3525
|
value: number;
|
|
3385
3526
|
}
|
|
3527
|
+
export enum InsightPeriodType {
|
|
3528
|
+
PeriodDay = "day",
|
|
3529
|
+
PeriodWeek = "week",
|
|
3530
|
+
PeriodMonth = "month",
|
|
3531
|
+
PeriodYear = "year"
|
|
3532
|
+
}
|
|
3386
3533
|
export interface InsightPortfoliosRequest {
|
|
3387
3534
|
/** (REQUIRED) */
|
|
3388
3535
|
expert_uid?: string;
|
|
@@ -3414,6 +3561,7 @@ export interface InsightPreIPOCompany {
|
|
|
3414
3561
|
facebook: string;
|
|
3415
3562
|
founder: string;
|
|
3416
3563
|
id: string;
|
|
3564
|
+
is_active: boolean;
|
|
3417
3565
|
last_funding_date: string;
|
|
3418
3566
|
last_funding_series: string;
|
|
3419
3567
|
last_funding_total: number;
|
|
@@ -3421,6 +3569,7 @@ export interface InsightPreIPOCompany {
|
|
|
3421
3569
|
last_share_price: number;
|
|
3422
3570
|
last_valuation: number;
|
|
3423
3571
|
linkedin: string;
|
|
3572
|
+
listing_type: string;
|
|
3424
3573
|
logo_url: string;
|
|
3425
3574
|
name: string;
|
|
3426
3575
|
notable_investors_logos: string[];
|
|
@@ -3673,6 +3822,12 @@ export interface InsightRegion {
|
|
|
3673
3822
|
export interface InsightRemoveCustomIndexRequest {
|
|
3674
3823
|
id?: string;
|
|
3675
3824
|
}
|
|
3825
|
+
export interface InsightRemoveMarketDateRequest {
|
|
3826
|
+
/** @example "U" */
|
|
3827
|
+
market_code: string;
|
|
3828
|
+
/** @example "2023-01-01" */
|
|
3829
|
+
open_date: string;
|
|
3830
|
+
}
|
|
3676
3831
|
export interface InsightRemoveRewrittenFieldValueRequest {
|
|
3677
3832
|
/** @example "Removed" */
|
|
3678
3833
|
comment?: string;
|
|
@@ -3712,7 +3867,7 @@ export interface InsightSearchArticleRequest {
|
|
|
3712
3867
|
/** @example "search term" */
|
|
3713
3868
|
s: string;
|
|
3714
3869
|
/** @example "all" */
|
|
3715
|
-
type:
|
|
3870
|
+
type: InsightArticleSearchType;
|
|
3716
3871
|
}
|
|
3717
3872
|
export interface InsightSeasonalityEntry {
|
|
3718
3873
|
april: InsightTickerSeasonality;
|
|
@@ -3895,7 +4050,7 @@ export interface InsightStockScreenerV1Request {
|
|
|
3895
4050
|
}
|
|
3896
4051
|
export interface InsightStocksConsensusOverTimeRequest {
|
|
3897
4052
|
/** "The intervals over which the consensus is given" */
|
|
3898
|
-
interval?:
|
|
4053
|
+
interval?: InsightConsensusInterval;
|
|
3899
4054
|
/** "The ticker of the stock" (REQUIRE) */
|
|
3900
4055
|
ticker?: string;
|
|
3901
4056
|
}
|
|
@@ -4114,7 +4269,7 @@ export interface InsightTransaction {
|
|
|
4114
4269
|
}
|
|
4115
4270
|
export interface InsightTrendingStocksRequest {
|
|
4116
4271
|
/** "Include ratings of analysts and/or bloggers" Enums(analysts, bloggers) */
|
|
4117
|
-
filter?:
|
|
4272
|
+
filter?: InsightFilterType;
|
|
4118
4273
|
/** "Return the most trending X stocks" */
|
|
4119
4274
|
num?: number;
|
|
4120
4275
|
/** "Trending over the last X days" Enums(3, 7, 30, 90) */
|
|
@@ -4122,7 +4277,7 @@ export interface InsightTrendingStocksRequest {
|
|
|
4122
4277
|
/** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
|
|
4123
4278
|
quote_access_type?: string;
|
|
4124
4279
|
/** "Trend Type" Enums(most-rated, best-rated, worst-rated) */
|
|
4125
|
-
trending_type?:
|
|
4280
|
+
trending_type?: InsightTrendingType;
|
|
4126
4281
|
}
|
|
4127
4282
|
export interface InsightTrendingStocksResponse {
|
|
4128
4283
|
average_price_target: number;
|
|
@@ -4138,6 +4293,11 @@ export interface InsightTrendingStocksResponse {
|
|
|
4138
4293
|
sentiment: number;
|
|
4139
4294
|
ticker: string;
|
|
4140
4295
|
}
|
|
4296
|
+
export enum InsightTrendingType {
|
|
4297
|
+
TrendingTypeMostRated = "most-rated",
|
|
4298
|
+
TrendingTypeBestRated = "best-rated",
|
|
4299
|
+
TrendingTypeWorstRated = "worst-rated"
|
|
4300
|
+
}
|
|
4141
4301
|
export interface InsightUnderwriteResponse {
|
|
4142
4302
|
company_name: string;
|
|
4143
4303
|
id: number;
|
|
@@ -4213,6 +4373,19 @@ export interface InsightValuation {
|
|
|
4213
4373
|
price_to_sales_ratio: number;
|
|
4214
4374
|
trailing_price_to_earnings_ratio: number;
|
|
4215
4375
|
}
|
|
4376
|
+
export interface InsightWeeklyMarketSchedule {
|
|
4377
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
4378
|
+
created_at: string;
|
|
4379
|
+
friday: InsightMarketScheduleEntry[];
|
|
4380
|
+
monday: InsightMarketScheduleEntry[];
|
|
4381
|
+
saturday: InsightMarketScheduleEntry[];
|
|
4382
|
+
sunday: InsightMarketScheduleEntry[];
|
|
4383
|
+
thursday: InsightMarketScheduleEntry[];
|
|
4384
|
+
tuesday: InsightMarketScheduleEntry[];
|
|
4385
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
4386
|
+
updated_at: string;
|
|
4387
|
+
wednesday: InsightMarketScheduleEntry[];
|
|
4388
|
+
}
|
|
4216
4389
|
export interface InsightYearlyData {
|
|
4217
4390
|
benchmark_average: number;
|
|
4218
4391
|
date: number;
|
|
@@ -4345,6 +4518,12 @@ export enum InsightFundSectorScreenerRequestLeverageEnum {
|
|
|
4345
4518
|
LEVERAGE_III = "LEVERAGE_III",
|
|
4346
4519
|
LEVERAGE_II_AND_III = "LEVERAGE_II_AND_III"
|
|
4347
4520
|
}
|
|
4521
|
+
/** @example "ANY" */
|
|
4522
|
+
export enum InsightGetFundsForHoldingRequestInverseEnum {
|
|
4523
|
+
ANY = "ANY",
|
|
4524
|
+
SHORT = "SHORT",
|
|
4525
|
+
LONG = "LONG"
|
|
4526
|
+
}
|
|
4348
4527
|
/** @example "LEVERAGE_I" */
|
|
4349
4528
|
export enum InsightGetFundsForHoldingRequestLeverageEnum {
|
|
4350
4529
|
ANY = "ANY",
|
|
@@ -5480,10 +5659,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5480
5659
|
*/
|
|
5481
5660
|
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5482
5661
|
/**
|
|
5483
|
-
* @description get pre ipo company spvs
|
|
5662
|
+
* @description get pre ipo company spvs with investor id
|
|
5484
5663
|
* @tags PreIPOCompanies
|
|
5485
5664
|
* @name GetInvestor
|
|
5486
|
-
* @summary get pre ipo company spvs
|
|
5665
|
+
* @summary get pre ipo company spvs with investor id
|
|
5487
5666
|
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5488
5667
|
* @secure
|
|
5489
5668
|
*/
|
|
@@ -5508,10 +5687,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5508
5687
|
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5509
5688
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5510
5689
|
/**
|
|
5511
|
-
* @description get pre ipo company spv by id
|
|
5690
|
+
* @description get pre ipo company spv by id with investor id
|
|
5512
5691
|
* @tags PreIPOCompanies
|
|
5513
5692
|
* @name GetInvestorByIdAndInvestorId
|
|
5514
|
-
* @summary get pre ipo company spv by id
|
|
5693
|
+
* @summary get pre ipo company spv by id with investor id
|
|
5515
5694
|
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5516
5695
|
* @originalName getInvestor
|
|
5517
5696
|
* @duplicate
|
|
@@ -5605,31 +5784,6 @@ export class Ipos<HandleError extends boolean = boolean> {
|
|
|
5605
5784
|
statuses?: string[];
|
|
5606
5785
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5607
5786
|
}
|
|
5608
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5609
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5610
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5611
|
-
/**
|
|
5612
|
-
* @description get market dates history
|
|
5613
|
-
* @tags MarketDates
|
|
5614
|
-
* @name GetMarketDatesHistory
|
|
5615
|
-
* @summary get market dates history
|
|
5616
|
-
* @request POST:/market-dates/history
|
|
5617
|
-
* @secure
|
|
5618
|
-
*/
|
|
5619
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5620
|
-
/**
|
|
5621
|
-
* @description get todays market hours
|
|
5622
|
-
* @tags MarketDates
|
|
5623
|
-
* @name GetTodaysMarketHours
|
|
5624
|
-
* @summary get todays market hours
|
|
5625
|
-
* @request GET:/market-dates/today
|
|
5626
|
-
* @secure
|
|
5627
|
-
*/
|
|
5628
|
-
getTodaysMarketHours(query: {
|
|
5629
|
-
/** Market */
|
|
5630
|
-
market: string;
|
|
5631
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5632
|
-
}
|
|
5633
5787
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5634
5788
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5635
5789
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5876,85 +6030,167 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5876
6030
|
*/
|
|
5877
6031
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5878
6032
|
}
|
|
5879
|
-
export class
|
|
6033
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5880
6034
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5881
6035
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5882
6036
|
/**
|
|
5883
|
-
* @description Returns
|
|
5884
|
-
* @tags
|
|
5885
|
-
* @name
|
|
5886
|
-
* @summary
|
|
5887
|
-
* @request POST:/
|
|
6037
|
+
* @description Returns calculated matrix
|
|
6038
|
+
* @tags OptionGreeks
|
|
6039
|
+
* @name OgCalculateMatrix
|
|
6040
|
+
* @summary Calculate matrix
|
|
6041
|
+
* @request POST:/og/calculate-matrix
|
|
5888
6042
|
* @secure
|
|
5889
6043
|
*/
|
|
5890
|
-
|
|
6044
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5891
6045
|
/**
|
|
5892
|
-
* @description Returns
|
|
5893
|
-
* @tags
|
|
5894
|
-
* @name
|
|
5895
|
-
* @summary
|
|
5896
|
-
* @request POST:/
|
|
6046
|
+
* @description Returns calculated params
|
|
6047
|
+
* @tags OptionGreeks
|
|
6048
|
+
* @name OgCalculateParams
|
|
6049
|
+
* @summary Calculate params
|
|
6050
|
+
* @request POST:/og/calculate-params
|
|
5897
6051
|
* @secure
|
|
5898
6052
|
*/
|
|
5899
|
-
|
|
6053
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6054
|
+
}
|
|
6055
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
6056
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6057
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5900
6058
|
/**
|
|
5901
|
-
* @description
|
|
5902
|
-
* @tags
|
|
5903
|
-
* @name
|
|
5904
|
-
* @summary
|
|
5905
|
-
* @request POST:/
|
|
6059
|
+
* @description Create or update market date
|
|
6060
|
+
* @tags MarketDates
|
|
6061
|
+
* @name CreateOrUpdateMarketDate
|
|
6062
|
+
* @summary Create or update market date
|
|
6063
|
+
* @request POST:/market-dates
|
|
5906
6064
|
* @secure
|
|
5907
6065
|
*/
|
|
5908
|
-
|
|
6066
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5909
6067
|
/**
|
|
5910
|
-
* @description
|
|
5911
|
-
* @tags
|
|
5912
|
-
* @name
|
|
5913
|
-
* @summary
|
|
5914
|
-
* @request
|
|
6068
|
+
* @description Remove market date
|
|
6069
|
+
* @tags MarketDates
|
|
6070
|
+
* @name RemoveMarketDate
|
|
6071
|
+
* @summary Remove market date
|
|
6072
|
+
* @request DELETE:/market-dates
|
|
5915
6073
|
* @secure
|
|
5916
6074
|
*/
|
|
5917
|
-
|
|
6075
|
+
removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5918
6076
|
/**
|
|
5919
|
-
* @description
|
|
5920
|
-
* @tags
|
|
5921
|
-
* @name
|
|
5922
|
-
* @summary Get
|
|
5923
|
-
* @request POST:/
|
|
6077
|
+
* @description Get market dates history
|
|
6078
|
+
* @tags MarketDates
|
|
6079
|
+
* @name GetMarketDatesHistory
|
|
6080
|
+
* @summary Get market dates history
|
|
6081
|
+
* @request POST:/market-dates/history
|
|
5924
6082
|
* @secure
|
|
5925
6083
|
*/
|
|
5926
|
-
|
|
6084
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5927
6085
|
/**
|
|
5928
|
-
* @description
|
|
5929
|
-
* @tags
|
|
5930
|
-
* @name
|
|
5931
|
-
* @summary
|
|
5932
|
-
* @request
|
|
6086
|
+
* @description Get markets
|
|
6087
|
+
* @tags MarketDates
|
|
6088
|
+
* @name GetMarkets
|
|
6089
|
+
* @summary Get markets
|
|
6090
|
+
* @request GET:/market-dates/markets
|
|
5933
6091
|
* @secure
|
|
5934
6092
|
*/
|
|
5935
|
-
|
|
6093
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
6094
|
+
/**
|
|
6095
|
+
* @description Create or update market
|
|
6096
|
+
* @tags MarketDates
|
|
6097
|
+
* @name CreateOrUpdateMarket
|
|
6098
|
+
* @summary Create or update market
|
|
6099
|
+
* @request POST:/market-dates/markets
|
|
6100
|
+
* @secure
|
|
6101
|
+
*/
|
|
6102
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
6103
|
+
/**
|
|
6104
|
+
* @description Get market
|
|
6105
|
+
* @tags MarketDates
|
|
6106
|
+
* @name GetMarket
|
|
6107
|
+
* @summary Get market
|
|
6108
|
+
* @request GET:/market-dates/markets/{market}
|
|
6109
|
+
* @secure
|
|
6110
|
+
*/
|
|
6111
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
6112
|
+
/**
|
|
6113
|
+
* @description Remove market
|
|
6114
|
+
* @tags MarketDates
|
|
6115
|
+
* @name RemoveMarket
|
|
6116
|
+
* @summary Remove market
|
|
6117
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
6118
|
+
* @secure
|
|
6119
|
+
*/
|
|
6120
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6121
|
+
/**
|
|
6122
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
6123
|
+
* @tags MarketDates
|
|
6124
|
+
* @name CreateOrUpdateMarketSchedule
|
|
6125
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
6126
|
+
* @request POST:/market-dates/schedule
|
|
6127
|
+
* @secure
|
|
6128
|
+
*/
|
|
6129
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6130
|
+
/**
|
|
6131
|
+
* @description Get market schedule
|
|
6132
|
+
* @tags MarketDates
|
|
6133
|
+
* @name GetMarketSchedule
|
|
6134
|
+
* @summary Get market schedule
|
|
6135
|
+
* @request GET:/market-dates/schedule/{market}
|
|
6136
|
+
* @secure
|
|
6137
|
+
*/
|
|
6138
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6139
|
+
/**
|
|
6140
|
+
* @description Remove market schedule
|
|
6141
|
+
* @tags MarketDates
|
|
6142
|
+
* @name RemoveMarketSchedule
|
|
6143
|
+
* @summary Remove market schedule
|
|
6144
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
6145
|
+
* @secure
|
|
6146
|
+
*/
|
|
6147
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6148
|
+
/**
|
|
6149
|
+
* @description Get market schedules
|
|
6150
|
+
* @tags MarketDates
|
|
6151
|
+
* @name GetMarketSchedules
|
|
6152
|
+
* @summary Get market schedules
|
|
6153
|
+
* @request GET:/market-dates/schedules
|
|
6154
|
+
* @secure
|
|
6155
|
+
*/
|
|
6156
|
+
getMarketSchedules(query?: {
|
|
6157
|
+
/** Market codes, comma separated */
|
|
6158
|
+
market?: string;
|
|
6159
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
6160
|
+
/**
|
|
6161
|
+
* @description Get todays market hours
|
|
6162
|
+
* @tags MarketDates
|
|
6163
|
+
* @name GetTodaysMarketHours
|
|
6164
|
+
* @summary Get todays market hours
|
|
6165
|
+
* @request GET:/market-dates/today
|
|
6166
|
+
* @secure
|
|
6167
|
+
*/
|
|
6168
|
+
getTodaysMarketHours(query: {
|
|
6169
|
+
/** Market */
|
|
6170
|
+
market: string;
|
|
6171
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5936
6172
|
}
|
|
5937
|
-
export class
|
|
6173
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5938
6174
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5939
6175
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5940
6176
|
/**
|
|
5941
|
-
* @description get
|
|
5942
|
-
* @tags
|
|
5943
|
-
* @name
|
|
5944
|
-
* @summary get
|
|
5945
|
-
* @request POST:/
|
|
6177
|
+
* @description get ownerships by id datadata
|
|
6178
|
+
* @tags Ownerships
|
|
6179
|
+
* @name GetOwnershipsByIdData
|
|
6180
|
+
* @summary get ownerships by id data
|
|
6181
|
+
* @request POST:/ownerships
|
|
5946
6182
|
* @secure
|
|
5947
6183
|
*/
|
|
5948
|
-
|
|
6184
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5949
6185
|
/**
|
|
5950
|
-
* @description get
|
|
5951
|
-
* @tags
|
|
5952
|
-
* @name
|
|
5953
|
-
* @summary get
|
|
5954
|
-
* @request POST:/
|
|
6186
|
+
* @description get ownerships by symbol data
|
|
6187
|
+
* @tags Ownerships
|
|
6188
|
+
* @name GetOwnershipsBySymbolData
|
|
6189
|
+
* @summary get ownerships by symbol data
|
|
6190
|
+
* @request POST:/symbol-ownerships
|
|
5955
6191
|
* @secure
|
|
5956
6192
|
*/
|
|
5957
|
-
|
|
6193
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5958
6194
|
}
|
|
5959
6195
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5960
6196
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6335,27 +6571,27 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
6335
6571
|
*/
|
|
6336
6572
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6337
6573
|
}
|
|
6338
|
-
export class
|
|
6574
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6339
6575
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6340
6576
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6341
6577
|
/**
|
|
6342
|
-
* @description
|
|
6343
|
-
* @tags
|
|
6344
|
-
* @name
|
|
6345
|
-
* @summary
|
|
6346
|
-
* @request POST:/
|
|
6578
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6579
|
+
* @tags AlphaTools
|
|
6580
|
+
* @name GetMomentumRatioGraph
|
|
6581
|
+
* @summary get seasonlity data
|
|
6582
|
+
* @request POST:/rst
|
|
6347
6583
|
* @secure
|
|
6348
6584
|
*/
|
|
6349
|
-
|
|
6585
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6350
6586
|
/**
|
|
6351
|
-
* @description
|
|
6352
|
-
* @tags
|
|
6353
|
-
* @name
|
|
6354
|
-
* @summary
|
|
6355
|
-
* @request POST:/
|
|
6587
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6588
|
+
* @tags AlphaTools
|
|
6589
|
+
* @name GetSeasonality
|
|
6590
|
+
* @summary get seasonlity data
|
|
6591
|
+
* @request POST:/seasonality
|
|
6356
6592
|
* @secure
|
|
6357
6593
|
*/
|
|
6358
|
-
|
|
6594
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6359
6595
|
}
|
|
6360
6596
|
export class Public<HandleError extends boolean = boolean> {
|
|
6361
6597
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6371,7 +6607,10 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6371
6607
|
calculateEstimatedReturns(query: {
|
|
6372
6608
|
/** Single symbol */
|
|
6373
6609
|
symbol: string;
|
|
6374
|
-
/**
|
|
6610
|
+
/**
|
|
6611
|
+
* Non-zero amount
|
|
6612
|
+
* @format float64
|
|
6613
|
+
*/
|
|
6375
6614
|
amount: number;
|
|
6376
6615
|
/** Start date for calculations */
|
|
6377
6616
|
start_date: string;
|
|
@@ -6483,27 +6722,63 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6483
6722
|
offset: number;
|
|
6484
6723
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6485
6724
|
}
|
|
6486
|
-
export class
|
|
6725
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6487
6726
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6488
6727
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6489
6728
|
/**
|
|
6490
|
-
* @description
|
|
6491
|
-
* @tags
|
|
6492
|
-
* @name
|
|
6493
|
-
* @summary
|
|
6494
|
-
* @request POST:/
|
|
6729
|
+
* @description Returns article by id
|
|
6730
|
+
* @tags Passport
|
|
6731
|
+
* @name PassportArticleById
|
|
6732
|
+
* @summary Get article by id
|
|
6733
|
+
* @request POST:/passport/article-by-id
|
|
6495
6734
|
* @secure
|
|
6496
6735
|
*/
|
|
6497
|
-
|
|
6736
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6498
6737
|
/**
|
|
6499
|
-
* @description
|
|
6500
|
-
* @tags
|
|
6501
|
-
* @name
|
|
6502
|
-
* @summary
|
|
6503
|
-
* @request POST:/
|
|
6738
|
+
* @description Returns articles
|
|
6739
|
+
* @tags Passport
|
|
6740
|
+
* @name PassportArticles
|
|
6741
|
+
* @summary Get articles
|
|
6742
|
+
* @request POST:/passport/articles
|
|
6504
6743
|
* @secure
|
|
6505
6744
|
*/
|
|
6506
|
-
|
|
6745
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6746
|
+
/**
|
|
6747
|
+
* @description Returns author profile
|
|
6748
|
+
* @tags Passport
|
|
6749
|
+
* @name PassportAuthorProfile
|
|
6750
|
+
* @summary Get author profile
|
|
6751
|
+
* @request POST:/passport/author-profile
|
|
6752
|
+
* @secure
|
|
6753
|
+
*/
|
|
6754
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6755
|
+
/**
|
|
6756
|
+
* @description Returns most popular tags
|
|
6757
|
+
* @tags Passport
|
|
6758
|
+
* @name PassportMostPopularTags
|
|
6759
|
+
* @summary Get most popular tags
|
|
6760
|
+
* @request POST:/passport/most-popular-tags
|
|
6761
|
+
* @secure
|
|
6762
|
+
*/
|
|
6763
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6764
|
+
/**
|
|
6765
|
+
* @description Returns news feed
|
|
6766
|
+
* @tags Passport
|
|
6767
|
+
* @name PassportNewsFeed
|
|
6768
|
+
* @summary Get news feed
|
|
6769
|
+
* @request POST:/passport/newsfeed
|
|
6770
|
+
* @secure
|
|
6771
|
+
*/
|
|
6772
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6773
|
+
/**
|
|
6774
|
+
* @description Returns article by parameters
|
|
6775
|
+
* @tags Passport
|
|
6776
|
+
* @name PassportSearchArticle
|
|
6777
|
+
* @summary Search article by parameters
|
|
6778
|
+
* @request POST:/passport/search-article
|
|
6779
|
+
* @secure
|
|
6780
|
+
*/
|
|
6781
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6507
6782
|
}
|
|
6508
6783
|
export interface InsightBeforeAndAfterV2 {
|
|
6509
6784
|
after?: string;
|
|
@@ -6652,6 +6927,10 @@ export interface InsightLessAndMoreV2 {
|
|
|
6652
6927
|
less_than?: number;
|
|
6653
6928
|
more_than?: number;
|
|
6654
6929
|
}
|
|
6930
|
+
export enum InsightOrderDirectionV2 {
|
|
6931
|
+
OrderASC = "asc",
|
|
6932
|
+
OrderDESC = "desc"
|
|
6933
|
+
}
|
|
6655
6934
|
export interface InsightOrderingV2 {
|
|
6656
6935
|
/**
|
|
6657
6936
|
* @default "asc"
|